@coveo/platform-client 0.0.0-cjs-attempt

package/dist/types/resources/Extensions/Extensions.d.ts

@@ -0,0 +1,12 @@
+import Resource from '../Resource.js';
+import { CreateExtension, ExtensionModel } from './ExtensionsInterfaces.js';
+export default class Extension extends Resource {
+    static baseUrl: string;
+    create(extension: CreateExtension): Promise<ExtensionModel>;
+    update(extensionId: string, options: CreateExtension): Promise<ExtensionModel>;
+    delete(extensionId: string): Promise<void>;
+    enable(extensionId: string): Promise<void>;
+    disable(extensionId: string, reason?: string): Promise<void>;
+    get(extensionId: string): Promise<ExtensionModel>;
+    list(): Promise<ExtensionModel[]>;
+}

package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts

@@ -0,0 +1,55 @@
+import { GranularResource } from '../../Entry.js';
+import { DataStreamType, ExtensionLanguageType } from '../Enums.js';
+type Version = 'v1' | 'v2';
+export interface ExtensionModel {
+    apiVersion: Version;
+    content: string;
+    createdDate: number;
+    description: string;
+    enabled: boolean;
+    id: string;
+    language: ExtensionLanguageType;
+    lastModified: number;
+    name: string;
+    requiredDataStreams: DataStreamType[];
+    status: {
+        dailyStatistics: {
+            averageDurationInSeconds: number;
+            numberOfErrors: number;
+            numberOfExecutions: number;
+            numberOfSkips: number;
+            numberOfTimeouts: number;
+        };
+        disabledStatus?: {
+            disabledDate: number;
+            reason: string;
+        };
+        durationHealth: {
+            healthIndicator: string;
+            reason: string;
+        };
+        lastAutoDisablingDate: number;
+        lastDisablingDate: number;
+        timeoutHealth: {
+            healthIndicator: string;
+            reason: string;
+        };
+        timeoutLikeliness: string;
+    };
+    usedBy: [
+        {
+            sourceId: string;
+            sourceName: string;
+        }
+    ];
+    versionId: string;
+}
+export interface CreateExtension extends GranularResource {
+    content: string;
+    name: string;
+    apiVersion?: Version;
+    description?: string;
+    language?: ExtensionLanguageType;
+    requiredDataStreams?: DataStreamType[];
+}
+export {};

package/dist/types/resources/Extensions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Extensions.js';
+export * from './ExtensionsInterfaces.js';

package/dist/types/resources/Fields/Fields.d.ts

@@ -0,0 +1,19 @@
+import { PageModel } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import { FieldListingOptions, FieldModel, ListFieldsParams } from './FieldsInterfaces.js';
+export default class Field extends Resource {
+    static baseUrl: string;
+    create(field: FieldModel): Promise<Record<string, unknown>>;
+    createFields(fields: FieldModel[]): Promise<Record<string, unknown>>;
+    deleteFields(fieldIds: string[]): Promise<Record<string, unknown>>;
+    updateFields(fields: FieldModel[]): Promise<Record<string, unknown>>;
+    synchronize(): Promise<Record<string, unknown>>;
+    delete(fieldId: string): Promise<Record<string, unknown>>;
+    get(fieldId: string): Promise<FieldModel>;
+    update(fieldId: string, options: FieldModel): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated list(params?: ListFieldsParams) is kept for backward compatibility, you should now use `search(params?: FieldListingOptions)`.
+     */
+    list(params?: ListFieldsParams): Promise<PageModel<FieldModel, "items">>;
+    search(params?: FieldListingOptions): Promise<PageModel<FieldModel, "items">>;
+}

package/dist/types/resources/Fields/FieldsInterfaces.d.ts

