@coveo/platform-client 35.0.0

package/dist/definitions/resources/Search/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Search';
+export * from './SearchInterfaces';

package/dist/definitions/resources/SearchInterfaces/SearchInterfaces.d.ts

@@ -0,0 +1,17 @@
+import { New, PageModel } from '../../Entry';
+import Resource from '../Resource';
+import { IAccesses, IListSearchInterfacesParameters, ISearchInterfaceConfiguration, ISearchInterfaceConfigurationResponse, IManifestParameters, IManifestResponse } from './SearchInterfaces.model';
+export default class SearchInterfaces extends Resource {
+    static baseUrl: string;
+    list(options: IListSearchInterfacesParameters): Promise<PageModel<ISearchInterfaceConfigurationResponse>>;
+    create(searchInterfaceConfig: New<ISearchInterfaceConfiguration>): Promise<ISearchInterfaceConfigurationResponse>;
+    get(searchInterfaceConfigId: string): Promise<ISearchInterfaceConfigurationResponse>;
+    update(searchInterfaceConfig: ISearchInterfaceConfiguration): Promise<ISearchInterfaceConfigurationResponse>;
+    delete(searchInterfaceConfigId: string): Promise<Record<string, unknown>>;
+    getAccesses(interfaceId: string): Promise<IAccesses>;
+    updateAccesses(searchInterfaceConfigId: string, accesses: IAccesses): Promise<IAccesses>;
+    getAccessesUsers(interfaceId: string): Promise<string[]>;
+    updateAccessesUsers(interfaceId: string, users: string[]): Promise<string[]>;
+    addAccessesUsers(interfaceId: string, users: string[], notify?: boolean, message?: string): Promise<string[]>;
+    manifest(interfaceId: string, options?: IManifestParameters): Promise<IManifestResponse>;
+}

package/dist/definitions/resources/SearchInterfaces/SearchInterfaces.model.d.ts

@@ -0,0 +1,179 @@
+import { Paginated } from '../BaseInterfaces';
+import { SortingBy, SortingOrder } from '../Enums';
+export interface IAccesses {
+    /**
+     * The list of users that are allowed to access the search interface.
+     */
+    users: string[];
+    /**
+     * The list of domains that are allowed to access the search interface.
+     */
+    domains: string[];
+    /**
+     * When set to true, all users can share and see the search page.
+     */
+    sharingLinkEnabled?: boolean;
+    /**
+     * When set to true, the domain sharing is enabled. Otherwise, only users that have explicitly access to the search page can access it.
+     */
+    sharingDomainEnabled?: boolean;
+}
+export interface IFacet {
+    /**
+     * The [field](https://docs.coveo.com/en/200) on which the facet is based.
+     */
+    field: string;
+    /**
+     * The label of the facet.
+     */
+    label: string;
+}
+export interface ISortCriteria {
+    /**
+     * Indicates the kind of sort criterion.
+     */
+    by: SortingBy;
+    /**
+     * Label of the sort criterion.
+     */
+    label: string;
+    /**
+     * Specify the sort order if applicable.
+     * Default value when sorting by date is descending.
+     * Default value when sorting by field is ascending.
+     * No sort order value is applicable when sorting by relevancy.
+     */
+    order?: SortingOrder;
+    /**
+     * The [field](https://docs.coveo.com/en/200) on which the sort is based on. For example: filetype.
+     * Required when sorting by field.
+     * This property is ignored unless you are sorting by field.
+     */
+    field?: string;
+}
+export interface ISearchInterfaceConfiguration {
+    /**
+     * The configuration identifier.
+     */
+    id: string;
+    /**
+     * The name of the search interface configuration.
+     */
+    name: string;
+    /**
+     * The title of the search interface configuration. Will be displayed as the HTML page title.
+     */
+    title: string;
+    /**
+     * The List of facets to display in the search interface.
+     */
+    facets: IFacet[];
+    /**
+     * The list of sorts to display in the search interface.
+     */
+    sortCriteria: ISortCriteria[];
+    /**
+     * The public access configuration.
+     */
+    accesses: IAccesses;
+}
+export interface ISearchInterfaceConfigurationResponse extends ISearchInterfaceConfiguration {
+    /**
+     * The creation timestamp. (ISO 8601)
+     */
+    created: string;
+    /**
+     * The creator principal.
+     */
+    createdBy: string;
+    /**
+     * The last update timestamp. (ISO 8601)
+     */
+    updated: string;
+    /**
+     * The last updated principal.
+     */
+    updatedBy: string;
+}
+export interface IListSearchInterfacesParameters extends Paginated {
+    /**
+     * A substring that must appear in a search interface configuration name for this configuration to appear in results.
+     */
+    filter?: string;
+    /**
+     * The sort direction of the results.<br />Possible values:<br /> - `asc`: ascending order<br /> - `desc`: descending order.
+     */
+    order?: 'desc' | 'asc';
+    /**
+     * The 0-based number of the page of configurations to list.
+     */
+    page?: number;
+    /**
+     * The maximum number of configurations to include per page.
+     */
+    perPage?: number;
+}
+export interface IManifestParameters {
+    /**
+     * The placeholders for the page.
+     */
+    pagePlaceholders?: IPagePlaceholders;
+}
+export interface IPagePlaceholders {
+    /**
+     * A placeholder for the result list and result templates.
+     */
+    results?: string;
+}
+export interface IManifestResponse {
+    /**
+     * The HTML markup of the search interface along with configured placeholders.
+     */
+    markup: string;
+    /**
+     * The Atomic results configuration information.
+     */
+    results: IPageManifestResults;
+    /**
+     * The Atomic related styling in CSS format.
+     */
+    style: IPageManifestStyle;
+    /**
+     * The complete search interface configuration.
+     */
+    config: ISearchInterfaceConfigurationResponse;
+}
+export interface IPageManifestResultTemplate {
+    /**
+     * The HTML markup of the content of the result template.
+     */
+    markup: string;
+    /**
+     * The Atomic [result template component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-template/)'s properties.
+     */
+    attributes: Record<string, string>;
+}
+export interface IPageManifestResults {
+    /**
+     * The placeholder for the result list and result templates.
+     */
+    placeholder?: string;
+    /**
+     * The Atomic [result list component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-list/#properties)'s properties.
+     */
+    attributes: Record<string, string>;
+    /**
+     * The Atomic result template configuration information.
+     */
+    templates: IPageManifestResultTemplate[];
+}
+export interface IPageManifestStyle {
+    /**
+     * The CSS to set [Atomic theme variables](https://docs.coveo.com/en/atomic/latest/usage/themes-and-visual-customization/#theme-variables).
+     */
+    theme: string;
+    /**
+     * The page layout CSS.
+     */
+    layout: string;
+}

