@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.
81 lines • 3.55 kB
JavaScript
import API from '../../APICore.js';
import Resource from '../Resource.js';
import Members from './Members/Members.js';
import { PrivilegeFilterType, } from './OrganizationInterfaces.js';
export default class Organization extends Resource {
api;
serverlessApi;
static baseUrl = '/rest/organizations';
members;
constructor(api, serverlessApi) {
super(api, serverlessApi);
this.api = api;
this.serverlessApi = serverlessApi;
this.members = new Members(api, serverlessApi);
}
list(options) {
return this.api.get(options ? this.buildPath(Organization.baseUrl, options) : Organization.baseUrl);
}
create(options) {
return this.api.post(this.buildPath(Organization.baseUrl, options));
}
delete(organizationId) {
return this.api.delete(`${Organization.baseUrl}/${organizationId}`);
}
get(organizationId, options) {
return this.api.get(this.buildPath(`${Organization.baseUrl}/${organizationId}`, options));
}
update(organization) {
return this.api.put(`${Organization.baseUrl}/${organization.id}`, organization);
}
updateSupportActivated(organizationId, supportActivated) {
return this.api.put(`${Organization.baseUrl}/${organizationId}/support?activate=${supportActivated}`);
}
status(organizationId = API.orgPlaceholder) {
return this.api.get(`${Organization.baseUrl}/${organizationId}/status`);
}
/**
* Pauses an [organization](https://docs.coveo.com/en/222/).
* Required privilege: Organization - Edit
* @param organizationId
*/
pause(organizationId = API.orgPlaceholder) {
return this.api.post(`${Organization.baseUrl}/${organizationId}/pause`);
}
/**
* Resumes a paused [organization](https://docs.coveo.com/en/222/).
* Required privilege: Organization - Edit
* @param organizationId
*/
resume(organizationId = API.orgPlaceholder) {
return this.api.post(`${Organization.baseUrl}/${organizationId}/resume`);
}
updateAdditionalInformation(additionalInformationObj) {
return this.api.put(`${Organization.baseUrl}/${API.orgPlaceholder}/additionalinformation`, additionalInformationObj);
}
getAdditionalInformation(organizationId = API.orgPlaceholder) {
return this.api.get(`${Organization.baseUrl}/${organizationId}/additionalinformation`);
}
updateExperimentalStatus(allowed = true) {
return this.api.put(`${Organization.baseUrl}/${API.orgPlaceholder}/configuration/servingExperiment?allowed=${allowed}`);
}
listPrivileges() {
return this.api.get(`${Organization.baseUrl}/${API.orgPlaceholder}/privileges`);
}
listMyPrivileges() {
return this.api.get(`${Organization.baseUrl}/${API.orgPlaceholder}/privileges/me`);
}
listApiKeysPrivileges(options = { filter: PrivilegeFilterType.ALL }) {
return this.api.get(this.buildPath(`${Organization.baseUrl}/${API.orgPlaceholder}/privileges/apikeys`, options));
}
getDefinition() {
return this.api.get(`${Organization.baseUrl}/${API.orgPlaceholder}/definition`);
}
updateDefinition(organizationDefinition) {
return this.api.put(`${Organization.baseUrl}/${API.orgPlaceholder}/definition`, organizationDefinition);
}
getAllowedAuthenticationProviders(organizationId = API.orgPlaceholder) {
return this.api.get(`${Organization.baseUrl}/${organizationId}/authproviders/allowed`);
}
}
//# sourceMappingURL=Organization.js.map