@goperigon/perigon-ts 1.0.4 → 1.0.5

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/index.d.ts CHANGED
@@ -2007,7 +2007,7 @@ declare function ArticleToJSONTyped(value?: Article | null, ignoreDiscriminator?
2007
2007
  * Do not edit the class manually.
2008
2008
  */
2009
2009
  /**
2010
- * Filter using sources that are located on specific coordinates using Lat, lon and radius.
2010
+ * Filter articles from publishers based at specific geographic locations. Uses latitude, longitude, and radius parameters to define a circular search area for publisher locations.
2011
2011
  * @export
2012
2012
  * @interface CoordinateFilter
2013
2013
  */
@@ -2053,169 +2053,169 @@ declare function CoordinateFilterToJSONTyped(value?: CoordinateFilter | null, ig
2053
2053
  */
2054
2054
 
2055
2055
  /**
2056
- * A versatile filter object to refine search results based on articles, clusters, sources, languages, categories, locations, companies, and people. Supports logical operators (AND, OR, NOT) for complex queries. Accepts single values or arrays, with arrays applied as OR operations.
2056
+ * Complex filter structure for article searches that supports nested logical operations (AND, OR, NOT) and multiple filtering criteria.
2057
2057
  * @export
2058
2058
  * @interface ArticleSearchFilter
2059
2059
  */
2060
2060
  interface ArticleSearchFilter {
2061
2061
  /**
2062
- * Filter by specific article(s). Array of article IDs. For convenience, a single string ID is also accepted.
2062
+ * Filter by specific article identifiers. Accepts either a single ID or an array of IDs. Returns only articles matching these IDs.
2063
2063
  * @type {Array<string>}
2064
2064
  * @memberof ArticleSearchFilter
2065
2065
  */
2066
2066
  articleId?: Array<string> | null;
2067
2067
  /**
2068
- * Filter by specific cluster(s). Accepts either a single string or an array of strings.
2068
+ * Filter by specific story identifiers. Accepts either a single ID or an array of IDs. Returns only articles belonging to these stories.
2069
2069
  * @type {Array<string>}
2070
2070
  * @memberof ArticleSearchFilter
2071
2071
  */
2072
2072
  clusterId?: Array<string> | null;
2073
2073
  /**
2074
- * Filter by specific source(s). Accepts either a single string or an array of strings.
2074
+ * Filter articles by specific publisher domains or subdomains. Accepts either a single domain or an array of domains. Multiple values create an OR filter.
2075
2075
  * @type {Array<string>}
2076
2076
  * @memberof ArticleSearchFilter
2077
2077
  */
2078
2078
  source?: Array<string> | null;
2079
2079
  /**
2080
- * The domain of the website, which should be excluded from the search. Multiple parameters could be provided. Wildcards (* and ?) are suported (e.g. *.cnn.com).
2080
+ * Exclude articles from specific publisher domains or subdomains. Accepts either a single domain or an array of domains. Multiple values create an AND-exclude filter.
2081
2081
  * @type {Array<string>}
2082
2082
  * @memberof ArticleSearchFilter
2083
2083
  */
2084
2084
  excludeSource?: Array<string> | null;
2085
2085
  /**
2086
- * Filter by specific source group, for example: 'top100'. Accepts either a single string or an array of strings.
2086
+ * Filter articles using Perigon's curated publisher bundles (e.g., top100, top25tech). Accepts either a single source group or an array. Multiple values create an OR filter to include articles from any of the specified bundles.
2087
2087
  * @type {Array<string>}
2088
2088
  * @memberof ArticleSearchFilter
2089
2089
  */
2090
2090
  sourceGroup?: Array<string> | null;
2091
2091
  /**
2092
- * Language code to filter by language. If an array parameters are passed, they will be applied as OR operations. For example: ['en', 'es']. Language ISO codes must be provided.
2092
+ * Filter articles by their language using ISO-639 two-letter codes in lowercase (e.g., en, es, fr). Accepts either a single language code or an array. Multiple values create an OR filter.
2093
2093
  * @type {Array<string>}
2094
2094
  * @memberof ArticleSearchFilter
2095
2095
  */
2096
2096
  language?: Array<string> | null;
2097
2097
  /**
2098
- * A list of languages to be excluded. Any article published in one of the languages provided in this filter will not be returned. This is useful when you are interested only in news published in specific languages.
2098
+ * Exclude articles in specific languages using ISO-639 two-letter codes in lowercase. Accepts either a single language code or an array. Multiple values create an AND-exclude filter.
2099
2099
  * @type {Array<string>}
2100
2100
  * @memberof ArticleSearchFilter
2101
2101
  */
2102
2102
  excludeLanguage?: Array<string> | null;
2103
2103
  /**
2104
- * Labels to filter by, could be 'Opinion', 'Paid-news', 'Non-news', etc. If multiple parameters are passed, they will be applied as OR operations.
2104
+ * Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. View our docs for an exhaustive list of labels. Accepts either a single label or an array. Multiple values create an OR filter.
2105
2105
  * @type {Array<string>}
2106
2106
  * @memberof ArticleSearchFilter
2107
2107
  */
2108
2108
  label?: Array<string> | null;
2109
2109
  /**
2110
- * Exclude results that include specific labels (Opinion, Non-news, Paid News, etc.). You can filter multiple by repeating the parameter.
2110
+ * Exclude articles with specific editorial labels. Accepts either a single label or an array. Multiple values create an AND-exclude filter, removing all content with any of these labels.
2111
2111
  * @type {Array<string>}
2112
2112
  * @memberof ArticleSearchFilter
2113
2113
  */
2114
2114
  excludeLabel?: Array<string> | null;
2115
2115
  /**
2116
- * Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy=/Finance/Banking/Other, /Finance/Investing/Funds
2116
+ * Filter by Google Content Categories. Must pass the full hierarchical path of the category. Accepts either a single path or an array. Example: taxonomy=/Finance/Banking/Other,/Finance/Investing/Funds. Multiple values create an OR filter.
2117
2117
  * @type {Array<string>}
2118
2118
  * @memberof ArticleSearchFilter
2119
2119
  */
2120
2120
  taxonomy?: Array<string> | null;
2121
2121
  /**
2122
- * Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use 'none' to search uncategorized articles.
2122
+ * Filter by broad content categories such as Politics, Tech, Sports, Business, or Finance. Accepts either a single category or an array. Use none to find uncategorized articles. Multiple values create an OR filter.
2123
2123
  * @type {Array<string>}
2124
2124
  * @memberof ArticleSearchFilter
2125
2125
  */
2126
2126
  category?: Array<string> | null;
2127
2127
  /**
2128
- * Filter by topics. Each topic is some kind of entity that the article is about. Examples of topics: Markets, Joe Biden, Green Energy, Climate Change, Cryptocurrency, etc. If multiple parameters are passed, they will be applied as OR operations.
2128
+ * Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Accepts either a single topic or an array. Topics are more granular than categories, and articles can have multiple topics. Multiple values create an OR filter.
2129
2129
  * @type {Array<string>}
2130
2130
  * @memberof ArticleSearchFilter
2131
2131
  */
2132
2132
  topic?: Array<string> | null;
2133
2133
  /**
2134
- * Filter by excluding topics. Each topic is some kind of entity that the article is about. Examples of topics: Markets, Joe Biden, Green Energy, Climate Change, Cryptocurrency, etc. If multiple parameters are passed, they will be applied as OR operations.
2134
+ * Exclude articles with specific topics. Accepts either a single topic or an array. Multiple values create an AND-exclude filter, removing all content with any of these topics.
2135
2135
  * @type {Array<string>}
2136
2136
  * @memberof ArticleSearchFilter
2137
2137
  */
2138
2138
  excludeTopic?: Array<string> | null;
2139
2139
  /**
2140
- * Country code to filter by country. If multiple parameters are passed, they will be applied as OR operations. Only accepts country ISO codes.
2140
+ * Filter articles by countries they mention using two-letter country codes in lowercase (e.g., us, gb, jp). Accepts either a single country code or an array. Multiple values create an OR filter. See documentation for supported country codes.
2141
2141
  * @type {Array<string>}
2142
2142
  * @memberof ArticleSearchFilter
2143
2143
  */
2144
2144
  country?: Array<string> | null;
2145
2145
  /**
2146
- * Excludes articles from specific countries in the vector search results. Accepts a list of country codes (e.g., 'US', 'UK', 'CA'). Use this parameter to filter out articles published in countries you don't want to include in your search results. See the Country and Language Support section in the documentation for a full list of supported country codes.
2146
+ * Exclude articles from specific countries using two-letter country codes in lowercase. Accepts either a single country code or an array. Multiple values create an AND-exclude filter. See documentation for supported country codes.
2147
2147
  * @type {Array<string>}
2148
2148
  * @memberof ArticleSearchFilter
2149
2149
  */
2150
2150
  excludeCountry?: Array<string> | null;
2151
2151
  /**
2152
- * Filters articles where a specified country plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the country in question. If multiple parameters are passed, they will be applied as OR operations. Only accepts country ISO codes.
2152
+ * Filter articles where specified countries play a central role in the content, not just mentioned. Uses two-letter country codes in lowercase. Accepts either a single country code or an array. Multiple values create an OR filter. See documentation for supported country codes.
2153
2153
  * @type {Array<string>}
2154
2154
  * @memberof ArticleSearchFilter
2155
2155
  */
2156
2156
  locationsCountry?: Array<string> | null;
2157
2157
  /**
2158
- * Excludes articles where a specified country plays a central role in the content, ensuring results are not deeply relevant to the country in question. If multiple parameters are passed, they will be applied as AND operations, excluding articles relevant to any of the specified countries.
2158
+ * Exclude articles where specified countries play a central role in the content. Accepts either a single country code or an array. Multiple values create an AND-exclude filter, removing articles focused on any of these countries. See documentation for supported country codes.
2159
2159
  * @type {Array<string>}
2160
2160
  * @memberof ArticleSearchFilter
2161
2161
  */
2162
2162
  excludeLocationsCountry?: Array<string> | null;
2163
2163
  /**
2164
- * Filters articles where a specified state plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the state in question. If multiple parameters are passed, they will be applied as OR operations. Only accepts state ISO codes.
2164
+ * Filter articles where specified states play a central role in the content. Accepts either a single state code or an array. Multiple values create an OR filter. Uses two-letter state codes in lowercase. See documentation for supported state codes.
2165
2165
  * @type {Array<string>}
2166
2166
  * @memberof ArticleSearchFilter
2167
2167
  */
2168
2168
  state?: Array<string> | null;
2169
2169
  /**
2170
- * A list of states to exclude. Articles that include, or are associated with, any of the states provided here will be filtered out. This is especially useful if you want to ignore news tied to certain geographical areas (e.g., US states).
2170
+ * Exclude articles where specified states play a central role. Accepts either a single state code or an array. Multiple values create an AND-exclude filter, removing articles focused on any of these states. See documentation for supported state codes.
2171
2171
  * @type {Array<string>}
2172
2172
  * @memberof ArticleSearchFilter
2173
2173
  */
2174
2174
  excludeState?: Array<string> | null;
2175
2175
  /**
2176
- * Filters articles where a specified state plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the state in question. If multiple parameters are passed, they will be applied as OR operations.
2176
+ * Filter articles that mention or are related to specific counties. Accepts either a single county name or an array. Multiple values create an OR filter. County names typically include the word 'County' (e.g., Los Angeles County).
2177
2177
  * @type {Array<string>}
2178
2178
  * @memberof ArticleSearchFilter
2179
2179
  */
2180
2180
  county?: Array<string> | null;
2181
2181
  /**
2182
- * Excludes articles from specific counties or administrative divisions in the vector search results. Accepts either a single county name or a list of county names. County names should match the format used in article metadata (e.g., 'Los Angeles County', 'Cook County'). This parameter allows for more granular geographic filter
2182
+ * Exclude articles that mention or are related to specific counties. Accepts either a single county name or an array. Multiple values create an AND-exclude filter. County names should match the format in article metadata (e.g., Los Angeles County, Cook County).
2183
2183
  * @type {Array<string>}
2184
2184
  * @memberof ArticleSearchFilter
2185
2185
  */
2186
2186
  excludeCounty?: Array<string> | null;
2187
2187
  /**
2188
- * Filters articles where a specified city plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the urban area in question. If multiple parameters are passed, they will be applied as OR operations.
2188
+ * Filter articles that mention or are related to specific cities. Accepts either a single city name or an array. Multiple values create an OR filter.
2189
2189
  * @type {Array<string>}
2190
2190
  * @memberof ArticleSearchFilter
2191
2191
  */
2192
2192
  city?: Array<string> | null;
2193
2193
  /**
2194
- * A list of cities to exclude from the results. Articles that are associated with any of the specified cities will be filtered out.
2194
+ * Exclude articles that mention or are related to specific cities. Accepts either a single city name or an array. Multiple values create an AND-exclude filter.
2195
2195
  * @type {Array<string>}
2196
2196
  * @memberof ArticleSearchFilter
2197
2197
  */
2198
2198
  excludeCity?: Array<string> | null;
2199
2199
  /**
2200
- * Find articles published by sources that are located within a given country. Must be 2 character country code (i.e. us, gb, etc).
2200
+ * Filter for articles from publishers based in specific countries. Accepts either a single country code or an array. Uses two-letter country codes in lowercase (e.g., us, gb). See documentation for supported country codes.
2201
2201
  * @type {Array<string>}
2202
2202
  * @memberof ArticleSearchFilter
2203
2203
  */
2204
2204
  sourceCountry?: Array<string> | null;
2205
2205
  /**
2206
- * Find articles published by sources that are located within a given state.
2206
+ * Filter for articles from publishers based in specific states or regions. Accepts either a single state code or an array. Uses two-letter state codes in lowercase. See documentation for supported state codes.
2207
2207
  * @type {Array<string>}
2208
2208
  * @memberof ArticleSearchFilter
2209
2209
  */
2210
2210
  sourceState?: Array<string> | null;
2211
2211
  /**
2212
- * Find articles published by sources that are located within a given county.
2212
+ * Filter for articles from publishers based in specific counties. Accepts either a single county name or an array. Multiple values create an OR filter.
2213
2213
  * @type {Array<string>}
2214
2214
  * @memberof ArticleSearchFilter
2215
2215
  */
2216
2216
  sourceCounty?: Array<string> | null;
2217
2217
  /**
2218
- * Find articles published by sources that are located within a given city.
2218
+ * Filter for articles from publishers based in specific cities. Accepts either a single city name or an array. Multiple values create an OR filter.
2219
2219
  * @type {Array<string>}
2220
2220
  * @memberof ArticleSearchFilter
2221
2221
  */
@@ -2233,67 +2233,67 @@ interface ArticleSearchFilter {
2233
2233
  */
2234
2234
  sourceCoordinates?: CoordinateFilter;
2235
2235
  /**
2236
- * List of company IDs to filter by.
2236
+ * Filter articles by company identifiers. Accepts either a single ID or an array. Multiple values create an OR filter. For a complete list of tracked companies and their IDs, refer to the /companies endpoint.
2237
2237
  * @type {Array<string>}
2238
2238
  * @memberof ArticleSearchFilter
2239
2239
  */
2240
2240
  companyId?: Array<string> | null;
2241
2241
  /**
2242
- * A list of company identifiers. Articles associated with companies that have any of these unique IDs will be filtered out from the returned results, ensuring that certain companies or corporate entities are not included.
2242
+ * Exclude articles mentioning companies with specific identifiers. Accepts either a single ID or an array. Multiple values create an AND-exclude filter. For a complete list of tracked companies and their IDs, refer to the /companies endpoint.
2243
2243
  * @type {Array<string>}
2244
2244
  * @memberof ArticleSearchFilter
2245
2245
  */
2246
2246
  excludeCompanyId?: Array<string> | null;
2247
2247
  /**
2248
- * Search by company domains for filtering. E.g. companyDomain=apple.com.
2248
+ * Filter articles by company domains (e.g., apple.com). Accepts either a single domain or an array. Multiple values create an OR filter. For a complete list of tracked companies and their domains, refer to the /companies endpoint.
2249
2249
  * @type {Array<string>}
2250
2250
  * @memberof ArticleSearchFilter
2251
2251
  */
2252
2252
  companyDomain?: Array<string> | null;
2253
2253
  /**
2254
- * A list of company domains to exclude. If an article is related to a company that uses one of the specified domains (for instance, "example.com"), it will not be returned in the results.
2254
+ * Exclude articles related to companies with specific domains. Accepts either a single domain or an array. Multiple values create an AND-exclude filter. For a complete list of tracked companies and their domains, refer to the /companies endpoint.
2255
2255
  * @type {Array<string>}
2256
2256
  * @memberof ArticleSearchFilter
2257
2257
  */
2258
2258
  excludeCompanyDomain?: Array<string> | null;
2259
2259
  /**
2260
- * Search by company symbols.
2260
+ * Filter articles by company stock symbols (e.g., AAPL, MSFT). Accepts either a single symbol or an array. Multiple values create an OR filter. For a complete list of tracked companies and their symbols, refer to the /companies endpoint.
2261
2261
  * @type {Array<string>}
2262
2262
  * @memberof ArticleSearchFilter
2263
2263
  */
2264
2264
  companySymbol?: Array<string> | null;
2265
2265
  /**
2266
- * A list of stock symbols (ticker symbols) that identify companies to be excluded. Articles related to companies using any of these symbols will be omitted, which is useful for targeting or avoiding specific public companies.
2266
+ * Exclude articles related to companies with specific stock symbols. Accepts either a single symbol or an array. Multiple values create an AND-exclude filter. For a complete list of tracked companies and their symbols, refer to the /companies endpoint.
2267
2267
  * @type {Array<string>}
2268
2268
  * @memberof ArticleSearchFilter
2269
2269
  */
2270
2270
  excludeCompanySymbol?: Array<string> | null;
2271
2271
  /**
2272
- * Search by company name.
2272
+ * Filter articles by company name mentions. Accepts either a single name or an array. Performs exact matching on company names. Multiple values create an OR filter. For a complete list of tracked companies and their names, refer to the /companies endpoint.
2273
2273
  * @type {Array<string>}
2274
2274
  * @memberof ArticleSearchFilter
2275
2275
  */
2276
2276
  companyName?: Array<string> | null;
2277
2277
  /**
2278
- * List of person Wikidata IDs for filtering.
2278
+ * Filter articles by Wikidata IDs of mentioned people. Accepts either a single ID or an array. Multiple values create an OR filter. For a complete list of tracked individuals and their Wikidata IDs, refer to the /people endpoint.
2279
2279
  * @type {Array<string>}
2280
2280
  * @memberof ArticleSearchFilter
2281
2281
  */
2282
2282
  personWikidataId?: Array<string> | null;
2283
2283
  /**
2284
- * A list of Wikidata identifiers for individuals. Articles mentioning persons with any of these Wikidata IDs will be filtered out. This is particularly helpful when using a unique identifier to prevent ambiguity in names.
2284
+ * Exclude articles mentioning people with specific Wikidata IDs. Accepts either a single ID or an array. Multiple values create an AND-exclude filter. For a complete list of tracked individuals and their Wikidata IDs, refer to the /people endpoint.
2285
2285
  * @type {Array<string>}
2286
2286
  * @memberof ArticleSearchFilter
2287
2287
  */
2288
2288
  excludePersonWikidataId?: Array<string> | null;
2289
2289
  /**
2290
- * List of person names for exact matches. Boolean and complex logic is not supported on this filter.
2290
+ * Filter articles by exact person name matches. Accepts either a single name or an array. Does not support Boolean operators or wildcards. Multiple values create an OR filter. For a complete list of tracked individuals and their names, refer to the /people endpoint.
2291
2291
  * @type {Array<string>}
2292
2292
  * @memberof ArticleSearchFilter
2293
2293
  */
2294
2294
  personName?: Array<string> | null;
2295
2295
  /**
2296
- * A list of person names that, when associated with the content, cause the article to be excluded. This filter removes articles related to any individuals whose names match those on the list.
2296
+ * Exclude articles mentioning specific people by name. Accepts either a single name or an array. Multiple values create an AND-exclude filter. For a complete list of tracked individuals and their names, refer to the /people endpoint.
2297
2297
  * @type {Array<string>}
2298
2298
  * @memberof ArticleSearchFilter
2299
2299
  */
@@ -2386,24 +2386,6 @@ interface ArticleSearchParams {
2386
2386
  * @memberof ArticleSearchParams
2387
2387
  */
2388
2388
  page?: number | null;
2389
- /**
2390
- *
2391
- * @type {Date}
2392
- * @memberof ArticleSearchParams
2393
- */
2394
- addDateFrom?: Date | null;
2395
- /**
2396
- *
2397
- * @type {Date}
2398
- * @memberof ArticleSearchParams
2399
- */
2400
- addDateTo?: Date | null;
2401
- /**
2402
- *
2403
- * @type {number}
2404
- * @memberof ArticleSearchParams
2405
- */
2406
- scoreThreshold?: number | null;
2407
2389
  }
2408
2390
  /**
2409
2391
  * Check if a given object implements the ArticleSearchParams interface.
@@ -4663,87 +4645,87 @@ interface GetJournalistByIdRequest {
4663
4645
  }
4664
4646
  interface SearchArticlesRequest {
4665
4647
  /**
4666
- * Search query, each article will be scored and ranked against it. Articles are searched on the title, description, and content fields.
4648
+ * Primary search query for filtering articles based on their title, description, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
4667
4649
  */
4668
4650
  q?: string;
4669
4651
  /**
4670
- * Search article headlines/title field. Semantic similar to q parameter.
4652
+ * Search specifically within article headlines/titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
4671
4653
  */
4672
4654
  title?: string;
4673
4655
  /**
4674
- * Search query on the description field. Semantic similar to q parameter.
4656
+ * Search within article description fields. Supports Boolean expressions, exact phrase matching with quotes, and wildcards for flexible pattern matching.
4675
4657
  */
4676
4658
  desc?: string;
4677
4659
  /**
4678
- * Search query on the article\&#39;s body of content field. Semantic similar to q parameter.
4660
+ * Search within the full article body content. Supports Boolean logic, exact phrase matching with quotes, and wildcards for comprehensive content searching.
4679
4661
  */
4680
4662
  content?: string;
4681
4663
  /**
4682
- * Search query on the url field. Semantic similar to q parameter. E.g. could be used for querying certain website sections, e.g. source&#x3D;cnn.com&amp;url&#x3D;travel.
4664
+ * Search within article URLs to find content from specific website sections or domains. Supports wildcards (* and ?) for partial URL matching.
4683
4665
  */
4684
4666
  url?: string;
4685
4667
  /**
4686
- * Article ID will search for a news article by the ID of the article. If several parameters are passed, all matched articles will be returned.
4668
+ * Retrieve specific news articles by their unique article identifiers. Multiple IDs can be provided to return a collection of specific articles.
4687
4669
  */
4688
4670
  articleId?: Array<string>;
4689
4671
  /**
4690
- * Search for related content using a cluster ID. Passing a cluster ID will filter results to only the content found within the cluster.
4672
+ * Filter results to only show content within a specific related content cluster. Returns articles grouped together as part of Perigon Stories based on topic relevance.
4691
4673
  */
4692
4674
  clusterId?: Array<string>;
4693
4675
  /**
4694
- * \&#39;relevance\&#39; to sort by relevance to the query, \&#39;date\&#39; to sort by the publication date (desc), \&#39;pubDate\&#39; is a synonym to \&#39;date\&#39;, \&#39;addDate\&#39; to sort by \&#39;addDate\&#39; field (desc), \&#39;refreshDate\&#39; to sort by \&#39;refreshDate\&#39; field (desc). Defaults to \&#39;relevance\&#39;
4676
+ * Determines the article sorting order. Options include relevance (default), date/pubDate (newest publication date first), reverseDate (oldest publication date first), addDate (newest ingestion date first), reverseAddDate (oldest ingestion date first), and refreshDate (most recently updated in system first, often identical to addDate).
4695
4677
  */
4696
4678
  sortBy?: AllEndpointSortBy;
4697
4679
  /**
4698
- * The page number to retrieve.
4680
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
4699
4681
  */
4700
4682
  page?: number;
4701
4683
  /**
4702
- * The number of items per page.
4684
+ * The number of articles to return per page in the paginated response.
4703
4685
  */
4704
4686
  size?: number;
4705
4687
  /**
4706
- * \&#39;from\&#39; filter, will search articles published after the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2023-03-01T00:00:00
4688
+ * Filter for articles published after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
4707
4689
  */
4708
4690
  from?: Date;
4709
4691
  /**
4710
- * \&#39;to\&#39; filter, will search articles published before the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T23:59:59
4692
+ * Filter for articles published before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
4711
4693
  */
4712
4694
  to?: Date;
4713
4695
  /**
4714
- * \&#39;addDateFrom\&#39; filter, will search articles added after the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T00:00:00
4696
+ * Filter for articles added to Perigon\&#39;s system after this date. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
4715
4697
  */
4716
4698
  addDateFrom?: Date;
4717
4699
  /**
4718
- * \&#39;addDateTo\&#39; filter, will search articles added before the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T23:59:59
4700
+ * Filter for articles added to Perigon\&#39;s system before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
4719
4701
  */
4720
4702
  addDateTo?: Date;
4721
4703
  /**
4722
- * Will search articles that were refreshed after the specified date. The date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T00:00:00
4704
+ * Filter for articles refreshed/updated in Perigon\&#39;s system after this date. In most cases yields similar results to addDateFrom but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
4723
4705
  */
4724
4706
  refreshDateFrom?: Date;
4725
4707
  /**
4726
- * Will search articles that were refreshed before the specified date. The date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T23:59:59
4708
+ * Filter for articles refreshed/updated in Perigon\&#39;s system before this date. In most cases yields similar results to addDateTo but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
4727
4709
  */
4728
4710
  refreshDateTo?: Date;
4729
4711
  /**
4730
- * Medium will filter out news articles medium, which could be \&#39;Video\&#39; or \&#39;Article\&#39;. If several parameters are passed, all matched articles will be returned.
4712
+ * Filter articles by their primary medium type. Accepts Article for written content or Video for video-based stories. Multiple values create an OR filter.
4731
4713
  */
4732
4714
  medium?: Array<string>;
4733
4715
  /**
4734
- * Publisher\&#39;s domain can include a subdomain. If multiple parameters are passed, they will be applied as OR operations. Wildcards (* and ?) are suported (e.g. *.cnn.com).
4716
+ * Filter articles by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter.
4735
4717
  */
4736
4718
  source?: Array<string>;
4737
4719
  /**
4738
- * One of the supported source groups. Find Source Groups in the guided part of our documentation...
4720
+ * Filter articles using Perigon\&#39;s curated publisher bundles (e.g., top100, top25crypto). Multiple values create an OR filter to include articles from any of the specified bundles.
4739
4721
  */
4740
4722
  sourceGroup?: Array<string>;
4741
4723
  /**
4742
- * A list of built-in source group names to exclude from the results. The Perigon API categorizes sources into groups (for example, “top10” or “top100”) based on type or popularity. Using this filter allows you to remove articles coming from any source that belongs to one or more of the specified groups.
4724
+ * Exclude articles from specified Perigon source groups. Multiple values create an AND-exclude filter, removing content from publishers in any of the specified bundles (e.g., top10, top100).
4743
4725
  */
4744
4726
  excludeSourceGroup?: Array<string>;
4745
4727
  /**
4746
- * The domain of the website, which should be excluded from the search. Multiple parameters could be provided. Wildcards (* and ?) are suported (e.g. *.cnn.com).
4728
+ * Exclude articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an AND-exclude filter.
4747
4729
  */
4748
4730
  excludeSource?: Array<string>;
4749
4731
  /**
@@ -4751,71 +4733,71 @@ interface SearchArticlesRequest {
4751
4733
  */
4752
4734
  paywall?: boolean;
4753
4735
  /**
4754
- * Author names to filter by. Article author bylines are used as a source field. If multiple parameters are passed, they will be applied as OR operations.
4736
+ * Filter articles by author bylines. Works as an exact match for each author name provided. Multiple values create an OR filter to find articles by any of the specified authors.
4755
4737
  */
4756
4738
  byline?: Array<string>;
4757
4739
  /**
4758
- * A list of author names to include. Only articles written by any of the specified authors are returned. This is ideal when you wish to focus on content from particular voices or experts.
4740
+ * Filter articles by specific author names. Works as an exact match for each name. Multiple values create an OR filter to find articles by any of the specified authors.
4759
4741
  */
4760
4742
  author?: Array<string>;
4761
4743
  /**
4762
- * A list of author names to exclude from the search results. Any article written by an author whose name matches one in this list will be omitted, which helps to avoid content from certain individuals.
4744
+ * Exclude articles written by specific authors. Any article with an author name matching an entry in this list will be omitted from results. Multiple values create an AND-exclude filter.
4763
4745
  */
4764
4746
  excludeAuthor?: Array<string>;
4765
4747
  /**
4766
- * Filter by journalist ID. Journalist IDs are unique journalist identifiers which can be found through the Journalist API, or in the matchedAuthors field.
4748
+ * Filter by unique journalist identifiers which can be found through the Journalist API or in the matchedAuthors field. Multiple values create an OR filter.
4767
4749
  */
4768
4750
  journalistId?: Array<string>;
4769
4751
  /**
4770
- * A list of journalist (or reporter) identifiers to exclude. If an article is written by a journalist whose ID matches any in this list, it will not be part of the result set.
4752
+ * Exclude articles written by specific journalists identified by their unique IDs. Multiple values create an AND-exclude filter.
4771
4753
  */
4772
4754
  excludeJournalistId?: Array<string>;
4773
4755
  /**
4774
- * Language code to filter by language. If multiple parameters are passed, they will be applied as OR operations.
4756
+ * Filter articles by their language using ISO-639 two-letter codes (e.g., en, es, fr). Multiple values create an OR filter.
4775
4757
  */
4776
4758
  language?: Array<string>;
4777
4759
  /**
4778
- * A list of languages to be excluded. Any article published in one of the languages provided in this filter will not be returned. This is useful when you are interested only in news published in specific languages.
4760
+ * Exclude articles in specific languages using ISO-639 two-letter codes. Multiple values create an AND-exclude filter.
4779
4761
  */
4780
4762
  excludeLanguage?: Array<string>;
4781
4763
  /**
4782
- * Expand a query to search the translation, translatedTitle, and translatedDescription fields for non-English articles.
4764
+ * Expand search to include translated content fields for non-English articles. When true, searches translated title, description, and content fields.
4783
4765
  */
4784
4766
  searchTranslation?: boolean;
4785
4767
  /**
4786
- * Labels to filter by, could be \&#39;Opinion\&#39;, \&#39;Paid-news\&#39;, \&#39;Non-news\&#39;, etc. If multiple parameters are passed, they will be applied as OR operations.
4768
+ * Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. Multiple values create an OR filter.
4787
4769
  */
4788
4770
  label?: Array<string>;
4789
4771
  /**
4790
- * Exclude results that include specific labels (Opinion, Non-news, Paid News, etc.). You can filter multiple by repeating the parameter.
4772
+ * Exclude articles with specific editorial labels. Multiple values create an AND-exclude filter, removing all content with any of these labels.
4791
4773
  */
4792
4774
  excludeLabel?: Array<string>;
4793
4775
  /**
4794
- * Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use \&#39;none\&#39; to search uncategorized articles.
4776
+ * Filter by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use \&#39;none\&#39; to find uncategorized articles. Multiple values create an OR filter.
4795
4777
  */
4796
4778
  category?: Array<string>;
4797
4779
  /**
4798
- * A list of article categories to be omitted. If an article is tagged with any category present in this list (such as “Polotics”, “Tech”, “Sports”, etc.), it will not appear in the search results.
4780
+ * Exclude articles with specific categories. Multiple values create an AND-exclude filter, removing all content with any of these categories.
4799
4781
  */
4800
4782
  excludeCategory?: Array<string>;
4801
4783
  /**
4802
- * Filters results to include only articles with the specified topics. Topics are more specific classifications than categories, with an article potentially having multiple topics assigned. Perigon uses both human and machine curation to maintain an evolving list of available topics. Common examples include \&#39;Markets\&#39;, \&#39;Crime\&#39;, \&#39;Cryptocurrency\&#39;, \&#39;Social Issues\&#39;, \&#39;College Sports\&#39;, etc. See the Topics page in Docs for a complete list of available topics.
4784
+ * Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and articles can have multiple topics. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter.
4803
4785
  */
4804
4786
  topic?: Array<string>;
4805
4787
  /**
4806
- * Filter by excluding topics. Each topic is some kind of entity that the article is about. Examples of topics: Markets, Joe Biden, Green Energy, Climate Change, Cryptocurrency, etc. If multiple parameters are passed, they will be applied as OR operations.
4788
+ * Exclude articles with specific topics. Multiple values create an AND-exclude filter, removing all content with any of these topics.
4807
4789
  */
4808
4790
  excludeTopic?: Array<string>;
4809
4791
  /**
4810
- * Returns only articles that point to specified links (as determined by the \&#39;links\&#39; field in the article response).
4792
+ * Returns only articles that contain links to the specified URL pattern. Matches against the \&#39;links\&#39; field in article responses.
4811
4793
  */
4812
4794
  linkTo?: string;
4813
4795
  /**
4814
- * Whether to return reprints in the response or not. Reprints are usually wired articles from sources like AP or Reuters that are reprinted in multiple sources at the same time. By default, this parameter is \&#39;true\&#39;.
4796
+ * Controls whether to include reprinted content in results. When true (default), shows syndicated articles from wire services like AP or Reuters that appear on multiple sites.
4815
4797
  */
4816
4798
  showReprints?: boolean;
4817
4799
  /**
4818
- * Shows all articles belonging to the same reprint group. A reprint group includes one original article (the first one processed by the API) and all its known reprints.
4800
+ * Returns all articles in a specific reprint group, including the original article and all its known reprints. Use when you want to see all versions of the same content.
4819
4801
  */
4820
4802
  reprintGroupId?: string;
4821
4803
  /**
@@ -4903,43 +4885,43 @@ interface SearchArticlesRequest {
4903
4885
  */
4904
4886
  sourceMaxDistance?: number;
4905
4887
  /**
4906
- * List of person Wikidata IDs for filtering.
4888
+ * Filter articles by Wikidata IDs of mentioned people. Refer to the /people endpoint for a complete list of tracked individuals.
4907
4889
  */
4908
4890
  personWikidataId?: Array<string>;
4909
4891
  /**
4910
- * A list of Wikidata identifiers for individuals. Articles mentioning persons with any of these Wikidata IDs will be filtered out. This is particularly helpful when using a unique identifier to prevent ambiguity in names.
4892
+ * Exclude articles mentioning people with specific Wikidata IDs. Creates an AND-exclude filter to remove content about these individuals. Uses precise identifiers to avoid name ambiguity.
4911
4893
  */
4912
4894
  excludePersonWikidataId?: Array<string>;
4913
4895
  /**
4914
- * List of person names for exact matches. Boolean and complex logic is not supported on this paramter.
4896
+ * Filter articles by exact person name matches. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint.
4915
4897
  */
4916
4898
  personName?: Array<string>;
4917
4899
  /**
4918
- * A list of person names that, when associated with the content, cause the article to be excluded. This filter removes articles related to any individuals whose names match those on the list.
4900
+ * Exclude articles mentioning specific people by name. Creates an AND-exclude filter to remove content about these individuals.
4919
4901
  */
4920
4902
  excludePersonName?: Array<string>;
4921
4903
  /**
4922
- * List of company IDs to filter by.
4904
+ * Filter articles by company identifiers. For a complete list of tracked companies, refer to the /companies endpoint.
4923
4905
  */
4924
4906
  companyId?: Array<string>;
4925
4907
  /**
4926
- * A list of company identifiers. Articles associated with companies that have any of these unique IDs will be filtered out from the returned results, ensuring that certain companies or corporate entities are not included.
4908
+ * Exclude articles mentioning companies with specific identifiers. Creates an AND-exclude filter to remove content about these corporate entities.
4927
4909
  */
4928
4910
  excludeCompanyId?: Array<string>;
4929
4911
  /**
4930
- * Search by company name.
4912
+ * Filter articles by company name mentions. Performs an exact match on company names.
4931
4913
  */
4932
4914
  companyName?: string;
4933
4915
  /**
4934
- * Search by company domains for filtering. E.g. companyDomain&#x3D;apple.com.
4916
+ * Filter articles by company domains (e.g., apple.com). For available company entities, consult the /companies endpoint.
4935
4917
  */
4936
4918
  companyDomain?: Array<string>;
4937
4919
  /**
4938
- * A list of company domains to exclude. If an article is related to a company that uses one of the specified domains (for instance, “example.com”), it will not be returned in the results.
4920
+ * Exclude articles related to companies with specific domains. Creates an AND-exclude filter to remove content about these companies.
4939
4921
  */
4940
4922
  excludeCompanyDomain?: Array<string>;
4941
4923
  /**
4942
- * Search by company symbols.
4924
+ * Filter articles by company stock symbols. For available company entities and their symbols, consult the /companies endpoint.
4943
4925
  */
4944
4926
  companySymbol?: Array<string>;
4945
4927
  /**
@@ -4951,31 +4933,31 @@ interface SearchArticlesRequest {
4951
4933
  */
4952
4934
  showNumResults?: boolean;
4953
4935
  /**
4954
- * Filters results with a sentiment score greater than or equal to the specified value, indicating positive sentiment. See the Article Data section in Docs for an explanation of scores.
4936
+ * Filter articles with a positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
4955
4937
  */
4956
4938
  positiveSentimentFrom?: number;
4957
4939
  /**
4958
- * Filters results with a sentiment score less than or equal to the specified value, indicating positive sentiment. See the Article Data section in Docs for an explanation of scores.
4940
+ * Filter articles with a positive sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
4959
4941
  */
4960
4942
  positiveSentimentTo?: number;
4961
4943
  /**
4962
- * Filters results with a sentiment score greater than or equal to the specified value, indicating neutral sentiment. Explanation of sentimental values can be found in Docs under the Article Data section.
4944
+ * Filter articles with a neutral sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
4963
4945
  */
4964
4946
  neutralSentimentFrom?: number;
4965
4947
  /**
4966
- * Filters results with a sentiment score less than or equal to the specified value, indicating neutral sentiment. See the Article Data section in Docs for an explanation of scores.
4948
+ * Filter articles with a neutral sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
4967
4949
  */
4968
4950
  neutralSentimentTo?: number;
4969
4951
  /**
4970
- * Filters results with a sentiment score greater than or equal to the specified value, indicating negative sentiment. See the Article Data section in Docs for an explanation of scores.
4952
+ * Filter articles with a negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
4971
4953
  */
4972
4954
  negativeSentimentFrom?: number;
4973
4955
  /**
4974
- * Filters results with a sentiment score less than or equal to the specified value, indicating negative sentiment. See the Article Data section in Docs for an explanation of scores.
4956
+ * Filter articles with a negative sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
4975
4957
  */
4976
4958
  negativeSentimentTo?: number;
4977
4959
  /**
4978
- * Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy&#x3D;/Finance/Banking/Other, /Finance/Investing/Funds
4960
+ * Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy&#x3D;/Finance/Banking/Other, /Finance/Investing/Funds. [Full list](https://cloud.google.com/natural-language/docs/categories)
4979
4961
  */
4980
4962
  taxonomy?: Array<string>;
4981
4963
  /**
@@ -4985,279 +4967,283 @@ interface SearchArticlesRequest {
4985
4967
  }
4986
4968
  interface SearchCompaniesRequest {
4987
4969
  /**
4988
- * Search by company id.
4970
+ * Filter by unique company identifiers. Multiple values create an OR filter.
4989
4971
  */
4990
4972
  id?: Array<string>;
4991
4973
  /**
4992
- * Search by ticker symbol.
4974
+ * Filter by company stock ticker symbols (e.g., AAPL, MSFT, GOOGL). Multiple values create an OR filter.
4993
4975
  */
4994
4976
  symbol?: Array<string>;
4995
4977
  /**
4996
- * Search by company domain.
4978
+ * Filter by company domains or websites (e.g., apple.com, microsoft.com). Multiple values create an OR filter.
4997
4979
  */
4998
4980
  domain?: Array<string>;
4999
4981
  /**
5000
- * Search by company country.
4982
+ * Filter by company headquarters country. Multiple values create an OR filter.
5001
4983
  */
5002
4984
  country?: Array<string>;
5003
4985
  /**
5004
- * Search by exchange name.
4986
+ * Filter by stock exchange where companies are listed (e.g., NASDAQ, NYSE). Multiple values create an OR filter.
5005
4987
  */
5006
4988
  exchange?: Array<string>;
5007
4989
  /**
5008
- * Minimum number of employees.
4990
+ * Filter for companies with at least this many employees.
5009
4991
  */
5010
4992
  numEmployeesFrom?: number;
5011
4993
  /**
5012
- * Maximum number of employees.
4994
+ * Filter for companies with no more than this many employees.
5013
4995
  */
5014
4996
  numEmployeesTo?: number;
5015
4997
  /**
5016
- * Starting IPO date.
4998
+ * Filter for companies that went public on or after this date. Accepts ISO 8601 format (e.g., 2023-01-01T00:00:00) or yyyy-mm-dd format.
5017
4999
  */
5018
5000
  ipoFrom?: Date;
5019
5001
  /**
5020
- * Ending IPO date.
5002
+ * Filter for companies that went public on or before this date. Accepts ISO 8601 format (e.g., 2023-12-31T23:59:59) or yyyy-mm-dd format.
5021
5003
  */
5022
5004
  ipoTo?: Date;
5023
5005
  /**
5024
- * Search companies over \&#39;name\&#39;, \&#39;altNames\&#39;, \&#39;domains\&#39; and \&#39;symbols.symbol\&#39; fields. Boolean operators and logic are supported.
5006
+ * Primary search query for filtering companies across name, alternative names, domains, and ticker symbols. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5025
5007
  */
5026
5008
  q?: string;
5027
5009
  /**
5028
- * Search by company name. Boolean operators and logic are supported.
5010
+ * Search within company names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5029
5011
  */
5030
5012
  name?: string;
5031
5013
  /**
5032
- * Search by industry. Boolean operators and logic are supported.
5014
+ * Filter by company industry classifications. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5033
5015
  */
5034
5016
  industry?: string;
5035
5017
  /**
5036
- * Search by sector. Boolean operators and logic are supported.
5018
+ * Filter by company sector classifications. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5037
5019
  */
5038
5020
  sector?: string;
5039
5021
  /**
5040
- * The number of items per page.
5022
+ * The number of companies to return per page in the paginated response.
5041
5023
  */
5042
5024
  size?: number;
5043
5025
  /**
5044
- * The page number to retrieve.
5026
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
5045
5027
  */
5046
5028
  page?: number;
5047
5029
  }
5048
- interface SearchJournalists1Request {
5030
+ interface SearchJournalistsRequest {
5049
5031
  /**
5050
- * Filter by journalist ID. Journalist IDs are unique journalist identifiers which can be found through the Journalist API, or in the matchedAuthors field.
5032
+ * Filter by unique journalist identifiers. Multiple values create an OR filter to find journalists matching any of the specified IDs.
5051
5033
  */
5052
5034
  id?: Array<string>;
5053
5035
  /**
5054
- * Searches through name, title, twitterBio fields with priority given to the name, then to the title, then to the twitter bio. Returns results sorted by relevance.
5036
+ * Primary search query for filtering journalists based on their name, title, and Twitter bio. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5055
5037
  */
5056
5038
  q?: string;
5057
5039
  /**
5058
- * Searches through journalist names, scores and ranks them, returns results sorted by relevance.
5040
+ * Search specifically within journalist names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5059
5041
  */
5060
5042
  name?: string;
5061
5043
  /**
5062
- * Searches for journalists by (exact match) twitter handle.
5044
+ * Filter journalists by their exact Twitter handle, without the @ symbol.
5063
5045
  */
5064
5046
  twitter?: string;
5065
5047
  /**
5066
- * The number of items per page.
5048
+ * The number of journalists to return per page in the paginated response.
5067
5049
  */
5068
5050
  size?: number;
5069
5051
  /**
5070
- * The page number to retrieve.
5052
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
5071
5053
  */
5072
5054
  page?: number;
5073
5055
  /**
5074
- * Search for journalist by the publisher\&#39;s domain can include a subdomain. If multiple parameters are passed, they will be applied as OR operations. Wildcards (* and ?) are suported (e.g. *.cnn.com).
5056
+ * Filter journalists by the publisher domains they write for. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter.
5075
5057
  */
5076
5058
  source?: Array<string>;
5077
5059
  /**
5078
- * Searches for journalists by topic.
5060
+ * Filter journalists by the topics they frequently cover. Multiple values create an OR filter to find journalists covering any of the specified topics.
5079
5061
  */
5080
5062
  topic?: Array<string>;
5081
5063
  /**
5082
- * Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations.
5064
+ * Filter journalists by the content categories they typically write about (e.g., Politics, Tech, Sports, Business). Multiple values create an OR filter.
5083
5065
  */
5084
5066
  category?: Array<string>;
5085
5067
  /**
5086
- * Filter journalists by label. For example, searching \&#39;Opinion\&#39; will return the journalists where \&#39;Opinion\&#39;-type articles is one of the top labels for the articles they publish.
5068
+ * Filter journalists by the type of content they typically produce (e.g., Opinion, Paid-news, Non-news). Multiple values create an OR filter.
5087
5069
  */
5088
5070
  label?: Array<string>;
5089
5071
  /**
5090
- * Returns the journalists with the minimum indicated number of average monthly posts.
5072
+ * Filter for journalists who publish at least this many articles per month. Used to identify more active journalists.
5091
5073
  */
5092
5074
  minMonthlyPosts?: number;
5093
5075
  /**
5094
- * Returns the journalist with the maximum indicated number of average monthly posts.
5076
+ * Filter for journalists who publish no more than this many articles per month.
5095
5077
  */
5096
5078
  maxMonthlyPosts?: number;
5097
5079
  /**
5098
- * Country code to filter by country. If multiple parameters are passed, they will be applied as OR operations.
5080
+ * Filter journalists by countries they commonly cover in their reporting. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). Multiple values create an OR filter.
5099
5081
  */
5100
5082
  country?: Array<string>;
5101
5083
  /**
5102
- * Starting date when the record was last updated.
5084
+ * Filter for journalist profiles updated on or after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
5103
5085
  */
5104
5086
  updatedAtFrom?: Date;
5105
5087
  /**
5106
- * Ending date when the record was last updated.
5088
+ * Filter for journalist profiles updated on or before this date. Accepts ISO 8601 format (e.g., 2023-03-01T23:59:59) or yyyy-mm-dd format.
5107
5089
  */
5108
5090
  updatedAtTo?: Date;
5109
5091
  /**
5110
- * If \&#39;true\&#39;, shows accurate number of results matched by the query. By default, the counter is accurate only up to 10,000 results due performance reasons.
5092
+ * Controls whether to return the exact result count. When false (default), counts are capped at 10,000 for performance reasons. Set to true for precise counts in smaller result sets.
5111
5093
  */
5112
5094
  showNumResults?: boolean;
5113
5095
  }
5114
5096
  interface SearchPeopleRequest {
5115
5097
  /**
5116
- * Search by name of the person. Supports exact matching with quotes (\&quot;\&quot;) and Boolean operators (AND, OR, NOT).
5098
+ * Search by person\&#39;s name. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5117
5099
  */
5118
5100
  name?: string;
5119
5101
  /**
5120
- * Filter by Wikidata entity ID(s). Use this to find specific people by their Wikidata identifiers.
5102
+ * Filter by Wikidata entity IDs (e.g., Q7747, Q937). These are unique identifiers from Wikidata.org that precisely identify public figures and eliminate name ambiguity. Multiple values create an OR filter.
5121
5103
  */
5122
5104
  wikidataId?: Array<string>;
5123
5105
  /**
5124
- * Filter by Wikidata occupation ID(s). Use this to find people with specific occupations.
5106
+ * Filter by Wikidata occupation IDs (e.g., Q82955 for politician, Q33999 for actor, Q19546 for businessman). Finds people with specific professions. Multiple values create an OR filter.
5125
5107
  */
5126
5108
  occupationId?: Array<string>;
5127
5109
  /**
5128
- * Search by occupation name. Supports exact matching with quotes (\&quot;\&quot;) and Boolean operators (AND, OR, NOT).
5110
+ * Search by occupation name (e.g., politician, actor, CEO, athlete). Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5129
5111
  */
5130
5112
  occupationLabel?: string;
5131
5113
  /**
5132
- * The page number to retrieve.
5114
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
5133
5115
  */
5134
5116
  page?: number;
5135
5117
  /**
5136
- * The number of items per page.
5118
+ * The number of people to return per page in the paginated response.
5137
5119
  */
5138
5120
  size?: number;
5139
5121
  }
5140
5122
  interface SearchSourcesRequest {
5141
5123
  /**
5142
- * Domain name for the media source to lookup. This parameter supports wildcard queries, ie. \&quot;*.cnn.com\&quot; will match all subdomains for cnn.com.
5124
+ * Filter by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com, us?.nytimes.com). Multiple values create an OR filter.
5143
5125
  */
5144
5126
  domain?: Array<string>;
5145
5127
  /**
5146
- * Search by name of source. This parameter supports complex boolean search operators, and also searches the altNames field for alternative names of the source.
5128
+ * Search by source name or alternative names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5147
5129
  */
5148
5130
  name?: string;
5149
5131
  /**
5150
- * Find all sources within a sourceGroup. Find Source Groups in the guided part of our documentation...
5132
+ * Filter by predefined publisher bundles (e.g., top100, top50tech). Returns all sources within the specified group. See documentation for available source groups.
5151
5133
  */
5152
5134
  sourceGroup?: string;
5153
5135
  /**
5154
- * Use \&#39;relevance\&#39; to sort by relevance to the query, \&#39;globalRank\&#39; for top ranked sources based on popularity, \&#39;monthlyVisits\&#39; for sources with the largest audience, \&#39;avgMonthlyPosts\&#39; for sources with the highest publishing frequency. Defaults to \&#39;relevance\&#39;.
5136
+ * Determines the source sorting order. Options include relevance (default, best match to query), globalRank (by overall traffic and popularity), monthlyVisits (by total monthly visitor count), and avgMonthlyPosts (by number of articles published monthly).
5155
5137
  */
5156
5138
  sortBy?: SortBy;
5157
5139
  /**
5158
- * The page number to retrieve.
5140
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
5159
5141
  */
5160
5142
  page?: number;
5161
5143
  /**
5162
- * The number of items per page.
5144
+ * The number of sources to return per page in the paginated response.
5163
5145
  */
5164
5146
  size?: number;
5165
5147
  /**
5166
- * Filter by popularity. Enter a minimum number of monthly visits that the source must have in order to match your query.
5148
+ * Filter for sources with at least this many monthly visitors. Used to target publishers by audience size.
5167
5149
  */
5168
5150
  minMonthlyVisits?: number;
5169
5151
  /**
5170
- * Enter a maximum number of monthly visits that the source must have in order to match your query.
5152
+ * Filter for sources with no more than this many monthly visitors. Used to target publishers by audience size.
5171
5153
  */
5172
5154
  maxMonthlyVisits?: number;
5173
5155
  /**
5174
- * Returns the sources that have at least this number of average monthly posts.
5156
+ * Filter for sources that publish at least this many articles per month. Used to target publishers by content volume.
5175
5157
  */
5176
5158
  minMonthlyPosts?: number;
5177
5159
  /**
5178
- * Returns the sources that have at most this number of average monthly posts.
5160
+ * Filter for sources that publish no more than this many articles per month. Used to target publishers by content volume.
5179
5161
  */
5180
5162
  maxMonthlyPosts?: number;
5181
5163
  /**
5182
- * Country code to filter sources by the countries in which they most commonly cover. If multiple parameters are passed, they will be applied as OR operations.
5164
+ * Filter sources by countries they commonly cover in their reporting. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). See documentation for supported country codes. Multiple values create an OR filter.
5183
5165
  */
5184
5166
  country?: Array<string>;
5185
5167
  /**
5186
- * Find all local publications that are located within a given country.
5168
+ * Filter for local publications based in specific countries. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). See documentation for supported country codes. Multiple values create an OR filter.
5187
5169
  */
5188
5170
  sourceCountry?: Array<string>;
5189
5171
  /**
5190
- * Find all local publications that are located within a given state.
5172
+ * Filter for local publications based in specific states or regions. Uses standard two-letter state codes in lowercase (e.g., ca, ny, tx). See documentation for supported state codes. Multiple values create an OR filter.
5191
5173
  */
5192
5174
  sourceState?: Array<string>;
5193
5175
  /**
5194
- * Find all local publications that are located within a given county.
5176
+ * Filter for local publications based in specific counties. Multiple values create an OR filter.
5195
5177
  */
5196
5178
  sourceCounty?: Array<string>;
5197
5179
  /**
5198
- * Find all local publications that are located within a given city.
5180
+ * Filter for local publications based in specific cities. Multiple values create an OR filter.
5199
5181
  */
5200
5182
  sourceCity?: Array<string>;
5201
5183
  /**
5202
- * Latitude of the center point to search local publications.
5184
+ * Latitude coordinate for filtering local publications by geographic proximity. Used with sourceLon and sourceMaxDistance for radius search.
5203
5185
  */
5204
5186
  sourceLat?: number;
5205
5187
  /**
5206
- * Longitude of the center point to search local publications.
5188
+ * Longitude coordinate for filtering local publications by geographic proximity. Used with sourceLat and sourceMaxDistance for radius search.
5207
5189
  */
5208
5190
  sourceLon?: number;
5209
5191
  /**
5210
- * Maximum distance from starting point to search local publications.
5192
+ * Maximum distance in kilometers from the coordinates defined by sourceLat and sourceLon. Defines the radius for local publication searches.
5211
5193
  */
5212
5194
  sourceMaxDistance?: number;
5213
5195
  /**
5214
- * Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations.
5196
+ * Filter sources by their primary content categories such as Politics, Tech, Sports, Business, or Finance. Returns sources that frequently cover these topics. Multiple values create an OR filter.
5215
5197
  */
5216
5198
  category?: Array<string>;
5217
5199
  /**
5218
- * Find sources by topic. For example, searching \&#39;Markets\&#39; will return the sources where \&#39;Markets\&#39; is one of the top 10 topics that they cover.
5200
+ * Filter sources by their frequently covered topics (e.g., Markets, Cryptocurrency, Climate Change). Returns sources where the specified topic is among their top 10 covered areas. Multiple values create an OR filter.
5219
5201
  */
5220
5202
  topic?: Array<string>;
5221
5203
  /**
5222
- * Filter sources by label. For example, searching \&#39;Opinion\&#39; will return the sources where \&#39;Opinion\&#39;-type articles is one of the top labels for the articles they publish.
5204
+ * Filter sources by their content label patterns (e.g., Opinion, Paid-news, Non-news). Returns sources where the specified label is common in their published content. See documentation for all available labels. Multiple values create an OR filter.
5223
5205
  */
5224
5206
  label?: Array<string>;
5225
5207
  /**
5226
- * Use \&#39;true\&#39; to find only sources known to have a paywall, or use \&#39;false\&#39; to filter for only sources that do not have a paywall.
5208
+ * Filter by paywall status. Set to true to find sources with paywalls, or false to find sources without paywalls.
5227
5209
  */
5228
5210
  paywall?: boolean;
5229
5211
  /**
5230
- * Controls whether subdomains are included in the response. When set to true (default), all relevant subdomains of media sources will be returned as separate results. Set to false to consolidate results to parent domains only.
5212
+ * Controls whether subdomains are included as separate results. When true (default), subdomains appear as distinct sources. When false, results are consolidated to parent domains only.
5231
5213
  */
5232
5214
  showSubdomains?: boolean;
5233
5215
  /**
5234
- * If \&#39;true\&#39;, shows accurate number of results matched by the query. By default, the counter is accurate only up to 10,000 results due performance reasons.
5216
+ * Controls whether to return the exact result count. When false (default), counts are capped at 10,000 for performance reasons. Set to true for precise counts in smaller result sets.
5235
5217
  */
5236
5218
  showNumResults?: boolean;
5237
5219
  }
5238
5220
  interface SearchStoriesRequest {
5239
5221
  /**
5240
- * Search story by name, summary and key points. Preference is given to the name field. Supports complex query syntax, same way as q parameter from /all endpoint.
5222
+ * Primary search query for filtering stories based on their name, summary, and key points. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5241
5223
  */
5242
5224
  q?: string;
5243
5225
  /**
5244
- * Search story by name. Supports complex query syntax, same way as q parameter from /all endpoint.
5226
+ * Search specifically within story names. Supports Boolean operators, exact phrases with quotes, and wildcards for matching name variations.
5245
5227
  */
5246
5228
  name?: string;
5247
5229
  /**
5248
- * Filter to specific story. Passing a cluster ID will filter results to only the content found within the cluster. Multiple params could be passed.
5230
+ * Filter to specific stories using their unique identifiers. Each clusterId represents a distinct story that groups related articles. Multiple values create an OR filter.
5249
5231
  */
5250
5232
  clusterId?: Array<string>;
5251
5233
  /**
5252
- * Sort stories by count (\&#39;count\&#39;), total count (\&#39;totalCount\&#39;), creation date (\&#39;createdAt\&#39;), last updated date (\&#39;updatedAt\&#39;), or relevance (\&#39;relevance\&#39;). By default is sorted by \&#39;createdAt\&#39;
5234
+ * Excludes specific stories from the results by their unique identifiers. Use this parameter to filter out unwanted or previously seen stories.
5235
+ */
5236
+ excludeClusterId?: Array<string>;
5237
+ /**
5238
+ * Determines the story sorting order. Options include createdAt (default, when stories first emerged), updatedAt (when stories received new articles, best for tracking developing events), relevance (best match to query), count (by unique article count), and totalCount (by total article count including reprints).
5253
5239
  */
5254
5240
  sortBy?: SortBy;
5255
5241
  /**
5256
- * The page number to retrieve.
5242
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
5257
5243
  */
5258
5244
  page?: number;
5259
5245
  /**
5260
- * The number of items per page.
5246
+ * The number of articles to return per page in the paginated response.
5261
5247
  */
5262
5248
  size?: number;
5263
5249
  /**
@@ -5269,23 +5255,39 @@ interface SearchStoriesRequest {
5269
5255
  */
5270
5256
  to?: Date;
5271
5257
  /**
5272
- * Filter by topics. Each topic is some kind of entity that the article is about. Examples of topics: Markets, Joe Biden, Green Energy, Climate Change, Cryptocurrency, etc. If multiple parameters are passed, they will be applied as OR operations.
5258
+ * Filter for stories created after this date. Alternative parameter for filtering by story creation date.
5259
+ */
5260
+ initializedFrom?: Date;
5261
+ /**
5262
+ * Filter for stories created before this date. Alternative parameter for filtering by story creation date.
5263
+ */
5264
+ initializedTo?: Date;
5265
+ /**
5266
+ * Filter for stories that received new articles after this date. Useful for tracking developing news events or evolving storylines.
5267
+ */
5268
+ updatedFrom?: Date;
5269
+ /**
5270
+ * Filter for stories that received new articles before this date. Useful for tracking developing news events or evolving storylines.
5271
+ */
5272
+ updatedTo?: Date;
5273
+ /**
5274
+ * Filter stories by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and stories can include multiple topics based on their constituent articles. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter.
5273
5275
  */
5274
5276
  topic?: Array<string>;
5275
5277
  /**
5276
- * Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use \&#39;none\&#39; to search uncategorized articles. More ➜
5278
+ * Filter stories by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use \&#39;none\&#39; to find uncategorized stories. Categories are derived from the articles within each story. Multiple values create an OR filter.
5277
5279
  */
5278
5280
  category?: Array<string>;
5279
5281
  /**
5280
- * Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy&#x3D;/Finance/Banking/Other, /Finance/Investing/Funds
5282
+ * Filter stories by Google Content Categories. Must pass the full hierarchical path of the category. Example: taxonomy&#x3D;/Finance/Banking/Other,/Finance/Investing/Funds. Stories are categorized based on their constituent articles. Multiple values create an OR filter.
5281
5283
  */
5282
5284
  taxonomy?: Array<string>;
5283
5285
  /**
5284
- * Filter stories by sources that wrote articles belonging to this story. At least 1 article is required for story to match. Multiple parameters could be passed.
5286
+ * Filter stories that contain articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). A story will match if it contains at least one article from any of the specified sources. Multiple values create an OR filter.
5285
5287
  */
5286
5288
  source?: Array<string>;
5287
5289
  /**
5288
- * Filter stories by sources that wrote articles belonging to this story. Source groups are expanded into a list of sources. At least 1 article by the source is required for story to match. Multiple params could be passed.
5290
+ * Filter stories that contain articles from publishers in Perigon\&#39;s curated bundles (e.g., top100, top25crypto). A story will match if it contains at least one article from any publisher in the specified bundles. Multiple values create an OR filter.
5289
5291
  */
5290
5292
  sourceGroup?: Array<string>;
5291
5293
  /**
@@ -5293,27 +5295,27 @@ interface SearchStoriesRequest {
5293
5295
  */
5294
5296
  minUniqueSources?: number;
5295
5297
  /**
5296
- * List of person Wikidata IDs for filtering. Filter is applied on topPeople field.
5298
+ * Filter stories by Wikidata IDs of top mentioned people. Returns stories where these individuals appear prominently. Refer to the /people endpoint for a complete list of tracked individuals.
5297
5299
  */
5298
5300
  personWikidataId?: Array<string>;
5299
5301
  /**
5300
- * List of people names. Filtering is applied on topPeople field.
5302
+ * Filter stories by exact name matches of top mentioned people. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint.
5301
5303
  */
5302
5304
  personName?: string;
5303
5305
  /**
5304
- * List of company IDs for filtering. Filtering is applied to topCompanies field.
5306
+ * Filter stories by identifiers of top mentioned companies. Returns stories where these companies appear prominently. For a complete list of tracked companies, refer to the /companies endpoint.
5305
5307
  */
5306
5308
  companyId?: Array<string>;
5307
5309
  /**
5308
- * List of company names for filtering. Filtering is applied on topCompanies field.
5310
+ * Filter stories by names of top mentioned companies. Performs an exact match on company names in the topCompanies field.
5309
5311
  */
5310
5312
  companyName?: string;
5311
5313
  /**
5312
- * List of company domains for filtering. Filtering is applied on topCompanies field.
5314
+ * Filter stories by domains of top mentioned companies (e.g., apple.com). Returns stories where companies with these domains appear prominently. For available company entities, consult the /companies endpoint.
5313
5315
  */
5314
5316
  companyDomain?: Array<string>;
5315
5317
  /**
5316
- * List of company tickers for filtering. Filtering is applied on topCompanies field.
5318
+ * Filter stories by stock symbols of top mentioned companies. Returns stories where companies with these symbols appear prominently. For available company entities and their symbols, consult the /companies endpoint.
5317
5319
  */
5318
5320
  companySymbol?: Array<string>;
5319
5321
  /**
@@ -5341,49 +5343,33 @@ interface SearchStoriesRequest {
5341
5343
  */
5342
5344
  maxClusterSize?: number;
5343
5345
  /**
5344
- * Returns stories with name assigned. Defaults to true.
5346
+ * Filter to only include stories that have been assigned names. Defaults to true. Note that stories only receive names after they contain at least 5 unique articles.
5345
5347
  */
5346
5348
  nameExists?: boolean;
5347
5349
  /**
5348
- * Filters results with a sentiment score greater than or equal to the specified value, indicating positive sentiment. See the Article Data section in Docs for an explanation of scores.
5350
+ * Filter articles with an aggregate positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
5349
5351
  */
5350
5352
  positiveSentimentFrom?: number;
5351
5353
  /**
5352
- * Filters results with a sentiment score less than or equal to the specified value, indicating positive sentiment. See the Article Data section in Docs for an explanation of scores.
5354
+ * Filter articles with an aggregate positive sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
5353
5355
  */
5354
5356
  positiveSentimentTo?: number;
5355
5357
  /**
5356
- * Filters results with a sentiment score greater than or equal to the specified value, indicating neutral sentiment. Explanation of sentimental values can be found in Docs under the Article Data section.
5358
+ * Filter articles with an aggregate neutral sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
5357
5359
  */
5358
5360
  neutralSentimentFrom?: number;
5359
5361
  /**
5360
- * Filters results with a sentiment score less than or equal to the specified value, indicating neutral sentiment. See the Article Data section in Docs for an explanation of scores.
5362
+ * Filter articles with an aggregate neutral sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
5361
5363
  */
5362
5364
  neutralSentimentTo?: number;
5363
5365
  /**
5364
- * Filters results with a sentiment score greater than or equal to the specified value, indicating negative sentiment. See the Article Data section in Docs for an explanation of scores.
5366
+ * Filter stories with an aggregate negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
5365
5367
  */
5366
5368
  negativeSentimentFrom?: number;
5367
5369
  /**
5368
- * Filters results with a sentiment score less than or equal to the specified value, indicating negative sentiment. See the Article Data section in Docs for an explanation of scores.
5370
+ * Filter articles with an aggregate negative sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
5369
5371
  */
5370
5372
  negativeSentimentTo?: number;
5371
- /**
5372
- * \&#39;initializedFrom\&#39; filter, will search stories that became available after provided date
5373
- */
5374
- initializedFrom?: Date;
5375
- /**
5376
- * \&#39;initializedTo\&#39; filter, will search stories that became available before provided date
5377
- */
5378
- initializedTo?: Date;
5379
- /**
5380
- * Will return stories with \&#39;updatedAt\&#39; &gt;&#x3D; \&#39;updatedFrom\&#39;.
5381
- */
5382
- updatedFrom?: Date;
5383
- /**
5384
- * Will return stories with \&#39;updatedAt\&#39; &lt;&#x3D; \&#39;updatedTo\&#39;.
5385
- */
5386
- updatedTo?: Date;
5387
5373
  /**
5388
5374
  * Parameter showStoryPageInfo
5389
5375
  */
@@ -5396,10 +5382,6 @@ interface SearchStoriesRequest {
5396
5382
  * Stories are deduplicated by default. If a story is deduplicated, all future articles are merged into the original story. duplicateOf field contains the original cluster Id. When showDuplicates&#x3D;true, all stories are shown.
5397
5383
  */
5398
5384
  showDuplicates?: boolean;
5399
- /**
5400
- * Excludes specific stories from the results by their unique identifiers. Use this parameter to filter out unwanted or previously seen stories.
5401
- */
5402
- excludeClusterId?: Array<string>;
5403
5385
  }
5404
5386
  interface SearchSummarizerRequest {
5405
5387
  /**
@@ -5408,87 +5390,87 @@ interface SearchSummarizerRequest {
5408
5390
  */
5409
5391
  summaryBody: SummaryBody;
5410
5392
  /**
5411
- * Search query, each article will be scored and ranked against it. Articles are searched on the title, description, and content fields.
5393
+ * Primary search query for filtering articles based on their title, description, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
5412
5394
  */
5413
5395
  q?: string;
5414
5396
  /**
5415
- * Search article headlines/title field. Semantic similar to q parameter.
5397
+ * Search specifically within article headlines/titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
5416
5398
  */
5417
5399
  title?: string;
5418
5400
  /**
5419
- * Search query on the description field. Semantic similar to q parameter.
5401
+ * Search within article description fields. Supports Boolean expressions, exact phrase matching with quotes, and wildcards for flexible pattern matching.
5420
5402
  */
5421
5403
  desc?: string;
5422
5404
  /**
5423
- * Search query on the article\&#39;s body of content field. Semantic similar to q parameter.
5405
+ * Search within the full article body content. Supports Boolean logic, exact phrase matching with quotes, and wildcards for comprehensive content searching.
5424
5406
  */
5425
5407
  content?: string;
5426
5408
  /**
5427
- * Search query on the url field. Semantic similar to q parameter. E.g. could be used for querying certain website sections, e.g. source&#x3D;cnn.com&amp;url&#x3D;travel.
5409
+ * Search within article URLs to find content from specific website sections or domains. Supports wildcards (* and ?) for partial URL matching.
5428
5410
  */
5429
5411
  url?: string;
5430
5412
  /**
5431
- * Article ID will search for a news article by the ID of the article. If several parameters are passed, all matched articles will be returned.
5413
+ * Retrieve specific news articles by their unique article identifiers. Multiple IDs can be provided to return a collection of specific articles.
5432
5414
  */
5433
5415
  articleId?: Array<string>;
5434
5416
  /**
5435
- * Search for related content using a cluster ID. Passing a cluster ID will filter results to only the content found within the cluster.
5417
+ * Filter results to only show content within a specific related content cluster. Returns articles grouped together as part of Perigon Stories based on topic relevance.
5436
5418
  */
5437
5419
  clusterId?: Array<string>;
5438
5420
  /**
5439
- * \&#39;relevance\&#39; to sort by relevance to the query, \&#39;date\&#39; to sort by the publication date (desc), \&#39;pubDate\&#39; is a synonym to \&#39;date\&#39;, \&#39;addDate\&#39; to sort by \&#39;addDate\&#39; field (desc), \&#39;refreshDate\&#39; to sort by \&#39;refreshDate\&#39; field (desc). Defaults to \&#39;relevance\&#39;
5421
+ * Determines the article sorting order. Options include relevance (default), date/pubDate (newest publication date first), reverseDate (oldest publication date first), addDate (newest ingestion date first), reverseAddDate (oldest ingestion date first), and refreshDate (most recently updated in system first, often identical to addDate).
5440
5422
  */
5441
5423
  sortBy?: AllEndpointSortBy;
5442
5424
  /**
5443
- * The page number to retrieve.
5425
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
5444
5426
  */
5445
5427
  page?: number;
5446
5428
  /**
5447
- * The number of items per page.
5429
+ * The number of articles to return per page in the paginated response.
5448
5430
  */
5449
5431
  size?: number;
5450
5432
  /**
5451
- * \&#39;from\&#39; filter, will search articles published after the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2023-03-01T00:00:00
5433
+ * Filter for articles published after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
5452
5434
  */
5453
5435
  from?: Date;
5454
5436
  /**
5455
- * \&#39;to\&#39; filter, will search articles published before the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T23:59:59
5437
+ * Filter for articles published before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
5456
5438
  */
5457
5439
  to?: Date;
5458
5440
  /**
5459
- * \&#39;addDateFrom\&#39; filter, will search articles added after the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T00:00:00
5441
+ * Filter for articles added to Perigon\&#39;s system after this date. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
5460
5442
  */
5461
5443
  addDateFrom?: Date;
5462
5444
  /**
5463
- * \&#39;addDateTo\&#39; filter, will search articles added before the specified date, the date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T23:59:59
5445
+ * Filter for articles added to Perigon\&#39;s system before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
5464
5446
  */
5465
5447
  addDateTo?: Date;
5466
5448
  /**
5467
- * Will search articles that were refreshed after the specified date. The date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T00:00:00
5449
+ * Filter for articles refreshed/updated in Perigon\&#39;s system after this date. In most cases yields similar results to addDateFrom but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
5468
5450
  */
5469
5451
  refreshDateFrom?: Date;
5470
5452
  /**
5471
- * Will search articles that were refreshed before the specified date. The date could be passed as ISO or \&#39;yyyy-mm-dd\&#39;. Add time in ISO format, ie. 2022-02-01T23:59:59
5453
+ * Filter for articles refreshed/updated in Perigon\&#39;s system before this date. In most cases yields similar results to addDateTo but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
5472
5454
  */
5473
5455
  refreshDateTo?: Date;
5474
5456
  /**
5475
- * Medium will filter out news articles medium, which could be \&#39;Video\&#39; or \&#39;Article\&#39;. If several parameters are passed, all matched articles will be returned.
5457
+ * Filter articles by their primary medium type. Accepts Article for written content or Video for video-based stories. Multiple values create an OR filter.
5476
5458
  */
5477
5459
  medium?: Array<string>;
5478
5460
  /**
5479
- * Publisher\&#39;s domain can include a subdomain. If multiple parameters are passed, they will be applied as OR operations. Wildcards (* and ?) are suported (e.g. *.cnn.com).
5461
+ * Filter articles by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter.
5480
5462
  */
5481
5463
  source?: Array<string>;
5482
5464
  /**
5483
- * One of the supported source groups. Find Source Groups in the guided part of our documentation...
5465
+ * Filter articles using Perigon\&#39;s curated publisher bundles (e.g., top100, top25crypto). Multiple values create an OR filter to include articles from any of the specified bundles.
5484
5466
  */
5485
5467
  sourceGroup?: Array<string>;
5486
5468
  /**
5487
- * A list of built-in source group names to exclude from the results. The Perigon API categorizes sources into groups (for example, “top10” or “top100”) based on type or popularity. Using this filter allows you to remove articles coming from any source that belongs to one or more of the specified groups.
5469
+ * Exclude articles from specified Perigon source groups. Multiple values create an AND-exclude filter, removing content from publishers in any of the specified bundles (e.g., top10, top100).
5488
5470
  */
5489
5471
  excludeSourceGroup?: Array<string>;
5490
5472
  /**
5491
- * The domain of the website, which should be excluded from the search. Multiple parameters could be provided. Wildcards (* and ?) are suported (e.g. *.cnn.com).
5473
+ * Exclude articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an AND-exclude filter.
5492
5474
  */
5493
5475
  excludeSource?: Array<string>;
5494
5476
  /**
@@ -5496,71 +5478,71 @@ interface SearchSummarizerRequest {
5496
5478
  */
5497
5479
  paywall?: boolean;
5498
5480
  /**
5499
- * Author names to filter by. Article author bylines are used as a source field. If multiple parameters are passed, they will be applied as OR operations.
5481
+ * Filter articles by author bylines. Works as an exact match for each author name provided. Multiple values create an OR filter to find articles by any of the specified authors.
5500
5482
  */
5501
5483
  byline?: Array<string>;
5502
5484
  /**
5503
- * A list of author names to include. Only articles written by any of the specified authors are returned. This is ideal when you wish to focus on content from particular voices or experts.
5485
+ * Filter articles by specific author names. Works as an exact match for each name. Multiple values create an OR filter to find articles by any of the specified authors.
5504
5486
  */
5505
5487
  author?: Array<string>;
5506
5488
  /**
5507
- * A list of author names to exclude from the search results. Any article written by an author whose name matches one in this list will be omitted, which helps to avoid content from certain individuals.
5489
+ * Exclude articles written by specific authors. Any article with an author name matching an entry in this list will be omitted from results. Multiple values create an AND-exclude filter.
5508
5490
  */
5509
5491
  excludeAuthor?: Array<string>;
5510
5492
  /**
5511
- * Filter by journalist ID. Journalist IDs are unique journalist identifiers which can be found through the Journalist API, or in the matchedAuthors field.
5493
+ * Filter by unique journalist identifiers which can be found through the Journalist API or in the matchedAuthors field. Multiple values create an OR filter.
5512
5494
  */
5513
5495
  journalistId?: Array<string>;
5514
5496
  /**
5515
- * A list of journalist (or reporter) identifiers to exclude. If an article is written by a journalist whose ID matches any in this list, it will not be part of the result set.
5497
+ * Exclude articles written by specific journalists identified by their unique IDs. Multiple values create an AND-exclude filter.
5516
5498
  */
5517
5499
  excludeJournalistId?: Array<string>;
5518
5500
  /**
5519
- * Language code to filter by language. If multiple parameters are passed, they will be applied as OR operations.
5501
+ * Filter articles by their language using ISO-639 two-letter codes (e.g., en, es, fr). Multiple values create an OR filter.
5520
5502
  */
5521
5503
  language?: Array<string>;
5522
5504
  /**
5523
- * A list of languages to be excluded. Any article published in one of the languages provided in this filter will not be returned. This is useful when you are interested only in news published in specific languages.
5505
+ * Exclude articles in specific languages using ISO-639 two-letter codes. Multiple values create an AND-exclude filter.
5524
5506
  */
5525
5507
  excludeLanguage?: Array<string>;
5526
5508
  /**
5527
- * Expand a query to search the translation, translatedTitle, and translatedDescription fields for non-English articles.
5509
+ * Expand search to include translated content fields for non-English articles. When true, searches translated title, description, and content fields.
5528
5510
  */
5529
5511
  searchTranslation?: boolean;
5530
5512
  /**
5531
- * Labels to filter by, could be \&#39;Opinion\&#39;, \&#39;Paid-news\&#39;, \&#39;Non-news\&#39;, etc. If multiple parameters are passed, they will be applied as OR operations.
5513
+ * Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. Multiple values create an OR filter.
5532
5514
  */
5533
5515
  label?: Array<string>;
5534
5516
  /**
5535
- * Exclude results that include specific labels (Opinion, Non-news, Paid News, etc.). You can filter multiple by repeating the parameter.
5517
+ * Exclude articles with specific editorial labels. Multiple values create an AND-exclude filter, removing all content with any of these labels.
5536
5518
  */
5537
5519
  excludeLabel?: Array<string>;
5538
5520
  /**
5539
- * Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use \&#39;none\&#39; to search uncategorized articles.
5521
+ * Filter by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use \&#39;none\&#39; to find uncategorized articles. Multiple values create an OR filter.
5540
5522
  */
5541
5523
  category?: Array<string>;
5542
5524
  /**
5543
- * A list of article categories to be omitted. If an article is tagged with any category present in this list (such as “Polotics”, “Tech”, “Sports”, etc.), it will not appear in the search results.
5525
+ * Exclude articles with specific categories. Multiple values create an AND-exclude filter, removing all content with any of these categories.
5544
5526
  */
5545
5527
  excludeCategory?: Array<string>;
5546
5528
  /**
5547
- * Filters results to include only articles with the specified topics. Topics are more specific classifications than categories, with an article potentially having multiple topics assigned. Perigon uses both human and machine curation to maintain an evolving list of available topics. Common examples include \&#39;Markets\&#39;, \&#39;Crime\&#39;, \&#39;Cryptocurrency\&#39;, \&#39;Social Issues\&#39;, \&#39;College Sports\&#39;, etc. See the Topics page in Docs for a complete list of available topics.
5529
+ * Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and articles can have multiple topics. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter.
5548
5530
  */
5549
5531
  topic?: Array<string>;
5550
5532
  /**
5551
- * Filter by excluding topics. Each topic is some kind of entity that the article is about. Examples of topics: Markets, Joe Biden, Green Energy, Climate Change, Cryptocurrency, etc. If multiple parameters are passed, they will be applied as OR operations.
5533
+ * Exclude articles with specific topics. Multiple values create an AND-exclude filter, removing all content with any of these topics.
5552
5534
  */
5553
5535
  excludeTopic?: Array<string>;
5554
5536
  /**
5555
- * Returns only articles that point to specified links (as determined by the \&#39;links\&#39; field in the article response).
5537
+ * Returns only articles that contain links to the specified URL pattern. Matches against the \&#39;links\&#39; field in article responses.
5556
5538
  */
5557
5539
  linkTo?: string;
5558
5540
  /**
5559
- * Whether to return reprints in the response or not. Reprints are usually wired articles from sources like AP or Reuters that are reprinted in multiple sources at the same time. By default, this parameter is \&#39;true\&#39;.
5541
+ * Controls whether to include reprinted content in results. When true (default), shows syndicated articles from wire services like AP or Reuters that appear on multiple sites.
5560
5542
  */
5561
5543
  showReprints?: boolean;
5562
5544
  /**
5563
- * Shows all articles belonging to the same reprint group. A reprint group includes one original article (the first one processed by the API) and all its known reprints.
5545
+ * Returns all articles in a specific reprint group, including the original article and all its known reprints. Use when you want to see all versions of the same content.
5564
5546
  */
5565
5547
  reprintGroupId?: string;
5566
5548
  /**
@@ -5648,43 +5630,43 @@ interface SearchSummarizerRequest {
5648
5630
  */
5649
5631
  sourceMaxDistance?: number;
5650
5632
  /**
5651
- * List of person Wikidata IDs for filtering.
5633
+ * Filter articles by Wikidata IDs of mentioned people. Refer to the /people endpoint for a complete list of tracked individuals.
5652
5634
  */
5653
5635
  personWikidataId?: Array<string>;
5654
5636
  /**
5655
- * A list of Wikidata identifiers for individuals. Articles mentioning persons with any of these Wikidata IDs will be filtered out. This is particularly helpful when using a unique identifier to prevent ambiguity in names.
5637
+ * Exclude articles mentioning people with specific Wikidata IDs. Creates an AND-exclude filter to remove content about these individuals. Uses precise identifiers to avoid name ambiguity.
5656
5638
  */
5657
5639
  excludePersonWikidataId?: Array<string>;
5658
5640
  /**
5659
- * List of person names for exact matches. Boolean and complex logic is not supported on this paramter.
5641
+ * Filter articles by exact person name matches. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint.
5660
5642
  */
5661
5643
  personName?: Array<string>;
5662
5644
  /**
5663
- * A list of person names that, when associated with the content, cause the article to be excluded. This filter removes articles related to any individuals whose names match those on the list.
5645
+ * Exclude articles mentioning specific people by name. Creates an AND-exclude filter to remove content about these individuals.
5664
5646
  */
5665
5647
  excludePersonName?: Array<string>;
5666
5648
  /**
5667
- * List of company IDs to filter by.
5649
+ * Filter articles by company identifiers. For a complete list of tracked companies, refer to the /companies endpoint.
5668
5650
  */
5669
5651
  companyId?: Array<string>;
5670
5652
  /**
5671
- * A list of company identifiers. Articles associated with companies that have any of these unique IDs will be filtered out from the returned results, ensuring that certain companies or corporate entities are not included.
5653
+ * Exclude articles mentioning companies with specific identifiers. Creates an AND-exclude filter to remove content about these corporate entities.
5672
5654
  */
5673
5655
  excludeCompanyId?: Array<string>;
5674
5656
  /**
5675
- * Search by company name.
5657
+ * Filter articles by company name mentions. Performs an exact match on company names.
5676
5658
  */
5677
5659
  companyName?: string;
5678
5660
  /**
5679
- * Search by company domains for filtering. E.g. companyDomain&#x3D;apple.com.
5661
+ * Filter articles by company domains (e.g., apple.com). For available company entities, consult the /companies endpoint.
5680
5662
  */
5681
5663
  companyDomain?: Array<string>;
5682
5664
  /**
5683
- * A list of company domains to exclude. If an article is related to a company that uses one of the specified domains (for instance, “example.com”), it will not be returned in the results.
5665
+ * Exclude articles related to companies with specific domains. Creates an AND-exclude filter to remove content about these companies.
5684
5666
  */
5685
5667
  excludeCompanyDomain?: Array<string>;
5686
5668
  /**
5687
- * Search by company symbols.
5669
+ * Filter articles by company stock symbols. For available company entities and their symbols, consult the /companies endpoint.
5688
5670
  */
5689
5671
  companySymbol?: Array<string>;
5690
5672
  /**
@@ -5696,31 +5678,31 @@ interface SearchSummarizerRequest {
5696
5678
  */
5697
5679
  showNumResults?: boolean;
5698
5680
  /**
5699
- * Filters results with a sentiment score greater than or equal to the specified value, indicating positive sentiment. See the Article Data section in Docs for an explanation of scores.
5681
+ * Filter articles with a positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
5700
5682
  */
5701
5683
  positiveSentimentFrom?: number;
5702
5684
  /**
5703
- * Filters results with a sentiment score less than or equal to the specified value, indicating positive sentiment. See the Article Data section in Docs for an explanation of scores.
5685
+ * Filter articles with a positive sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
5704
5686
  */
5705
5687
  positiveSentimentTo?: number;
5706
5688
  /**
5707
- * Filters results with a sentiment score greater than or equal to the specified value, indicating neutral sentiment. Explanation of sentimental values can be found in Docs under the Article Data section.
5689
+ * Filter articles with a neutral sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
5708
5690
  */
5709
5691
  neutralSentimentFrom?: number;
5710
5692
  /**
5711
- * Filters results with a sentiment score less than or equal to the specified value, indicating neutral sentiment. See the Article Data section in Docs for an explanation of scores.
5693
+ * Filter articles with a neutral sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
5712
5694
  */
5713
5695
  neutralSentimentTo?: number;
5714
5696
  /**
5715
- * Filters results with a sentiment score greater than or equal to the specified value, indicating negative sentiment. See the Article Data section in Docs for an explanation of scores.
5697
+ * Filter articles with a negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
5716
5698
  */
5717
5699
  negativeSentimentFrom?: number;
5718
5700
  /**
5719
- * Filters results with a sentiment score less than or equal to the specified value, indicating negative sentiment. See the Article Data section in Docs for an explanation of scores.
5701
+ * Filter articles with a negative sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
5720
5702
  */
5721
5703
  negativeSentimentTo?: number;
5722
5704
  /**
5723
- * Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy&#x3D;/Finance/Banking/Other, /Finance/Investing/Funds
5705
+ * Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy&#x3D;/Finance/Banking/Other, /Finance/Investing/Funds. [Full list](https://cloud.google.com/natural-language/docs/categories)
5724
5706
  */
5725
5707
  taxonomy?: Array<string>;
5726
5708
  /**
@@ -5730,23 +5712,23 @@ interface SearchSummarizerRequest {
5730
5712
  }
5731
5713
  interface SearchTopicsRequest {
5732
5714
  /**
5733
- * Search by name.
5715
+ * Search for topics by exact name or partial text match. Does not support wildcards. Examples include Markets, Cryptocurrency, Climate Change, etc.
5734
5716
  */
5735
5717
  name?: string;
5736
5718
  /**
5737
- * Search by category.
5719
+ * Filter topics by broad article categories such as Politics, Tech, Sports, Business, Finance, Entertainment, etc.
5738
5720
  */
5739
5721
  category?: string;
5740
5722
  /**
5741
- * Search by subcategory.
5723
+ * Filter topics by their specific subcategory. Subcategories provide more granular classification beyond the main category, such as TV or Event.
5742
5724
  */
5743
5725
  subcategory?: string;
5744
5726
  /**
5745
- * The page number to retrieve.
5727
+ * The specific page of results to retrieve in the paginated response. Starts at 0.
5746
5728
  */
5747
5729
  page?: number;
5748
5730
  /**
5749
- * The number of items per page.
5731
+ * The number of topics to return per page in the paginated response.
5750
5732
  */
5751
5733
  size?: number;
5752
5734
  }
@@ -5818,12 +5800,12 @@ interface V1ApiInterface {
5818
5800
  * @throws {RequiredError}
5819
5801
  * @memberof V1ApiInterface
5820
5802
  */
5821
- searchJournalists1Raw(requestParameters: SearchJournalists1Request, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<JournalistSearchResult>>;
5803
+ searchJournalistsRaw(requestParameters: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<JournalistSearchResult>>;
5822
5804
  /**
5823
5805
  * Search journalists using broad search attributes. Our database contains over 230,000 journalists from around the world and is refreshed frequently.
5824
5806
  * Journalists
5825
5807
  */
5826
- searchJournalists1(requestParameters: SearchJournalists1Request, initOverrides?: RequestInit | InitOverrideFunction): Promise<JournalistSearchResult>;
5808
+ searchJournalists(requestParameters: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<JournalistSearchResult>;
5827
5809
  /**
5828
5810
  * Search and retrieve additional information on known persons that exist within Perigon\'s entity database and as referenced in any article response object. Our database contains over 650,000 people from around the world and is refreshed frequently. People data is derived from Wikidata and includes a wikidataId field that can be used to lookup even more information on Wikidata\'s website.
5829
5811
  * @summary People
@@ -5953,12 +5935,12 @@ declare class V1Api extends BaseAPI implements V1ApiInterface {
5953
5935
  * Search journalists using broad search attributes. Our database contains over 230,000 journalists from around the world and is refreshed frequently.
5954
5936
  * Journalists
5955
5937
  */
5956
- searchJournalists1Raw(requestParameters: SearchJournalists1Request, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<JournalistSearchResult>>;
5938
+ searchJournalistsRaw(requestParameters: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<JournalistSearchResult>>;
5957
5939
  /**
5958
5940
  * Search journalists using broad search attributes. Our database contains over 230,000 journalists from around the world and is refreshed frequently.
5959
5941
  * Journalists
5960
5942
  */
5961
- searchJournalists1(requestParameters?: SearchJournalists1Request, initOverrides?: RequestInit | InitOverrideFunction): Promise<JournalistSearchResult>;
5943
+ searchJournalists(requestParameters?: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<JournalistSearchResult>;
5962
5944
  /**
5963
5945
  * Search and retrieve additional information on known persons that exist within Perigon\'s entity database and as referenced in any article response object. Our database contains over 650,000 people from around the world and is refreshed frequently. People data is derived from Wikidata and includes a wikidataId field that can be used to lookup even more information on Wikidata\'s website.
5964
5946
  * People
@@ -6021,4 +6003,4 @@ declare class V1Api extends BaseAPI implements V1ApiInterface {
6021
6003
  vectorSearchArticles(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<VectorSearchResult>;
6022
6004
  }
6023
6005
 
6024
- export { AllEndpointSortBy, AllEndpointSortByFromJSON, AllEndpointSortByFromJSONTyped, AllEndpointSortByToJSON, AllEndpointSortByToJSONTyped, type ApiResponse, type Article, ArticleFromJSON, ArticleFromJSONTyped, type ArticleSearchFilter, ArticleSearchFilterFromJSON, ArticleSearchFilterFromJSONTyped, ArticleSearchFilterToJSON, ArticleSearchFilterToJSONTyped, type ArticleSearchParams, ArticleSearchParamsFromJSON, ArticleSearchParamsFromJSONTyped, ArticleSearchParamsToJSON, ArticleSearchParamsToJSONTyped, ArticleToJSON, ArticleToJSONTyped, type AuthException, AuthExceptionFromJSON, AuthExceptionFromJSONTyped, AuthExceptionStatusCodeEnum, AuthExceptionToJSON, AuthExceptionToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, type CategoryHolder, CategoryHolderFromJSON, CategoryHolderFromJSONTyped, CategoryHolderToJSON, CategoryHolderToJSONTyped, type CategoryWithScoreHolder, CategoryWithScoreHolderFromJSON, CategoryWithScoreHolderFromJSONTyped, CategoryWithScoreHolderToJSON, CategoryWithScoreHolderToJSONTyped, type Company, type CompanyCount, CompanyCountFromJSON, CompanyCountFromJSONTyped, CompanyCountToJSON, CompanyCountToJSONTyped, CompanyFromJSON, CompanyFromJSONTyped, type CompanyHolder, CompanyHolderFromJSON, CompanyHolderFromJSONTyped, CompanyHolderToJSON, CompanyHolderToJSONTyped, type CompanySearchResult, CompanySearchResultFromJSON, CompanySearchResultFromJSONTyped, CompanySearchResultToJSON, CompanySearchResultToJSONTyped, CompanyToJSON, CompanyToJSONTyped, Configuration, type ConfigurationParameters, type Consume, type Coordinate, type CoordinateFilter, CoordinateFilterFromJSON, CoordinateFilterFromJSONTyped, CoordinateFilterToJSON, CoordinateFilterToJSONTyped, CoordinateFromJSON, CoordinateFromJSONTyped, CoordinateToJSON, CoordinateToJSONTyped, DefaultConfig, type EntityHolder, EntityHolderFromJSON, EntityHolderFromJSONTyped, EntityHolderToJSON, EntityHolderToJSONTyped, type ErrorContext, type EventTypeHolder, EventTypeHolderFromJSON, EventTypeHolderFromJSONTyped, EventTypeHolderToJSON, EventTypeHolderToJSONTyped, type FetchAPI, FetchError, type FetchParams, type GetJournalistByIdRequest, type HTTPBody, type HTTPHeaders, type HTTPMethod, type HTTPQuery, type HTTPRequestInit, type IdNameHolder, IdNameHolderFromJSON, IdNameHolderFromJSONTyped, IdNameHolderToJSON, IdNameHolderToJSONTyped, type IllegalParameterException, IllegalParameterExceptionFromJSON, IllegalParameterExceptionFromJSONTyped, IllegalParameterExceptionToJSON, IllegalParameterExceptionToJSONTyped, type ImageHolder, ImageHolderFromJSON, ImageHolderFromJSONTyped, ImageHolderToJSON, ImageHolderToJSONTyped, type InitOverrideFunction, type InternalErrorException, InternalErrorExceptionFromJSON, InternalErrorExceptionFromJSONTyped, InternalErrorExceptionToJSON, InternalErrorExceptionToJSONTyped, JSONApiResponse, type Journalist, JournalistFromJSON, JournalistFromJSONTyped, type JournalistSearchResult, JournalistSearchResultFromJSON, JournalistSearchResultFromJSONTyped, JournalistSearchResultToJSON, JournalistSearchResultToJSONTyped, JournalistToJSON, JournalistToJSONTyped, type Json, type KeyPoint, KeyPointFromJSON, KeyPointFromJSONTyped, KeyPointToJSON, KeyPointToJSONTyped, type KeywordHolder, KeywordHolderFromJSON, KeywordHolderFromJSONTyped, KeywordHolderToJSON, KeywordHolderToJSONTyped, type LabelHolder, LabelHolderFromJSON, LabelHolderFromJSONTyped, LabelHolderToJSON, LabelHolderToJSONTyped, type LocationCount, LocationCountFromJSON, LocationCountFromJSONTyped, LocationCountToJSON, LocationCountToJSONTyped, type LocationHolder, LocationHolderFromJSON, LocationHolderFromJSONTyped, LocationHolderToJSON, LocationHolderToJSONTyped, type Middleware, type ModelPropertyNaming, type NameCount, NameCountFromJSON, NameCountFromJSONTyped, NameCountToJSON, NameCountToJSONTyped, type NewsCluster, NewsClusterFromJSON, NewsClusterFromJSONTyped, NewsClusterToJSON, NewsClusterToJSONTyped, type NotFoundException, NotFoundExceptionFromJSON, NotFoundExceptionFromJSONTyped, NotFoundExceptionToJSON, NotFoundExceptionToJSONTyped, type PeopleSearchResult, PeopleSearchResultFromJSON, PeopleSearchResultFromJSONTyped, PeopleSearchResultToJSON, PeopleSearchResultToJSONTyped, type Person, type PersonCount, PersonCountFromJSON, PersonCountFromJSONTyped, PersonCountToJSON, PersonCountToJSONTyped, PersonFromJSON, PersonFromJSONTyped, type PersonHolder, PersonHolderFromJSON, PersonHolderFromJSONTyped, PersonHolderToJSON, PersonHolderToJSONTyped, PersonToJSON, PersonToJSONTyped, type Place, PlaceFromJSON, PlaceFromJSONTyped, PlaceToJSON, PlaceToJSONTyped, type QuerySearchResult, QuerySearchResultFromJSON, QuerySearchResultFromJSONTyped, QuerySearchResultToJSON, QuerySearchResultToJSONTyped, type Question, QuestionFromJSON, QuestionFromJSONTyped, QuestionToJSON, QuestionToJSONTyped, type RecordStatHolder, RecordStatHolderFromJSON, RecordStatHolderFromJSONTyped, RecordStatHolderToJSON, RecordStatHolderToJSONTyped, type RequestContext, type RequestOpts, RequiredError, type ResponseContext, ResponseError, type ResponseTransformer, type ScoredArticle, ScoredArticleFromJSON, ScoredArticleFromJSONTyped, ScoredArticleToJSON, ScoredArticleToJSONTyped, type SearchArticlesRequest, type SearchCompaniesRequest, type SearchJournalists1Request, type SearchPeopleRequest, type SearchSourcesRequest, type SearchStoriesRequest, type SearchSummarizerRequest, type SearchTopicsRequest, type SentimentHolder, SentimentHolderFromJSON, SentimentHolderFromJSONTyped, SentimentHolderToJSON, SentimentHolderToJSONTyped, SortBy, SortByFromJSON, SortByFromJSONTyped, SortByToJSON, SortByToJSONTyped, type Source, SourceFromJSON, SourceFromJSONTyped, type SourceHolder, SourceHolderFromJSON, SourceHolderFromJSONTyped, SourceHolderToJSON, SourceHolderToJSONTyped, type SourceLocation, SourceLocationFromJSON, SourceLocationFromJSONTyped, SourceLocationToJSON, SourceLocationToJSONTyped, type SourceSearchResult, SourceSearchResultFromJSON, SourceSearchResultFromJSONTyped, SourceSearchResultToJSON, SourceSearchResultToJSONTyped, SourceToJSON, SourceToJSONTyped, type SourceTopStatHolder, SourceTopStatHolderFromJSON, SourceTopStatHolderFromJSONTyped, SourceTopStatHolderToJSON, SourceTopStatHolderToJSONTyped, type StorySearchResult, StorySearchResultFromJSON, StorySearchResultFromJSONTyped, StorySearchResultToJSON, StorySearchResultToJSONTyped, type SummaryBody, SummaryBodyFromJSON, SummaryBodyFromJSONTyped, SummaryBodyMethodEnum, SummaryBodyModelEnum, SummaryBodySummarizeFieldsEnum, SummaryBodyToJSON, SummaryBodyToJSONTyped, type SummarySearchResult, SummarySearchResultFromJSON, SummarySearchResultFromJSONTyped, SummarySearchResultToJSON, SummarySearchResultToJSONTyped, type SymbolHolder, SymbolHolderFromJSON, SymbolHolderFromJSONTyped, SymbolHolderToJSON, SymbolHolderToJSONTyped, TextApiResponse, type TooManyRequestsException, type TooManyRequestsExceptionCause, TooManyRequestsExceptionCauseFromJSON, TooManyRequestsExceptionCauseFromJSONTyped, type TooManyRequestsExceptionCauseStackTraceInner, TooManyRequestsExceptionCauseStackTraceInnerFromJSON, TooManyRequestsExceptionCauseStackTraceInnerFromJSONTyped, TooManyRequestsExceptionCauseStackTraceInnerToJSON, TooManyRequestsExceptionCauseStackTraceInnerToJSONTyped, TooManyRequestsExceptionCauseToJSON, TooManyRequestsExceptionCauseToJSONTyped, TooManyRequestsExceptionFromJSON, TooManyRequestsExceptionFromJSONTyped, TooManyRequestsExceptionStatusEnum, type TooManyRequestsExceptionSuppressedInner, TooManyRequestsExceptionSuppressedInnerFromJSON, TooManyRequestsExceptionSuppressedInnerFromJSONTyped, TooManyRequestsExceptionSuppressedInnerToJSON, TooManyRequestsExceptionSuppressedInnerToJSONTyped, TooManyRequestsExceptionToJSON, TooManyRequestsExceptionToJSONTyped, type TopicDto, TopicDtoFromJSON, TopicDtoFromJSONTyped, TopicDtoToJSON, TopicDtoToJSONTyped, type TopicHolder, TopicHolderFromJSON, TopicHolderFromJSONTyped, TopicHolderToJSON, TopicHolderToJSONTyped, type TopicLabels, TopicLabelsFromJSON, TopicLabelsFromJSONTyped, TopicLabelsToJSON, TopicLabelsToJSONTyped, type TopicSearchResult, TopicSearchResultFromJSON, TopicSearchResultFromJSONTyped, TopicSearchResultToJSON, TopicSearchResultToJSONTyped, V1Api, type V1ApiInterface, type VectorSearchArticlesRequest, type VectorSearchResult, VectorSearchResultFromJSON, VectorSearchResultFromJSONTyped, VectorSearchResultToJSON, VectorSearchResultToJSONTyped, VoidApiResponse, type WebResources, WebResourcesFromJSON, WebResourcesFromJSONTyped, WebResourcesToJSON, WebResourcesToJSONTyped, type WikidataDateHolder, WikidataDateHolderFromJSON, WikidataDateHolderFromJSONTyped, WikidataDateHolderToJSON, WikidataDateHolderToJSONTyped, type WikidataLabelHolder, WikidataLabelHolderFromJSON, WikidataLabelHolderFromJSONTyped, WikidataLabelHolderToJSON, WikidataLabelHolderToJSONTyped, type WikidataPoliticalPartyHolder, WikidataPoliticalPartyHolderFromJSON, WikidataPoliticalPartyHolderFromJSONTyped, WikidataPoliticalPartyHolderToJSON, WikidataPoliticalPartyHolderToJSONTyped, type WikidataPositionHolder, WikidataPositionHolderFromJSON, WikidataPositionHolderFromJSONTyped, WikidataPositionHolderToJSON, WikidataPositionHolderToJSONTyped, canConsumeForm, exists, instanceOfAllEndpointSortBy, instanceOfArticle, instanceOfArticleSearchFilter, instanceOfArticleSearchParams, instanceOfAuthException, instanceOfCategoryHolder, instanceOfCategoryWithScoreHolder, instanceOfCompany, instanceOfCompanyCount, instanceOfCompanyHolder, instanceOfCompanySearchResult, instanceOfCoordinate, instanceOfCoordinateFilter, instanceOfEntityHolder, instanceOfEventTypeHolder, instanceOfIdNameHolder, instanceOfIllegalParameterException, instanceOfImageHolder, instanceOfInternalErrorException, instanceOfJournalist, instanceOfJournalistSearchResult, instanceOfKeyPoint, instanceOfKeywordHolder, instanceOfLabelHolder, instanceOfLocationCount, instanceOfLocationHolder, instanceOfNameCount, instanceOfNewsCluster, instanceOfNotFoundException, instanceOfPeopleSearchResult, instanceOfPerson, instanceOfPersonCount, instanceOfPersonHolder, instanceOfPlace, instanceOfQuerySearchResult, instanceOfQuestion, instanceOfRecordStatHolder, instanceOfScoredArticle, instanceOfSentimentHolder, instanceOfSortBy, instanceOfSource, instanceOfSourceHolder, instanceOfSourceLocation, instanceOfSourceSearchResult, instanceOfSourceTopStatHolder, instanceOfStorySearchResult, instanceOfSummaryBody, instanceOfSummarySearchResult, instanceOfSymbolHolder, instanceOfTooManyRequestsException, instanceOfTooManyRequestsExceptionCause, instanceOfTooManyRequestsExceptionCauseStackTraceInner, instanceOfTooManyRequestsExceptionSuppressedInner, instanceOfTopicDto, instanceOfTopicHolder, instanceOfTopicLabels, instanceOfTopicSearchResult, instanceOfVectorSearchResult, instanceOfWebResources, instanceOfWikidataDateHolder, instanceOfWikidataLabelHolder, instanceOfWikidataPoliticalPartyHolder, instanceOfWikidataPositionHolder, mapValues, querystring };
6006
+ export { AllEndpointSortBy, AllEndpointSortByFromJSON, AllEndpointSortByFromJSONTyped, AllEndpointSortByToJSON, AllEndpointSortByToJSONTyped, type ApiResponse, type Article, ArticleFromJSON, ArticleFromJSONTyped, type ArticleSearchFilter, ArticleSearchFilterFromJSON, ArticleSearchFilterFromJSONTyped, ArticleSearchFilterToJSON, ArticleSearchFilterToJSONTyped, type ArticleSearchParams, ArticleSearchParamsFromJSON, ArticleSearchParamsFromJSONTyped, ArticleSearchParamsToJSON, ArticleSearchParamsToJSONTyped, ArticleToJSON, ArticleToJSONTyped, type AuthException, AuthExceptionFromJSON, AuthExceptionFromJSONTyped, AuthExceptionStatusCodeEnum, AuthExceptionToJSON, AuthExceptionToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, type CategoryHolder, CategoryHolderFromJSON, CategoryHolderFromJSONTyped, CategoryHolderToJSON, CategoryHolderToJSONTyped, type CategoryWithScoreHolder, CategoryWithScoreHolderFromJSON, CategoryWithScoreHolderFromJSONTyped, CategoryWithScoreHolderToJSON, CategoryWithScoreHolderToJSONTyped, type Company, type CompanyCount, CompanyCountFromJSON, CompanyCountFromJSONTyped, CompanyCountToJSON, CompanyCountToJSONTyped, CompanyFromJSON, CompanyFromJSONTyped, type CompanyHolder, CompanyHolderFromJSON, CompanyHolderFromJSONTyped, CompanyHolderToJSON, CompanyHolderToJSONTyped, type CompanySearchResult, CompanySearchResultFromJSON, CompanySearchResultFromJSONTyped, CompanySearchResultToJSON, CompanySearchResultToJSONTyped, CompanyToJSON, CompanyToJSONTyped, Configuration, type ConfigurationParameters, type Consume, type Coordinate, type CoordinateFilter, CoordinateFilterFromJSON, CoordinateFilterFromJSONTyped, CoordinateFilterToJSON, CoordinateFilterToJSONTyped, CoordinateFromJSON, CoordinateFromJSONTyped, CoordinateToJSON, CoordinateToJSONTyped, DefaultConfig, type EntityHolder, EntityHolderFromJSON, EntityHolderFromJSONTyped, EntityHolderToJSON, EntityHolderToJSONTyped, type ErrorContext, type EventTypeHolder, EventTypeHolderFromJSON, EventTypeHolderFromJSONTyped, EventTypeHolderToJSON, EventTypeHolderToJSONTyped, type FetchAPI, FetchError, type FetchParams, type GetJournalistByIdRequest, type HTTPBody, type HTTPHeaders, type HTTPMethod, type HTTPQuery, type HTTPRequestInit, type IdNameHolder, IdNameHolderFromJSON, IdNameHolderFromJSONTyped, IdNameHolderToJSON, IdNameHolderToJSONTyped, type IllegalParameterException, IllegalParameterExceptionFromJSON, IllegalParameterExceptionFromJSONTyped, IllegalParameterExceptionToJSON, IllegalParameterExceptionToJSONTyped, type ImageHolder, ImageHolderFromJSON, ImageHolderFromJSONTyped, ImageHolderToJSON, ImageHolderToJSONTyped, type InitOverrideFunction, type InternalErrorException, InternalErrorExceptionFromJSON, InternalErrorExceptionFromJSONTyped, InternalErrorExceptionToJSON, InternalErrorExceptionToJSONTyped, JSONApiResponse, type Journalist, JournalistFromJSON, JournalistFromJSONTyped, type JournalistSearchResult, JournalistSearchResultFromJSON, JournalistSearchResultFromJSONTyped, JournalistSearchResultToJSON, JournalistSearchResultToJSONTyped, JournalistToJSON, JournalistToJSONTyped, type Json, type KeyPoint, KeyPointFromJSON, KeyPointFromJSONTyped, KeyPointToJSON, KeyPointToJSONTyped, type KeywordHolder, KeywordHolderFromJSON, KeywordHolderFromJSONTyped, KeywordHolderToJSON, KeywordHolderToJSONTyped, type LabelHolder, LabelHolderFromJSON, LabelHolderFromJSONTyped, LabelHolderToJSON, LabelHolderToJSONTyped, type LocationCount, LocationCountFromJSON, LocationCountFromJSONTyped, LocationCountToJSON, LocationCountToJSONTyped, type LocationHolder, LocationHolderFromJSON, LocationHolderFromJSONTyped, LocationHolderToJSON, LocationHolderToJSONTyped, type Middleware, type ModelPropertyNaming, type NameCount, NameCountFromJSON, NameCountFromJSONTyped, NameCountToJSON, NameCountToJSONTyped, type NewsCluster, NewsClusterFromJSON, NewsClusterFromJSONTyped, NewsClusterToJSON, NewsClusterToJSONTyped, type NotFoundException, NotFoundExceptionFromJSON, NotFoundExceptionFromJSONTyped, NotFoundExceptionToJSON, NotFoundExceptionToJSONTyped, type PeopleSearchResult, PeopleSearchResultFromJSON, PeopleSearchResultFromJSONTyped, PeopleSearchResultToJSON, PeopleSearchResultToJSONTyped, type Person, type PersonCount, PersonCountFromJSON, PersonCountFromJSONTyped, PersonCountToJSON, PersonCountToJSONTyped, PersonFromJSON, PersonFromJSONTyped, type PersonHolder, PersonHolderFromJSON, PersonHolderFromJSONTyped, PersonHolderToJSON, PersonHolderToJSONTyped, PersonToJSON, PersonToJSONTyped, type Place, PlaceFromJSON, PlaceFromJSONTyped, PlaceToJSON, PlaceToJSONTyped, type QuerySearchResult, QuerySearchResultFromJSON, QuerySearchResultFromJSONTyped, QuerySearchResultToJSON, QuerySearchResultToJSONTyped, type Question, QuestionFromJSON, QuestionFromJSONTyped, QuestionToJSON, QuestionToJSONTyped, type RecordStatHolder, RecordStatHolderFromJSON, RecordStatHolderFromJSONTyped, RecordStatHolderToJSON, RecordStatHolderToJSONTyped, type RequestContext, type RequestOpts, RequiredError, type ResponseContext, ResponseError, type ResponseTransformer, type ScoredArticle, ScoredArticleFromJSON, ScoredArticleFromJSONTyped, ScoredArticleToJSON, ScoredArticleToJSONTyped, type SearchArticlesRequest, type SearchCompaniesRequest, type SearchJournalistsRequest, type SearchPeopleRequest, type SearchSourcesRequest, type SearchStoriesRequest, type SearchSummarizerRequest, type SearchTopicsRequest, type SentimentHolder, SentimentHolderFromJSON, SentimentHolderFromJSONTyped, SentimentHolderToJSON, SentimentHolderToJSONTyped, SortBy, SortByFromJSON, SortByFromJSONTyped, SortByToJSON, SortByToJSONTyped, type Source, SourceFromJSON, SourceFromJSONTyped, type SourceHolder, SourceHolderFromJSON, SourceHolderFromJSONTyped, SourceHolderToJSON, SourceHolderToJSONTyped, type SourceLocation, SourceLocationFromJSON, SourceLocationFromJSONTyped, SourceLocationToJSON, SourceLocationToJSONTyped, type SourceSearchResult, SourceSearchResultFromJSON, SourceSearchResultFromJSONTyped, SourceSearchResultToJSON, SourceSearchResultToJSONTyped, SourceToJSON, SourceToJSONTyped, type SourceTopStatHolder, SourceTopStatHolderFromJSON, SourceTopStatHolderFromJSONTyped, SourceTopStatHolderToJSON, SourceTopStatHolderToJSONTyped, type StorySearchResult, StorySearchResultFromJSON, StorySearchResultFromJSONTyped, StorySearchResultToJSON, StorySearchResultToJSONTyped, type SummaryBody, SummaryBodyFromJSON, SummaryBodyFromJSONTyped, SummaryBodyMethodEnum, SummaryBodyModelEnum, SummaryBodySummarizeFieldsEnum, SummaryBodyToJSON, SummaryBodyToJSONTyped, type SummarySearchResult, SummarySearchResultFromJSON, SummarySearchResultFromJSONTyped, SummarySearchResultToJSON, SummarySearchResultToJSONTyped, type SymbolHolder, SymbolHolderFromJSON, SymbolHolderFromJSONTyped, SymbolHolderToJSON, SymbolHolderToJSONTyped, TextApiResponse, type TooManyRequestsException, type TooManyRequestsExceptionCause, TooManyRequestsExceptionCauseFromJSON, TooManyRequestsExceptionCauseFromJSONTyped, type TooManyRequestsExceptionCauseStackTraceInner, TooManyRequestsExceptionCauseStackTraceInnerFromJSON, TooManyRequestsExceptionCauseStackTraceInnerFromJSONTyped, TooManyRequestsExceptionCauseStackTraceInnerToJSON, TooManyRequestsExceptionCauseStackTraceInnerToJSONTyped, TooManyRequestsExceptionCauseToJSON, TooManyRequestsExceptionCauseToJSONTyped, TooManyRequestsExceptionFromJSON, TooManyRequestsExceptionFromJSONTyped, TooManyRequestsExceptionStatusEnum, type TooManyRequestsExceptionSuppressedInner, TooManyRequestsExceptionSuppressedInnerFromJSON, TooManyRequestsExceptionSuppressedInnerFromJSONTyped, TooManyRequestsExceptionSuppressedInnerToJSON, TooManyRequestsExceptionSuppressedInnerToJSONTyped, TooManyRequestsExceptionToJSON, TooManyRequestsExceptionToJSONTyped, type TopicDto, TopicDtoFromJSON, TopicDtoFromJSONTyped, TopicDtoToJSON, TopicDtoToJSONTyped, type TopicHolder, TopicHolderFromJSON, TopicHolderFromJSONTyped, TopicHolderToJSON, TopicHolderToJSONTyped, type TopicLabels, TopicLabelsFromJSON, TopicLabelsFromJSONTyped, TopicLabelsToJSON, TopicLabelsToJSONTyped, type TopicSearchResult, TopicSearchResultFromJSON, TopicSearchResultFromJSONTyped, TopicSearchResultToJSON, TopicSearchResultToJSONTyped, V1Api, type V1ApiInterface, type VectorSearchArticlesRequest, type VectorSearchResult, VectorSearchResultFromJSON, VectorSearchResultFromJSONTyped, VectorSearchResultToJSON, VectorSearchResultToJSONTyped, VoidApiResponse, type WebResources, WebResourcesFromJSON, WebResourcesFromJSONTyped, WebResourcesToJSON, WebResourcesToJSONTyped, type WikidataDateHolder, WikidataDateHolderFromJSON, WikidataDateHolderFromJSONTyped, WikidataDateHolderToJSON, WikidataDateHolderToJSONTyped, type WikidataLabelHolder, WikidataLabelHolderFromJSON, WikidataLabelHolderFromJSONTyped, WikidataLabelHolderToJSON, WikidataLabelHolderToJSONTyped, type WikidataPoliticalPartyHolder, WikidataPoliticalPartyHolderFromJSON, WikidataPoliticalPartyHolderFromJSONTyped, WikidataPoliticalPartyHolderToJSON, WikidataPoliticalPartyHolderToJSONTyped, type WikidataPositionHolder, WikidataPositionHolderFromJSON, WikidataPositionHolderFromJSONTyped, WikidataPositionHolderToJSON, WikidataPositionHolderToJSONTyped, canConsumeForm, exists, instanceOfAllEndpointSortBy, instanceOfArticle, instanceOfArticleSearchFilter, instanceOfArticleSearchParams, instanceOfAuthException, instanceOfCategoryHolder, instanceOfCategoryWithScoreHolder, instanceOfCompany, instanceOfCompanyCount, instanceOfCompanyHolder, instanceOfCompanySearchResult, instanceOfCoordinate, instanceOfCoordinateFilter, instanceOfEntityHolder, instanceOfEventTypeHolder, instanceOfIdNameHolder, instanceOfIllegalParameterException, instanceOfImageHolder, instanceOfInternalErrorException, instanceOfJournalist, instanceOfJournalistSearchResult, instanceOfKeyPoint, instanceOfKeywordHolder, instanceOfLabelHolder, instanceOfLocationCount, instanceOfLocationHolder, instanceOfNameCount, instanceOfNewsCluster, instanceOfNotFoundException, instanceOfPeopleSearchResult, instanceOfPerson, instanceOfPersonCount, instanceOfPersonHolder, instanceOfPlace, instanceOfQuerySearchResult, instanceOfQuestion, instanceOfRecordStatHolder, instanceOfScoredArticle, instanceOfSentimentHolder, instanceOfSortBy, instanceOfSource, instanceOfSourceHolder, instanceOfSourceLocation, instanceOfSourceSearchResult, instanceOfSourceTopStatHolder, instanceOfStorySearchResult, instanceOfSummaryBody, instanceOfSummarySearchResult, instanceOfSymbolHolder, instanceOfTooManyRequestsException, instanceOfTooManyRequestsExceptionCause, instanceOfTooManyRequestsExceptionCauseStackTraceInner, instanceOfTooManyRequestsExceptionSuppressedInner, instanceOfTopicDto, instanceOfTopicHolder, instanceOfTopicLabels, instanceOfTopicSearchResult, instanceOfVectorSearchResult, instanceOfWebResources, instanceOfWikidataDateHolder, instanceOfWikidataLabelHolder, instanceOfWikidataPoliticalPartyHolder, instanceOfWikidataPositionHolder, mapValues, querystring };