package/dist/definitions/resources/SearchInterfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './SearchInterfaces';
+export * from './SearchInterfaces.model';

package/dist/definitions/resources/SearchPages/SearchPages.d.ts

@@ -0,0 +1,20 @@
+import Resource from '../Resource';
+import { SearchPageModel, ListSearchPagesParams, CreateSearchPageModel, UpdateSearchPageModel, SearchPageVersionModel, MajorMinorVersion, SearchPageHeadersModel, ReorderSearchPageHeadersModel, JavaScriptResourceModel, CSSResourceModel } from './SearchPagesInterfaces';
+export default class SearchPages extends Resource {
+    static baseUrl: string;
+    list(params?: ListSearchPagesParams): Promise<SearchPageModel[]>;
+    create(page: CreateSearchPageModel): Promise<SearchPageModel>;
+    delete(pageId: string): Promise<Record<string, unknown>>;
+    get(pageId: string): Promise<SearchPageModel>;
+    update(pageId: string, page: UpdateSearchPageModel): Promise<Record<string, unknown>>;
+    getVersion(pageId: string): Promise<SearchPageVersionModel>;
+    updateVersion(pageId: string, version: MajorMinorVersion): Promise<Record<string, unknown>>;
+    getHeaders(pageId: string): Promise<SearchPageHeadersModel>;
+    reorderHeaders(pageId: string, resources: ReorderSearchPageHeadersModel): Promise<SearchPageHeadersModel>;
+    createCssResource(pageId: string, resource: CSSResourceModel): Promise<SearchPageHeadersModel>;
+    updateCssResource(pageId: string, resourceName: string, resource: CSSResourceModel): Promise<SearchPageHeadersModel>;
+    deleteCssResource(pageId: string, resourceName: string): Promise<Record<string, unknown>>;
+    createJsResource(pageId: string, resource: JavaScriptResourceModel): Promise<SearchPageHeadersModel>;
+    updateJsResource(pageId: string, resourceName: string, resource: JavaScriptResourceModel): Promise<SearchPageHeadersModel>;
+    deleteJsResource(pageId: string, resourceName: string): Promise<Record<string, unknown>>;
+}

package/dist/definitions/resources/SearchPages/SearchPagesInterfaces.d.ts

