@coveo/platform-client 35.0.0

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

@@ -0,0 +1,12 @@
+import Resource from '../Resource';
+import { CreateExtension, ExtensionModel } from './ExtensionsInterfaces';
+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/definitions/resources/Extensions/ExtensionsInterfaces.d.ts

@@ -0,0 +1,55 @@
+import { GranularResource } from '../../Entry';
+import { DataStreamType, ExtensionLanguageType } from '../Enums';
+declare 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/definitions/resources/Extensions/index.d.ts

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

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

@@ -0,0 +1,19 @@
+import { PageModel } from '../BaseInterfaces';
+import Resource from '../Resource';
+import { FieldListingOptions, FieldModel, ListFieldsParams } from './FieldsInterfaces';
+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/definitions/resources/Fields/FieldsInterfaces.d.ts

@@ -0,0 +1,70 @@
+import { Paginated } from '../BaseInterfaces';
+import { FacetOrSortStatus, FieldOrigin, FieldTypes, SortingOrder } from '../Enums';
+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/definitions/resources/Fields/index.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,13 @@
+import { New } from '../BaseInterfaces';
+import Resource from '../Resource';
+import { GlobalGroupModel } from './GlobalGroupInterfaces';
+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/definitions/resources/GlobalGroups/GlobalGroupInterfaces.d.ts

@@ -0,0 +1,18 @@
+import { PrivilegeModel } from '../BaseInterfaces';
+import { MemberModel, RealmModel } from '../Groups';
+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/definitions/resources/GlobalGroups/index.d.ts

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

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

@@ -0,0 +1,24 @@
+import API from '../../APICore';
+import { New, PrivilegeModel } from '../BaseInterfaces';
+import Resource from '../Resource';
+import { CreateGroupOptions, GroupModel, UpdateGroupOptions } from './GroupsInterfaces';
+import GroupInvite from './Invites/GroupInvite';
+import GroupMember from './Members/GroupMember';
+import GroupRealm from './Realms/GroupRealm';
+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/definitions/resources/Groups/GroupsInterfaces.d.ts

@@ -0,0 +1,21 @@
+import { GranularResource, PrivilegeModel } from '../BaseInterfaces';
+import { InviteModel } from './Invites';
+import { MemberModel } from './Members';
+import { RealmModel } from './Realms';
+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/definitions/resources/Groups/Invites/GroupInvite.d.ts

@@ -0,0 +1,11 @@
+import { New } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { AddInviteOptions, InviteModel } from './GroupInviteInterfaces';
+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/definitions/resources/Groups/Invites/GroupInviteInterfaces.d.ts

@@ -0,0 +1,35 @@
+import { AuthProvider } from '../../Enums';
+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 declare type InviteModel = InviteByEmail | InviteByUsername | InviteByProvider;
+export interface AddInviteOptions {
+    sendEmail: boolean;
+}

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

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

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

@@ -0,0 +1,9 @@
+import Resource from '../../Resource';
+import { AddGroupMemberOptions, MemberModel } from './GroupMemberInterfaces';
+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/definitions/resources/Groups/Members/GroupMemberInterfaces.d.ts

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

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

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

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

@@ -0,0 +1,9 @@
+import Resource from '../../Resource';
+import { RealmModel } from './GroupRealmInterfaces';
+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/definitions/resources/Groups/Realms/GroupRealmInterfaces.d.ts

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

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

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

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

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

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

@@ -0,0 +1,31 @@
+import API from '../../APICore';
+import Resource from '../Resource';
+import SearchPages from '../SearchPages/SearchPages';
+import { InProductExperienceModel, CreateInProductExperienceModel, UpdateInProductExperienceModel, CreateInProductExperienceResponse } from './InProductExperiencesInterfaces';
+/**
+ * In-Product Experiences (also known as In App Widgets) Swagger documentation can
+ * be found at https://platform.cloud.coveo.com/docs?urls.primaryName=Search%20Pages#/In-App,
+ * and shares certain functionality related to IPX interfaces with Search Pages. Swagger
+ * documentation for Search Pages can be found at
+ * https://platform.cloud.coveo.com/docs?urls.primaryName=Search%20Pages#/Search%20pages
+ */
+export default class InProductExperiences extends Resource {
+    static baseUrl: string;
+    static ipxBaseUrl: string;
+    /**
+     * IPX takes advantage of SearchPages for underlying the IPX interface management.
+     * This provides a helper around some methods, but for complete support for e.g. JS/CSS
+     * resource management, use this instance of `SearchPages` directly.
+     */
+    readonly searchPages: SearchPages;
+    constructor(api: API, serverlessApi: API);
+    create(ipx: CreateInProductExperienceModel): Promise<CreateInProductExperienceResponse>;
+    update(ipxId: string, ipx: UpdateInProductExperienceModel): Promise<Record<string, unknown>>;
+    list(name?: string): Promise<InProductExperienceModel[]>;
+    getLoader(ipxId: string, access_token?: string): Promise<string>;
+    /**
+     * `delete` is a helper method based on observed behavior of the Coveo UI where deletion logic calls out to the
+     * Search Pages endpoint to delete an IPX.
+     */
+    delete(ipxId: string): Promise<Record<string, unknown>>;
+}