@@ -0,0 +1,70 @@
+import { Paginated } from '../BaseInterfaces.js';
+import { FacetOrSortStatus, FieldOrigin, FieldTypes, SortingOrder } from '../Enums.js';
+export interface FieldModel {
+    dateFormat?: string;
+    description?: string;
+    facet?: boolean;
+    hierarchicalFacet?: boolean;
+    includeInQuery?: boolean;
+    includeInResults?: boolean;
+    keepAccentsDisplayValueFacet?: boolean;
+    keyValue?: boolean;
+    mergeWithLexicon?: boolean;
+    multiValueFacet?: boolean;
+    multiValueFacetTokenizers?: string;
+    name?: string;
+    ranking?: boolean;
+    smartDateFacet?: boolean;
+    sort?: boolean;
+    stemming?: boolean;
+    system?: boolean;
+    type?: FieldTypes;
+    useCacheForComputedFacet?: boolean;
+    useCacheForNestedQuery?: boolean;
+    useCacheForNumericQuery?: boolean;
+    useCacheForSort?: boolean;
+}
+export interface ListFieldsParams extends Paginated {
+    facetsOnly?: boolean;
+    filter?: string;
+    order?: SortingOrder;
+    origin?: FieldOrigin;
+    sortBy?: string;
+    type?: FieldTypes;
+}
+export interface FieldListingFilters {
+    /**
+     * The facet status of the fields to list.
+     */
+    facet?: FacetOrSortStatus;
+    /**
+     * A substring that must appear in the name property of a field in order for this field to be included in the results.
+     */
+    name?: string;
+    /**
+     * The origin of the fields to list.
+     */
+    origin?: FieldOrigin;
+    /**
+     * The sort status of the fields to list.
+     */
+    sort?: FacetOrSortStatus;
+    /**
+     * The origin of the fields to list.
+     */
+    type?: FieldTypes;
+}
+export interface FieldListingOptions extends Paginated {
+    /**
+     * Filters to narrow down the returned fields.
+     */
+    filters?: FieldListingFilters;
+    /**
+     * The sort direction of the results.
+     */
+    order?: SortingOrder;
+    /**
+     * The sort direction of the results.
+     */
+    sortBy?: string;
+}

package/dist/types/resources/Fields/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Fields.js';
+export * from './FieldsInterfaces.js';

package/dist/types/resources/Global/Global.d.ts

@@ -0,0 +1,11 @@
+import API from '../../APICore.js';
+import Resource from '../Resource.js';
+import OrganizationConfiguration from './OrganizationConfigurations/OrganizationConfiguration.js';
+import RegionConfiguration from './RegionConfigurations/RegionConfiguration.js';
+export default class Global extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    region: RegionConfiguration;
+    organization: OrganizationConfiguration;
+    constructor(api: API, serverlessApi: API);
+}

package/dist/types/resources/Global/OrganizationConfigurations/OrganizationConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { PageModel } from '../../BaseInterfaces.js';
+import Resource from '../../Resource.js';
+import { OrganizationConfigurationModel } from './OrganizationConfigurationInterfaces.js';
+export default class OrganizationConfiguration extends Resource {
+    static baseUrl: string;
+    list(): Promise<PageModel<OrganizationConfigurationModel, "items">>;
+    get(organizationId: string): Promise<OrganizationConfigurationModel>;
+}

package/dist/types/resources/Global/OrganizationConfigurations/OrganizationConfigurationInterfaces.d.ts

@@ -0,0 +1,6 @@
+export interface OrganizationConfigurationModel {
+    customDns?: string;
+    mainRegions: string[];
+    organizationId: string;
+    satelliteRegions: string[];
+}

package/dist/types/resources/Global/OrganizationConfigurations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './OrganizationConfiguration.js';
+export * from './OrganizationConfigurationInterfaces.js';

package/dist/types/resources/Global/RegionConfigurations/RegionConfiguration.d.ts