@@ -0,0 +1,42 @@
+import { GranularResource } from '../BaseInterfaces';
+export interface SearchPageModel extends GranularResource {
+    id: string;
+    name: string;
+    title: string;
+    filter?: string;
+    html?: string;
+    javascript?: JavaScriptResourceModel[];
+    css?: CSSResourceModel[];
+    lastModified?: string;
+}
+export interface CreateSearchPageModel extends Pick<SearchPageModel, 'name' | 'title'> {
+}
+export interface UpdateSearchPageModel extends Pick<SearchPageModel, 'name' | 'title' | 'html'> {
+}
+export declare type JavaScriptResourceModel = SearchPageResourceModel;
+export declare type CSSResourceModel = SearchPageResourceModel;
+export declare type SearchPageResourceModel = SearchPageResourceModelWithUrl | SearchPageResourceModelWithInlineContent;
+export interface SearchPageResourceModelBasics {
+    name: string;
+}
+export interface SearchPageResourceModelWithUrl extends SearchPageResourceModelBasics {
+    url: string;
+}
+export interface SearchPageResourceModelWithInlineContent extends SearchPageResourceModelBasics {
+    inlineContent: string;
+}
+export interface SearchPageVersionModel {
+    current?: MajorMinorVersion;
+    available: MajorMinorVersion[];
+    latest: MajorMinorVersion;
+    upgradable: boolean;
+}
+export interface ListSearchPagesParams {
+    name?: string;
+}
+export interface MajorMinorVersion {
+    major: string;
+    minor: string;
+}
+export declare type SearchPageHeadersModel = Pick<SearchPageModel, 'css' | 'javascript'>;
+export declare type ReorderSearchPageHeadersModel = Record<'css' | 'javascript', string[]>;

package/dist/definitions/resources/SearchPages/index.d.ts

@@ -0,0 +1,2 @@
+export * from './SearchPages';
+export * from './SearchPagesInterfaces';

package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetrics.d.ts

@@ -0,0 +1,7 @@
+import Resource from '../../Resource';
+import { ListLicenseMonthlyParams, RestListOfMetricsModel, RestListOfMetricValues } from './LicenseMetricsInterface';
+export default class LicenseMetrics extends Resource {
+    static baseUrl: string;
+    listInUse(): Promise<RestListOfMetricsModel>;
+    listMonthly(metric: string, params: ListLicenseMonthlyParams): Promise<RestListOfMetricValues>;
+}

package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/LicenseMetricsInterface.d.ts

@@ -0,0 +1,49 @@
+export interface RestListOfMetricsModel {
+    /**
+     * The list of metrics
+     */
+    metrics: RestMetricsModel[];
+}
+export interface RestMetricsModel {
+    /**
+     * The id of the metric
+     */
+    id: string;
+    /**
+     * The display name of the metric
+     */
+    label?: string;
+}
+export interface RestListOfMetricValues {
+    /**
+     * The list of daily metric values
+     */
+    values: RestMetricValueForDate[];
+}
+export interface RestMetricValueForDate {
+    /**
+     * The date for the usage metric value
+     */
+    date: string;
+    /**
+     * The numeric metric value
+     */
+    value: number;
+}
+export interface ListLicenseMonthlyParams {
+    /**
+     * When appropriate, the size of the sliding window to use, in months.
+     * If this parameter is not specified the default sliding window for the metric will be used
+     */
+    slidingWindow?: number;
+    /**
+     * the last month to report for.
+     * format YYYY-MM
+     */
+    to: string;
+    /**
+     * the first month to report for.
+     * format YYYY-MM
+     */
+    from: string;
+}

package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/index.d.ts

@@ -0,0 +1,2 @@
+export * from './LicenseMetrics';
+export * from './LicenseMetricsInterface';

package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/RawMetrics.d.ts

@@ -0,0 +1,10 @@
+import Resource from '../../Resource';
+import { DailyRawMetricParameters, MonthlyRawMetricParameters, MonthlyRawMetricsParameters, RestListOfRawMetrics, RestListOfRawMetricValues, RestListOfSearchHubRawMetrics } from './RawMetricsInterface';
+export default class RawMetrics extends Resource {
+    static baseUrl: string;
+    private addZeroIfRequired;
+    list(): Promise<RestListOfRawMetrics>;
+    listMonthly({ month, minimumQueries }: MonthlyRawMetricsParameters): Promise<RestListOfSearchHubRawMetrics>;
+    getDaily({ to, from, metric, searchHub }: DailyRawMetricParameters): Promise<RestListOfRawMetricValues>;
+    getMonthly({ to, from, metric, searchHub }: MonthlyRawMetricParameters): Promise<RestListOfRawMetricValues>;
+}

package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/RawMetricsInterface.d.ts

