exa-js 1.8.19 → 1.8.20
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.mts +38 -16
- package/dist/index.d.ts +38 -16
- package/dist/index.js +8 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +8 -3
- package/dist/index.mjs.map +1 -1
- package/package.json +4 -2
package/dist/index.d.mts
CHANGED
|
@@ -289,7 +289,8 @@ interface components$1 {
|
|
|
289
289
|
*
|
|
290
290
|
* Any URLs provided will be crawled and used as additional context for the search. */
|
|
291
291
|
query: string;
|
|
292
|
-
/** @description Whether to
|
|
292
|
+
/** @description Whether to provide an estimate of how many total relevant results could exist for this search.
|
|
293
|
+
* Result of the analysis will be available in the `recall` field within the search request. */
|
|
293
294
|
recall?: boolean;
|
|
294
295
|
};
|
|
295
296
|
};
|
|
@@ -331,7 +332,8 @@ interface components$1 {
|
|
|
331
332
|
*
|
|
332
333
|
* Any URLs provided will be crawled and used as additional context for the search. */
|
|
333
334
|
query: string;
|
|
334
|
-
/** @description Whether to
|
|
335
|
+
/** @description Whether to provide an estimate of how many total relevant results could exist for this search.
|
|
336
|
+
* Result of the analysis will be available in the `recall` field within the search request. */
|
|
335
337
|
recall?: boolean;
|
|
336
338
|
};
|
|
337
339
|
/** Custom */
|
|
@@ -360,7 +362,10 @@ interface components$1 {
|
|
|
360
362
|
snippet: string | null;
|
|
361
363
|
/** @description The title of the reference */
|
|
362
364
|
title: string | null;
|
|
363
|
-
/**
|
|
365
|
+
/**
|
|
366
|
+
* Format: uri
|
|
367
|
+
* @description The URL of the reference
|
|
368
|
+
*/
|
|
364
369
|
url: string;
|
|
365
370
|
}[];
|
|
366
371
|
/** @description The result of the enrichment. */
|
|
@@ -697,7 +702,7 @@ interface components$1 {
|
|
|
697
702
|
* @default append
|
|
698
703
|
* @enum {string}
|
|
699
704
|
*/
|
|
700
|
-
behavior:
|
|
705
|
+
behavior: WebsetSearchBehavior;
|
|
701
706
|
/** @description The maximum number of results to find */
|
|
702
707
|
count: number;
|
|
703
708
|
/** @description The criteria to search for. By default, the criteria from the last search is used. */
|
|
@@ -777,7 +782,7 @@ interface components$1 {
|
|
|
777
782
|
* @default append
|
|
778
783
|
* @enum {string}
|
|
779
784
|
*/
|
|
780
|
-
behavior:
|
|
785
|
+
behavior: WebsetSearchBehavior;
|
|
781
786
|
/** @description The maximum number of results to find */
|
|
782
787
|
count: number;
|
|
783
788
|
/** @description The criteria to search for. By default, the criteria from the last search is used. */
|
|
@@ -828,6 +833,8 @@ interface components$1 {
|
|
|
828
833
|
* @description When the run failed
|
|
829
834
|
*/
|
|
830
835
|
failedAt: string | null;
|
|
836
|
+
/** @description The reason the run failed */
|
|
837
|
+
failedReason: string | null;
|
|
831
838
|
/** @description The unique identifier for the Monitor Run */
|
|
832
839
|
id: string;
|
|
833
840
|
/** @description The monitor that the run is associated with */
|
|
@@ -1022,6 +1029,8 @@ interface components$1 {
|
|
|
1022
1029
|
status: WebsetStatus;
|
|
1023
1030
|
/** @description The Streams for the Webset. */
|
|
1024
1031
|
streams: unknown[];
|
|
1032
|
+
/** @description The title of the webset */
|
|
1033
|
+
title: string | null;
|
|
1025
1034
|
/**
|
|
1026
1035
|
* Format: date-time
|
|
1027
1036
|
* @description The date and time the webset was updated
|
|
@@ -1216,7 +1225,10 @@ interface components$1 {
|
|
|
1216
1225
|
snippet: string | null;
|
|
1217
1226
|
/** @description The title of the reference */
|
|
1218
1227
|
title: string | null;
|
|
1219
|
-
/**
|
|
1228
|
+
/**
|
|
1229
|
+
* Format: uri
|
|
1230
|
+
* @description The URL of the reference
|
|
1231
|
+
*/
|
|
1220
1232
|
url: string;
|
|
1221
1233
|
}[];
|
|
1222
1234
|
/**
|
|
@@ -1529,10 +1541,6 @@ declare enum MonitorStatus {
|
|
|
1529
1541
|
enabled = "enabled",
|
|
1530
1542
|
disabled = "disabled"
|
|
1531
1543
|
}
|
|
1532
|
-
declare enum MonitorBehaviorConfigBehavior {
|
|
1533
|
-
override = "override",
|
|
1534
|
-
append = "append"
|
|
1535
|
-
}
|
|
1536
1544
|
declare enum MonitorRunObject {
|
|
1537
1545
|
monitor_run = "monitor_run"
|
|
1538
1546
|
}
|
|
@@ -1540,7 +1548,8 @@ declare enum MonitorRunStatus {
|
|
|
1540
1548
|
created = "created",
|
|
1541
1549
|
running = "running",
|
|
1542
1550
|
completed = "completed",
|
|
1543
|
-
canceled = "canceled"
|
|
1551
|
+
canceled = "canceled",
|
|
1552
|
+
failed = "failed"
|
|
1544
1553
|
}
|
|
1545
1554
|
declare enum MonitorRunType {
|
|
1546
1555
|
search = "search",
|
|
@@ -1798,6 +1807,15 @@ declare class ImportsClient extends WebsetsBaseClient {
|
|
|
1798
1807
|
* Client for managing Webset Items
|
|
1799
1808
|
*/
|
|
1800
1809
|
|
|
1810
|
+
/**
|
|
1811
|
+
* Options for listing webset items
|
|
1812
|
+
*/
|
|
1813
|
+
interface ListWebsetItemsOptions extends PaginationParams {
|
|
1814
|
+
/**
|
|
1815
|
+
* The id of the source to filter items by
|
|
1816
|
+
*/
|
|
1817
|
+
sourceId?: string;
|
|
1818
|
+
}
|
|
1801
1819
|
/**
|
|
1802
1820
|
* Client for managing Webset Items
|
|
1803
1821
|
*/
|
|
@@ -1805,24 +1823,24 @@ declare class WebsetItemsClient extends WebsetsBaseClient {
|
|
|
1805
1823
|
/**
|
|
1806
1824
|
* List all Items for a Webset
|
|
1807
1825
|
* @param websetId The ID of the Webset
|
|
1808
|
-
* @param params - Optional pagination parameters
|
|
1826
|
+
* @param params - Optional pagination and filtering parameters
|
|
1809
1827
|
* @returns A promise that resolves with the list of Items
|
|
1810
1828
|
*/
|
|
1811
|
-
list(websetId: string, params?:
|
|
1829
|
+
list(websetId: string, params?: ListWebsetItemsOptions): Promise<ListWebsetItemResponse>;
|
|
1812
1830
|
/**
|
|
1813
1831
|
* Iterate through all Items in a Webset, handling pagination automatically
|
|
1814
1832
|
* @param websetId The ID of the Webset
|
|
1815
1833
|
* @param options Pagination options
|
|
1816
1834
|
* @returns Async generator of Webset Items
|
|
1817
1835
|
*/
|
|
1818
|
-
listAll(websetId: string, options?:
|
|
1836
|
+
listAll(websetId: string, options?: ListWebsetItemsOptions): AsyncGenerator<WebsetItem>;
|
|
1819
1837
|
/**
|
|
1820
1838
|
* Collect all items from a Webset into an array
|
|
1821
1839
|
* @param websetId The ID of the Webset
|
|
1822
1840
|
* @param options Pagination options
|
|
1823
1841
|
* @returns Promise resolving to an array of all Webset Items
|
|
1824
1842
|
*/
|
|
1825
|
-
getAll(websetId: string, options?:
|
|
1843
|
+
getAll(websetId: string, options?: ListWebsetItemsOptions): Promise<WebsetItem[]>;
|
|
1826
1844
|
/**
|
|
1827
1845
|
* Get an Item by ID
|
|
1828
1846
|
* @param websetId The ID of the Webset
|
|
@@ -1961,6 +1979,10 @@ interface ListWebhookAttemptsOptions extends PaginationParams {
|
|
|
1961
1979
|
* The type of event to filter by
|
|
1962
1980
|
*/
|
|
1963
1981
|
eventType?: EventType;
|
|
1982
|
+
/**
|
|
1983
|
+
* Filter attempts by their success status
|
|
1984
|
+
*/
|
|
1985
|
+
successful?: boolean;
|
|
1964
1986
|
}
|
|
1965
1987
|
/**
|
|
1966
1988
|
* Client for managing Webset Webhooks
|
|
@@ -3118,4 +3140,4 @@ declare class Exa {
|
|
|
3118
3140
|
private parseSSEStream;
|
|
3119
3141
|
}
|
|
3120
3142
|
|
|
3121
|
-
export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
|
|
3143
|
+
export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetItemsOptions, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -289,7 +289,8 @@ interface components$1 {
|
|
|
289
289
|
*
|
|
290
290
|
* Any URLs provided will be crawled and used as additional context for the search. */
|
|
291
291
|
query: string;
|
|
292
|
-
/** @description Whether to
|
|
292
|
+
/** @description Whether to provide an estimate of how many total relevant results could exist for this search.
|
|
293
|
+
* Result of the analysis will be available in the `recall` field within the search request. */
|
|
293
294
|
recall?: boolean;
|
|
294
295
|
};
|
|
295
296
|
};
|
|
@@ -331,7 +332,8 @@ interface components$1 {
|
|
|
331
332
|
*
|
|
332
333
|
* Any URLs provided will be crawled and used as additional context for the search. */
|
|
333
334
|
query: string;
|
|
334
|
-
/** @description Whether to
|
|
335
|
+
/** @description Whether to provide an estimate of how many total relevant results could exist for this search.
|
|
336
|
+
* Result of the analysis will be available in the `recall` field within the search request. */
|
|
335
337
|
recall?: boolean;
|
|
336
338
|
};
|
|
337
339
|
/** Custom */
|
|
@@ -360,7 +362,10 @@ interface components$1 {
|
|
|
360
362
|
snippet: string | null;
|
|
361
363
|
/** @description The title of the reference */
|
|
362
364
|
title: string | null;
|
|
363
|
-
/**
|
|
365
|
+
/**
|
|
366
|
+
* Format: uri
|
|
367
|
+
* @description The URL of the reference
|
|
368
|
+
*/
|
|
364
369
|
url: string;
|
|
365
370
|
}[];
|
|
366
371
|
/** @description The result of the enrichment. */
|
|
@@ -697,7 +702,7 @@ interface components$1 {
|
|
|
697
702
|
* @default append
|
|
698
703
|
* @enum {string}
|
|
699
704
|
*/
|
|
700
|
-
behavior:
|
|
705
|
+
behavior: WebsetSearchBehavior;
|
|
701
706
|
/** @description The maximum number of results to find */
|
|
702
707
|
count: number;
|
|
703
708
|
/** @description The criteria to search for. By default, the criteria from the last search is used. */
|
|
@@ -777,7 +782,7 @@ interface components$1 {
|
|
|
777
782
|
* @default append
|
|
778
783
|
* @enum {string}
|
|
779
784
|
*/
|
|
780
|
-
behavior:
|
|
785
|
+
behavior: WebsetSearchBehavior;
|
|
781
786
|
/** @description The maximum number of results to find */
|
|
782
787
|
count: number;
|
|
783
788
|
/** @description The criteria to search for. By default, the criteria from the last search is used. */
|
|
@@ -828,6 +833,8 @@ interface components$1 {
|
|
|
828
833
|
* @description When the run failed
|
|
829
834
|
*/
|
|
830
835
|
failedAt: string | null;
|
|
836
|
+
/** @description The reason the run failed */
|
|
837
|
+
failedReason: string | null;
|
|
831
838
|
/** @description The unique identifier for the Monitor Run */
|
|
832
839
|
id: string;
|
|
833
840
|
/** @description The monitor that the run is associated with */
|
|
@@ -1022,6 +1029,8 @@ interface components$1 {
|
|
|
1022
1029
|
status: WebsetStatus;
|
|
1023
1030
|
/** @description The Streams for the Webset. */
|
|
1024
1031
|
streams: unknown[];
|
|
1032
|
+
/** @description The title of the webset */
|
|
1033
|
+
title: string | null;
|
|
1025
1034
|
/**
|
|
1026
1035
|
* Format: date-time
|
|
1027
1036
|
* @description The date and time the webset was updated
|
|
@@ -1216,7 +1225,10 @@ interface components$1 {
|
|
|
1216
1225
|
snippet: string | null;
|
|
1217
1226
|
/** @description The title of the reference */
|
|
1218
1227
|
title: string | null;
|
|
1219
|
-
/**
|
|
1228
|
+
/**
|
|
1229
|
+
* Format: uri
|
|
1230
|
+
* @description The URL of the reference
|
|
1231
|
+
*/
|
|
1220
1232
|
url: string;
|
|
1221
1233
|
}[];
|
|
1222
1234
|
/**
|
|
@@ -1529,10 +1541,6 @@ declare enum MonitorStatus {
|
|
|
1529
1541
|
enabled = "enabled",
|
|
1530
1542
|
disabled = "disabled"
|
|
1531
1543
|
}
|
|
1532
|
-
declare enum MonitorBehaviorConfigBehavior {
|
|
1533
|
-
override = "override",
|
|
1534
|
-
append = "append"
|
|
1535
|
-
}
|
|
1536
1544
|
declare enum MonitorRunObject {
|
|
1537
1545
|
monitor_run = "monitor_run"
|
|
1538
1546
|
}
|
|
@@ -1540,7 +1548,8 @@ declare enum MonitorRunStatus {
|
|
|
1540
1548
|
created = "created",
|
|
1541
1549
|
running = "running",
|
|
1542
1550
|
completed = "completed",
|
|
1543
|
-
canceled = "canceled"
|
|
1551
|
+
canceled = "canceled",
|
|
1552
|
+
failed = "failed"
|
|
1544
1553
|
}
|
|
1545
1554
|
declare enum MonitorRunType {
|
|
1546
1555
|
search = "search",
|
|
@@ -1798,6 +1807,15 @@ declare class ImportsClient extends WebsetsBaseClient {
|
|
|
1798
1807
|
* Client for managing Webset Items
|
|
1799
1808
|
*/
|
|
1800
1809
|
|
|
1810
|
+
/**
|
|
1811
|
+
* Options for listing webset items
|
|
1812
|
+
*/
|
|
1813
|
+
interface ListWebsetItemsOptions extends PaginationParams {
|
|
1814
|
+
/**
|
|
1815
|
+
* The id of the source to filter items by
|
|
1816
|
+
*/
|
|
1817
|
+
sourceId?: string;
|
|
1818
|
+
}
|
|
1801
1819
|
/**
|
|
1802
1820
|
* Client for managing Webset Items
|
|
1803
1821
|
*/
|
|
@@ -1805,24 +1823,24 @@ declare class WebsetItemsClient extends WebsetsBaseClient {
|
|
|
1805
1823
|
/**
|
|
1806
1824
|
* List all Items for a Webset
|
|
1807
1825
|
* @param websetId The ID of the Webset
|
|
1808
|
-
* @param params - Optional pagination parameters
|
|
1826
|
+
* @param params - Optional pagination and filtering parameters
|
|
1809
1827
|
* @returns A promise that resolves with the list of Items
|
|
1810
1828
|
*/
|
|
1811
|
-
list(websetId: string, params?:
|
|
1829
|
+
list(websetId: string, params?: ListWebsetItemsOptions): Promise<ListWebsetItemResponse>;
|
|
1812
1830
|
/**
|
|
1813
1831
|
* Iterate through all Items in a Webset, handling pagination automatically
|
|
1814
1832
|
* @param websetId The ID of the Webset
|
|
1815
1833
|
* @param options Pagination options
|
|
1816
1834
|
* @returns Async generator of Webset Items
|
|
1817
1835
|
*/
|
|
1818
|
-
listAll(websetId: string, options?:
|
|
1836
|
+
listAll(websetId: string, options?: ListWebsetItemsOptions): AsyncGenerator<WebsetItem>;
|
|
1819
1837
|
/**
|
|
1820
1838
|
* Collect all items from a Webset into an array
|
|
1821
1839
|
* @param websetId The ID of the Webset
|
|
1822
1840
|
* @param options Pagination options
|
|
1823
1841
|
* @returns Promise resolving to an array of all Webset Items
|
|
1824
1842
|
*/
|
|
1825
|
-
getAll(websetId: string, options?:
|
|
1843
|
+
getAll(websetId: string, options?: ListWebsetItemsOptions): Promise<WebsetItem[]>;
|
|
1826
1844
|
/**
|
|
1827
1845
|
* Get an Item by ID
|
|
1828
1846
|
* @param websetId The ID of the Webset
|
|
@@ -1961,6 +1979,10 @@ interface ListWebhookAttemptsOptions extends PaginationParams {
|
|
|
1961
1979
|
* The type of event to filter by
|
|
1962
1980
|
*/
|
|
1963
1981
|
eventType?: EventType;
|
|
1982
|
+
/**
|
|
1983
|
+
* Filter attempts by their success status
|
|
1984
|
+
*/
|
|
1985
|
+
successful?: boolean;
|
|
1964
1986
|
}
|
|
1965
1987
|
/**
|
|
1966
1988
|
* Client for managing Webset Webhooks
|
|
@@ -3118,4 +3140,4 @@ declare class Exa {
|
|
|
3118
3140
|
private parseSSEStream;
|
|
3119
3141
|
}
|
|
3120
3142
|
|
|
3121
|
-
export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
|
|
3143
|
+
export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetItemsOptions, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
|
package/dist/index.js
CHANGED
|
@@ -313,6 +313,7 @@ var MonitorRunStatus = /* @__PURE__ */ ((MonitorRunStatus2) => {
|
|
|
313
313
|
MonitorRunStatus2["running"] = "running";
|
|
314
314
|
MonitorRunStatus2["completed"] = "completed";
|
|
315
315
|
MonitorRunStatus2["canceled"] = "canceled";
|
|
316
|
+
MonitorRunStatus2["failed"] = "failed";
|
|
316
317
|
return MonitorRunStatus2;
|
|
317
318
|
})(MonitorRunStatus || {});
|
|
318
319
|
var MonitorRunType = /* @__PURE__ */ ((MonitorRunType2) => {
|
|
@@ -536,11 +537,14 @@ var WebsetItemsClient = class extends WebsetsBaseClient {
|
|
|
536
537
|
/**
|
|
537
538
|
* List all Items for a Webset
|
|
538
539
|
* @param websetId The ID of the Webset
|
|
539
|
-
* @param params - Optional pagination parameters
|
|
540
|
+
* @param params - Optional pagination and filtering parameters
|
|
540
541
|
* @returns A promise that resolves with the list of Items
|
|
541
542
|
*/
|
|
542
543
|
list(websetId, params) {
|
|
543
|
-
const queryParams =
|
|
544
|
+
const queryParams = {
|
|
545
|
+
...this.buildPaginationParams(params),
|
|
546
|
+
sourceId: params?.sourceId
|
|
547
|
+
};
|
|
544
548
|
return this.request(
|
|
545
549
|
`/v0/websets/${websetId}/items`,
|
|
546
550
|
"GET",
|
|
@@ -828,7 +832,8 @@ var WebsetWebhooksClient = class extends WebsetsBaseClient {
|
|
|
828
832
|
const params = {
|
|
829
833
|
cursor: options?.cursor,
|
|
830
834
|
limit: options?.limit,
|
|
831
|
-
eventType: options?.eventType
|
|
835
|
+
eventType: options?.eventType,
|
|
836
|
+
successful: options?.successful
|
|
832
837
|
};
|
|
833
838
|
return this.request(
|
|
834
839
|
`/v0/webhooks/${id}/attempts`,
|