@@ -0,0 +1,7 @@
+import Resource from '../../Resource.js';
+import { RegionConfigurationModel } from './RegionConfigurationInterfaces.js';
+export default class RegionConfiguration extends Resource {
+    static baseUrl: string;
+    list(): Promise<RegionConfigurationModel[]>;
+    get(region: string): Promise<RegionConfigurationModel>;
+}

package/dist/types/resources/Global/RegionConfigurations/RegionConfigurationInterfaces.d.ts

@@ -0,0 +1,10 @@
+import { RegionType } from '../../Enums.js';
+export interface RegionConfigurationModel {
+    apiEndpoint?: string;
+    hostedSearchPagesEndpoint?: string;
+    mainEndpoint?: string;
+    region: string;
+    regionEndpoint: string;
+    regionName: string;
+    regionType: RegionType;
+}

package/dist/types/resources/Global/RegionConfigurations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './RegionConfiguration.js';
+export * from './RegionConfigurationInterfaces.js';

package/dist/types/resources/Global/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Global.js';
+export * from './OrganizationConfigurations/index.js';
+export * from './RegionConfigurations/index.js';

package/dist/types/resources/GlobalGroups/GlobalGroup.d.ts

@@ -0,0 +1,13 @@
+import { New } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import { GlobalGroupModel } from './GlobalGroupInterfaces.js';
+export default class GlobalGroup extends Resource {
+    static baseUrl: string;
+    list(): Promise<GlobalGroupModel[]>;
+    create(globalGroup: New<GlobalGroupModel>): Promise<{
+        id: string;
+    }>;
+    delete(globalGroupId: string): Promise<Record<string, unknown>>;
+    get(globalGroupId: string): Promise<GlobalGroupModel>;
+    update(globalGroup: GlobalGroupModel): Promise<Record<string, unknown>>;
+}

package/dist/types/resources/GlobalGroups/GlobalGroupInterfaces.d.ts

@@ -0,0 +1,18 @@
+import { PrivilegeModel } from '../BaseInterfaces.js';
+import { MemberModel, RealmModel } from '../Groups/index.js';
+export interface GlobalGroupModel {
+    displayName: string;
+    id: string;
+    members: MemberModel[];
+    organizationActivated: boolean;
+    privileges: GlobalPrivilegeModel[];
+    realms: RealmModel[];
+    temporaryPrivilegeConfigurations: TemporaryPrivilegeConfigurationModel[];
+}
+export interface GlobalPrivilegeModel extends PrivilegeModel {
+    level: string;
+}
+export interface TemporaryPrivilegeConfigurationModel {
+    approbationType: 'AUTO_APPROVED' | 'DENIED';
+    privilege: GlobalPrivilegeModel;
+}

package/dist/types/resources/GlobalGroups/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GlobalGroup.js';
+export * from './GlobalGroupInterfaces.js';

package/dist/types/resources/Groups/Groups.d.ts

@@ -0,0 +1,24 @@
+import API from '../../APICore.js';
+import { New, PrivilegeModel } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import { CreateGroupOptions, GroupModel, UpdateGroupOptions } from './GroupsInterfaces.js';
+import GroupInvite from './Invites/GroupInvite.js';
+import GroupMember from './Members/GroupMember.js';
+import GroupRealm from './Realms/GroupRealm.js';
+export default class Group extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    realm: GroupRealm;
+    member: GroupMember;
+    invite: GroupInvite;
+    constructor(api: API, serverlessApi: API);
+    list(): Promise<GroupModel[]>;
+    create(group: New<GroupModel, 'resourceId'>, options?: CreateGroupOptions): Promise<{
+        id: string;
+    }>;
+    delete(groupId: string): Promise<Record<string, unknown>>;
+    get(groupId: string): Promise<GroupModel>;
+    update(group: GroupModel, options?: UpdateGroupOptions): Promise<Record<string, unknown>>;
+    listExclusivePrivileges(groupId: string): Promise<PrivilegeModel[]>;
+}