@@ -0,0 +1,127 @@
+import { SearchHubRawMetrics } from '../../Enums';
+export interface DailyRawMetricParameters extends CommonMetricParameters {
+    /**
+     * The first day to report for
+     */
+    from: DateWithoutTime;
+    /**
+     * The last day to report for
+     */
+    to: DateWithoutTime;
+}
+export interface MonthlyRawMetricParameters extends CommonMetricParameters {
+    /**
+     * The first month to report for
+     */
+    from: DateWithoutTimeAndDay;
+    /**
+     * The last month to report for
+     */
+    to: DateWithoutTimeAndDay;
+}
+export interface MonthlyRawMetricsParameters {
+    /**
+     * The month to report for
+     */
+    month: DateWithoutTimeAndDay;
+    /**
+     * The minimum number of queries required for a search hub to be listed
+     */
+    minimumQueries?: number;
+}
+export interface RestListOfRawMetrics {
+    /**
+     * The list of metrics
+     */
+    metrics: RestMetric[];
+}
+export interface RestListOfRawMetricValues {
+    /**
+     * The list of daily metric values
+     */
+    values: RestMetricValueForDate[];
+}
+export interface RestListOfSearchHubRawMetrics {
+    /**
+     * The list of search hubs
+     */
+    searchHubs: RestSearchHubMetrics[];
+}
+interface RestMetric {
+    /**
+     * The ID of the metric
+     */
+    id: SearchHubRawMetrics;
+    /**
+     * The display name of the metric
+     */
+    label?: string;
+}
+interface RestMetricValueForDate {
+    /**
+     * The date for the usage metric value
+     */
+    date: string;
+    /**
+     * The numeric metric value
+     */
+    value: number;
+}
+interface RestSearchHubMetrics {
+    /**
+     * The name of the search hub
+     */
+    searchHub: string;
+    /**
+     * The usage buckets to which the search hub is assigned
+     */
+    assignment: SearchHubRawMetrics;
+    /**
+     * The number of normal queries
+     */
+    normalQueries: number;
+    /**
+     * The number of recommendation queries
+     */
+    recommendationQueries: number;
+    /**
+     * The number of distinct users
+     */
+    users: number;
+    /**
+     * The number of distinct persistent queries
+     */
+    staticQueries: number;
+    /**
+     * The number of product listing queries
+     */
+    productListingQueries: number;
+}
+interface CommonMetricParameters {
+    /**
+     * The raw metric to report on
+     */
+    metric: SearchHubRawMetrics;
+    /**
+     * The name of the search hub to report on
+     */
+    searchHub: string;
+}
+interface DateWithoutTime {
+    /**
+     * Year of the selected date
+     */
+    year: number;
+    /**
+     * Month of the selected date
+     * Between 1 to 12
+     */
+    month: number;
+    /**
+     * Day of the selected date
+     * Between 1 to 31
+     */
+    day: number;
+}
+declare type DateWithoutTimeAndDay = Omit<DateWithoutTime, 'day'>;
+export {};

package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/index.d.ts

@@ -0,0 +1,2 @@
+export * from './RawMetrics';
+export * from './RawMetricsInterface';

package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/SearchHubs.d.ts

@@ -0,0 +1,11 @@
+import Resource from '../../Resource';
+import { SearchHubNameParams, RestSearchHub, UpdateSearchHubParams, UpdateSearchHubBucketParams, ListSearchHubsParams, ListSearchHubs } from './SearchHubsInterface';
+export default class SearchHubs extends Resource {
+    static baseUrl: string;
+    list(params?: ListSearchHubsParams): Promise<ListSearchHubs>;
+    create(params: RestSearchHub): Promise<void>;
+    get({ hubName }: SearchHubNameParams): Promise<RestSearchHub>;
+    delete({ hubName }: SearchHubNameParams): Promise<void>;
+    update({ hubName, hub }: UpdateSearchHubParams): Promise<void>;
+    updateBucket({ hubName, bucket }: UpdateSearchHubBucketParams): Promise<void>;
+}

package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/SearchHubsInterface.d.ts

