@coveo/platform-client
Version:
The main goal of this package is to provide an easy to configure and straightforward way of querying Coveo Cloud APIs using JavaScript.
129 lines • 5.34 kB
JavaScript
import API from '../../APICore.js';
import Resource from '../Resource.js';
import SourcesDatasets from './SourcesDatasets/SourcesDatasets.js';
import SourcesFeedback from './SourcesFeedback/SourcesFeedback.js';
import SourcesFields from './SourcesFields/SourcesFields.js';
import SourcesMappings from './SourcesMappings/SourcesMappings.js';
import SourcesMetadata from './SourcesMetadata/SourcesMetadata.js';
export default class Sources extends Resource {
api;
serverlessApi;
static baseUrl = `/rest/organizations/${API.orgPlaceholder}/sources`;
field;
mappings;
datasets;
metadata;
feedback;
constructor(api, serverlessApi) {
super(api, serverlessApi);
this.api = api;
this.serverlessApi = serverlessApi;
this.field = new SourcesFields(api, serverlessApi);
this.mappings = new SourcesMappings(api, serverlessApi);
this.datasets = new SourcesDatasets(api, serverlessApi);
this.metadata = new SourcesMetadata(api, serverlessApi);
this.feedback = new SourcesFeedback(api, serverlessApi);
}
create(source, options) {
return this.api.post(this.buildPath(Sources.baseUrl, options), source);
}
list(params) {
return this.api.get(this.buildPath(`${Sources.baseUrl}/pages`, params));
}
/**
* @param params
* @description New API resource for the list of sources
* @experimental
*/
listOperationalStatus(params) {
return this.api.get(this.buildPath(`${Sources.baseUrl}/sourceoperationalstatus`, params));
}
createFromRaw(rawSourceConfig, options) {
return this.api.post(this.buildPath(`${Sources.baseUrl}/raw`, options), rawSourceConfig);
}
getDefaultDocumentConfiguration(params) {
return this.api.get(this.buildPath(`${Sources.baseUrl}/document/configuration/default`, params));
}
delete(sourceId) {
return this.api.delete(`${Sources.baseUrl}/${sourceId}`);
}
get(sourceId) {
return this.api.get(`${Sources.baseUrl}/${sourceId}`);
}
update(sourceId, source, options) {
return this.api.put(this.buildPath(`${Sources.baseUrl}/${sourceId}`, options), source);
}
applyChanges(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/applyChanges`);
}
isDedicated(sourceId) {
return this.api.get(`${Sources.baseUrl}/${sourceId}/dedicated`);
}
setDedicated(sourceId, enabled) {
return this.api.put(this.buildPath(`${Sources.baseUrl}/${sourceId}/dedicated`, { enabled }), {});
}
dumpRefresh(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/dump`);
}
duplicate(sourceId, newSourceName, logicalIndexId) {
return this.api.post(this.buildPath(`${Sources.baseUrl}/${sourceId}/duplicate`, { newSourceName, logicalIndexId }));
}
evictCachedCrawlerConfig(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/evictCachedCrawlerConfig`);
}
fullRefresh(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/fullRefresh`);
}
incrementalRefresh(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/incrementalRefresh`);
}
listSourceItemTypes(sourceId) {
return this.api.get(`${Sources.baseUrl}/${sourceId}/itemTypes`);
}
getLightSource(sourceId) {
return this.api.get(`${Sources.baseUrl}/${sourceId}/light`);
}
pauseRefresh(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/pauseRefresh`);
}
setPushRefreshStatus(sourceId, activityOperation) {
return this.api.post(this.buildPath(`${Sources.baseUrl}/${sourceId}/pushRefresh`, { activityOperation }));
}
getRawSource(sourceId) {
return this.api.get(`${Sources.baseUrl}/${sourceId}/raw`);
}
updateRawSource(sourceId, platformSourceConfig, options) {
return this.api.put(this.buildPath(`${Sources.baseUrl}/${sourceId}/raw`, options), platformSourceConfig);
}
rebuild(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/rebuild`);
}
resumeRefresh(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/resumeRefresh`);
}
retryCreation(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/retryCreation`);
}
listSchedules(sourceId) {
return this.api.get(`${Sources.baseUrl}/${sourceId}/schedules`);
}
createSchedule(sourceId, sourceSchedule) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/schedules`, sourceSchedule);
}
deleteSchedule(sourceId, scheduleId) {
return this.api.delete(`${Sources.baseUrl}/${sourceId}/schedules/${scheduleId}`);
}
updateSchedule(sourceId, scheduleId, sourceSchedule) {
return this.api.put(`${Sources.baseUrl}/${sourceId}/schedules/${scheduleId}`, sourceSchedule);
}
startRefresh(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/startRefresh`);
}
stopRefresh(sourceId) {
return this.api.post(`${Sources.baseUrl}/${sourceId}/stopRefresh`);
}
abortTaskForActivity(sourceId, activityId) {
return this.api.post(this.buildPath(`${Sources.baseUrl}/${sourceId}/tasks/abort`, { activityId }));
}
}
//# sourceMappingURL=Sources.js.map