package/dist/types/resources/Groups/GroupsInterfaces.d.ts

@@ -0,0 +1,21 @@
+import { GranularResource, PrivilegeModel } from '../BaseInterfaces.js';
+import { InviteModel } from './Invites/index.js';
+import { MemberModel } from './Members/index.js';
+import { RealmModel } from './Realms/index.js';
+export interface GroupModel extends GranularResource {
+    id: string;
+    displayName: string;
+    invites?: InviteModel[];
+    members?: MemberModel[];
+    privileges?: PrivilegeModel[];
+    realms?: RealmModel[];
+    deletable?: boolean;
+    resourceId?: string;
+}
+export interface CreateGroupOptions {
+    canEditItself?: boolean;
+    sendEmailToInviteUsers?: boolean;
+}
+export interface UpdateGroupOptions {
+    sendEmailToInviteUsers?: boolean;
+}

package/dist/types/resources/Groups/Invites/GroupInvite.d.ts

@@ -0,0 +1,11 @@
+import { New } from '../../BaseInterfaces.js';
+import Resource from '../../Resource.js';
+import { AddInviteOptions, InviteModel } from './GroupInviteInterfaces.js';
+export default class GroupInvite extends Resource {
+    static getBaseUrl: (id: string) => string;
+    list(groupId: string): Promise<InviteModel[]>;
+    add(groupId: string, invite: New<InviteModel>, options?: AddInviteOptions): Promise<InviteModel>;
+    delete(groupId: string, usernameOrEmail: string): Promise<Record<string, unknown>>;
+    accept(groupId: string): Promise<Record<string, unknown>>;
+    decline(groupId: string): Promise<Record<string, unknown>>;
+}

package/dist/types/resources/Groups/Invites/GroupInviteInterfaces.d.ts

@@ -0,0 +1,35 @@
+import { AuthProvider } from '../../Enums.js';
+export interface InviteByEmail {
+    id: string;
+    email: string;
+    username?: string;
+    providerUsername?: string;
+    displayName?: string;
+    expirationDate?: number;
+    invitedDate?: number;
+    provider?: AuthProvider;
+}
+export interface InviteByUsername {
+    id: string;
+    username: string;
+    email?: string;
+    providerUsername?: string;
+    displayName?: string;
+    expirationDate?: number;
+    invitedDate?: number;
+    provider?: AuthProvider;
+}
+export interface InviteByProvider {
+    id: string;
+    provider: AuthProvider;
+    providerUsername: string;
+    username?: string;
+    email?: string;
+    displayName?: string;
+    expirationDate?: number;
+    invitedDate?: number;
+}
+export type InviteModel = InviteByEmail | InviteByUsername | InviteByProvider;
+export interface AddInviteOptions {
+    sendEmail: boolean;
+}

package/dist/types/resources/Groups/Invites/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GroupInvite.js';
+export * from './GroupInviteInterfaces.js';

package/dist/types/resources/Groups/Members/GroupMember.d.ts

@@ -0,0 +1,9 @@
+import Resource from '../../Resource.js';
+import { AddGroupMemberOptions, MemberModel } from './GroupMemberInterfaces.js';
+export default class GroupMember extends Resource {
+    static getBaseUrl: (id: string) => string;
+    list(groupId: string): Promise<MemberModel[]>;
+    add(groupId: string, member: MemberModel, options?: AddGroupMemberOptions): Promise<Record<string, unknown>>;
+    delete(groupId: string, username: string): Promise<Record<string, unknown>>;
+    get(groupId: string, username: string): Promise<MemberModel>;
+}

package/dist/types/resources/Groups/Members/GroupMemberInterfaces.d.ts

@@ -0,0 +1,13 @@
+import { AuthProvider } from '../../Enums.js';
+export interface MemberModel {
+    id: string;
+    username: string;
+    email?: string;
+    displayName?: string;
+    lastLogin?: number;
+    provider?: AuthProvider;
+    providerUsername?: string;
+}
+export interface AddGroupMemberOptions {
+    sendEmailOnInvite: boolean;
+}