@@ -0,0 +1,64 @@
+import { Paginated } from '../../BaseInterfaces';
+export interface ListSearchHubs {
+    /**
+     * The array of search hubs
+     */
+    hubs: RestSearchHub[];
+    /**
+     * The number of search hub created on the organization
+     */
+    totalCount: number;
+}
+export interface RestSearchHub {
+    /**
+     * The name of the search hub
+     */
+    name: string;
+    /**
+     * The usage bucket to count queries from this hub into
+     */
+    bucket?: string;
+    /**
+     * A description for the search hub
+     */
+    description?: string;
+}
+export interface ListSearchHubsParams extends Paginated {
+    /**
+     * The free-form string to filter the returned list based on the values of the search hub attributes
+     */
+    filter?: string;
+    /**
+     * The maximum number of search hubs to list per page
+     *
+     * @default `100`
+     */
+    perPage?: number;
+    /**
+     * The 0-based index number of page to list
+     *
+     * @default `0`
+     */
+    page?: number;
+}
+export interface SearchHubNameParams {
+    /**
+     * The search hub name
+     */
+    hubName: string;
+}
+interface SearchHubModel {
+    /**
+     * The search hub data
+     */
+    hub: RestSearchHub;
+}
+interface SearchHubBucketParams {
+    /**
+     * The search hub bucket
+     */
+    bucket: string;
+}
+export declare type UpdateSearchHubParams = SearchHubNameParams & SearchHubModel;
+export declare type UpdateSearchHubBucketParams = SearchHubNameParams & SearchHubBucketParams;
+export {};

package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './SearchHubs';
+export * from './SearchHubsInterface';

package/dist/definitions/resources/SearchUsageMetrics/SearchUsageMetrics.d.ts

@@ -0,0 +1,13 @@
+import API from '../../APICore';
+import Resource from '../Resource';
+import LicenseMetrics from './LicenseMetrics/LicenseMetrics';
+import RawMetrics from './RawMetrics/RawMetrics';
+import SearchHubs from './SearchHubs/SearchHubs';
+export default class SearchUsageMetrics extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    licenseMetrics: LicenseMetrics;
+    searchHubs: SearchHubs;
+    rawMetrics: RawMetrics;
+    constructor(api: API, serverlessApi: API);
+}

package/dist/definitions/resources/SearchUsageMetrics/index.d.ts

@@ -0,0 +1,4 @@
+export * from './SearchUsageMetrics';
+export * from './LicenseMetrics';
+export * from './SearchHubs';
+export * from './RawMetrics';

package/dist/definitions/resources/SecurityCache/SecurityCache.d.ts

@@ -0,0 +1,26 @@
+import { PageModel } from '../BaseInterfaces';
+import Ressource from '../Resource';
+import { DetailedSecurityCacheMemberModel, ScheduleModel, SecurityCacheIdentityModel, SecurityCacheListOptions, SecurityCacheStatus, SecurityProviderModelWithStatus, SecurityCacheListRelationshipsOptions, SecurityCacheMemberModel, SecurityProviderModel, SecurityProviderIdentitiesFilters } from './SecurityCacheInterfaces';
+export default class SecurityCache extends Ressource {
+    static baseUrl: string;
+    static cacheUrl: string;
+    static providersUrl: string;
+    listMembers(providerId: string, options?: SecurityCacheListOptions): Promise<PageModel<DetailedSecurityCacheMemberModel>>;
+    listEntities(providerId: string, options?: SecurityCacheListOptions): Promise<PageModel<SecurityCacheIdentityModel, "items">>;
+    listSecurityProviderIdentities(providerId: string, { page, perPage, ...rest }?: SecurityProviderIdentitiesFilters): Promise<PageModel<SecurityCacheIdentityModel, "items">>;
+    listChildren(providerId: string, member: SecurityCacheMemberModel, options?: SecurityCacheListRelationshipsOptions): Promise<PageModel<DetailedSecurityCacheMemberModel, "items">>;
+    listParents(providerId: string, member: SecurityCacheMemberModel, options?: SecurityCacheListRelationshipsOptions): Promise<PageModel<DetailedSecurityCacheMemberModel, "items">>;
+    listSchedules(): Promise<ScheduleModel[]>;
+    getStatus(): Promise<SecurityCacheStatus>;
+    refreshCache(): Promise<Record<string, unknown>>;
+    refreshProvider(providerId: string): Promise<Record<string, unknown>>;
+    refreshIdentity(identityModel: SecurityCacheMemberModel): Promise<Record<string, unknown>>;
+    listProviders(): Promise<SecurityProviderModelWithStatus[]>;
+    getProvider(securityProviderId: string): Promise<SecurityProviderModelWithStatus>;
+    createOrUpdateProvider(securityProvider: SecurityProviderModel): Promise<SecurityProviderModelWithStatus>;
+    deleteProvider(securityProviderId: string): Promise<Record<string, unknown>>;
+    getSchedules(securityProviderId: string): Promise<ScheduleModel[]>;
+    updateSchedule(securityProviderId: string, schedule: ScheduleModel): Promise<ScheduleModel>;
+    getProviderEntity(providerId: string, member: SecurityCacheMemberModel): Promise<DetailedSecurityCacheMemberModel>;
+    cancelRefresh(providerId: string): Promise<Record<string, unknown>>;
+}