package/dist/types/resources/Groups/Members/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GroupMember.js';
+export * from './GroupMemberInterfaces.js';

package/dist/types/resources/Groups/Realms/GroupRealm.d.ts

@@ -0,0 +1,9 @@
+import Resource from '../../Resource.js';
+import { RealmModel } from './GroupRealmInterfaces.js';
+export default class GroupRealm extends Resource {
+    static getBaseUrl: (id: string) => string;
+    list(groupId: string): Promise<RealmModel[]>;
+    add(groupId: string, realm: RealmModel): Promise<Record<string, unknown>>;
+    delete(groupId: string, realmId: string): Promise<Record<string, unknown>>;
+    get(groupId: string, realmId: string): Promise<RealmModel>;
+}

package/dist/types/resources/Groups/Realms/GroupRealmInterfaces.d.ts

@@ -0,0 +1,7 @@
+import { AuthProvider } from '../../Enums.js';
+export interface RealmModel {
+    id: string;
+    provider: AuthProvider;
+    displayName: string;
+    samlIdentityProviderId?: string;
+}

package/dist/types/resources/Groups/Realms/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GroupRealm.js';
+export * from './GroupRealmInterfaces.js';

package/dist/types/resources/Groups/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Groups.js';
+export * from './GroupsInterfaces.js';
+export * from './Realms/index.js';
+export * from './Members/index.js';
+export * from './Invites/index.js';

package/dist/types/resources/HostedInterfacesCore/HostedInterfaceCoreConfig.model.d.ts

@@ -0,0 +1,141 @@
+import { Paginated } from '../BaseInterfaces.js';
+export interface HostedInterfaceResultTemplateBadge {
+    /**
+     * The field who's value should be displayed in the badge.
+     */
+    field: string;
+    /**
+     * The text to display in the badge.
+     */
+    label?: string;
+    /**
+     * The RGB HEX code for the color of the badge.
+     */
+    color: string;
+}
+export declare enum HostedInterfaceConditionOperator {
+    IsDefined = "isDefined",
+    IsNotDefined = "isNotDefined",
+    MustMatch = "mustMatch",
+    MustNotMatch = "mustNotMatch"
+}
+export interface HostedInterfaceCondition {
+    /**
+     * The [field](https://docs.coveo.com/en/200) to evaluate.
+     */
+    field: string;
+    /**
+     * The values used as the right side operand when the `operator` is one of:
+     * - `'mustMatch'`
+     * - `'mustNotMatch'`
+     */
+    values?: string[];
+    /**
+     * The operator used to evaluate the field condition.
+     * Possible values are:
+     * - `'isDefined'`
+     * - `'isNotDefined'`
+     * - `'mustMatch'`
+     * - `'mustNotMatch'`
+     */
+    conditionType: HostedInterfaceConditionOperator;
+}
+export interface HostedInterfaceResultTemplateDetail {
+    /**
+     * The [field](https://docs.coveo.com/en/200) containing the metadata to display.
+     */
+    field: string;
+    /**
+     * The label to show describing the metadata.
+     */
+    label?: string;
+}
+export type DisplayValueType = 'checkbox' | 'link';
+export interface HostedInterfaceFacet {
+    /**
+     * The [field](https://docs.coveo.com/en/200) on which the facet is based.
+     */
+    field: string;
+    /**
+     * The label of the facet.
+     */
+    label: string;
+    /**
+     * Whether to display the facet values as checkboxes (multiple selection) or links (single selection).
+     * Possible values are:
+     * - `'checkbox'`
+     * - `'link'`
+     */
+    displayValuesAs: DisplayValueType;
+}
+export interface HostedInterfaceTab {
+    /**
+     * The label to be displayed in the tab.
+     */
+    label: string;
+    /**
+     * A constant query expression or filter that the Tab should add to any outgoing query.
+     *
+     * **Example:**
+     *
+     * `@objecttype==Message`
+     */
+    conditions: HostedInterfaceCondition[];
+}
+export interface ListHostedInterfacesParams extends Paginated {
+    /**
+     * A substring that must appear in a hosted interface configuration name for this configuration to appear in results.
+     */
+    filter?: string;
+    /**
+     * The sort direction of the results.
+     * Possible values:
+     * - `'asc'`: ascending order
+     * - `'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 HostedInterfaceResultTemplate {
+    /**
+     * The name of the result template.
+     */
+    name: string;
+    /**
+     * The conditions a result needs to meet to use the template.
+     */
+    conditions: HostedInterfaceCondition[];
+    /**
+     * The badge to display.
+     */
+    badge: HostedInterfaceResultTemplateBadge;
+    /**
+     * The metadata details to display.
+     */
+    details: HostedInterfaceResultTemplateDetail[];
+}
+export interface HostedInterfaceConfiguration {
+    /**
+     * The configuration identifier.
+     */
+    id: string;
+    /**
+     * The name of the insight panel interface configuration.
+     */
+    name: string;
+    /**
+     * The list of facets to display.
+     */
+    facets: HostedInterfaceFacet[];
+    /**
+     * The list of tabs to display.
+     */
+    tabs: HostedInterfaceTab[];
+}

package/dist/types/resources/HostedInterfacesCore/index.d.ts

@@ -0,0 +1 @@
+export * from './HostedInterfaceCoreConfig.model.js';

package/dist/types/resources/IPXInterfaces/IPXInterface.model.d.ts

@@ -0,0 +1,62 @@
+import { HostedInterfaceCondition, HostedInterfaceConfiguration, HostedInterfaceFacet, HostedInterfaceResultTemplate, HostedInterfaceResultTemplateBadge, HostedInterfaceResultTemplateDetail, HostedInterfaceTab } from '../HostedInterfacesCore/index.js';
+export declare enum IPXResultTemplateLayout {
+    Default = "default",
+    Thumbnail = "thumbnail"
+}
+export interface IPXFacet extends HostedInterfaceFacet {
+}
+export interface IPXCondition extends HostedInterfaceCondition {
+}
+export interface IPXTab extends HostedInterfaceTab {
+    /**
+     * A constant query expression or filter that the Tab should add to any outgoing query.
+     *
+     * **Example:**
+     *
+     * `@objecttype==Message`
+     */
+    conditions: IPXCondition[];
+}
+export interface IPXResultTemplateBadge extends HostedInterfaceResultTemplateBadge {
+}
+export interface IPXResultTemplateDetail extends HostedInterfaceResultTemplateDetail {
+}
+export interface IPXResultTemplate extends HostedInterfaceResultTemplate {
+    layout: IPXResultTemplateLayout;
+    /**
+     * The conditions a result needs to meet to use the template.
+     */
+    conditions: IPXCondition[];
+    /**
+     * The badge to display.
+     */
+    badge: IPXResultTemplateBadge;
+    /**
+     * The metadata details to display.
+     */
+    details: IPXResultTemplateDetail[];
+}
+export interface IPXButton {
+    label: string;
+}
+export interface IPXInterfaceConfiguration extends HostedInterfaceConfiguration {
+    /**
+     * The list of facets to display.
+     */
+    facets: IPXFacet[];
+    /**
+     * The list of tabs to display.
+     */
+    tabs: IPXTab[];
+    /**
+     * The list of result templates defined for the ipx.
+     */
+    /**
+     * The list of result templates defined for the ipx.
+     */
+    resultTemplates: IPXResultTemplate[];
+    /**
+     * The button element of the ipx interface.
+     */
+    button: IPXButton;
+}

package/dist/types/resources/IPXInterfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './IPXInterface.model.js';