@coveo/platform-client 0.0.0-clidev.1 → 0.0.0-development

package/dist/types/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts

@@ -0,0 +1,344 @@
+import { SortingOrder, SnapshotSortingType } from '../Enums.js';
+export interface ResourceSnapshotsModel {
+    /**
+     * The username of the snapshot creator.
+     */
+    createdBy: string;
+    /**
+     * The date of creation of the snapshot in number of milliseconds since UNIX epoch.
+     */
+    createdDate: number;
+    /**
+     * A note you can attach to your snapshot.
+     */
+    developerNote?: string;
+    /**
+     * The unique identifier of the target snapshot.
+     */
+    id: string;
+    /**
+     * The unique identifier of the organization from which the snapshot originates if it differs from the current organization.
+     */
+    originId?: string;
+    /**
+     * The unique identifier of the organization in which the snapshot applies.
+     */
+    targetId: string;
+    /**
+     * The list of reports of events on the snapshot.
+     */
+    reports?: ResourceSnapshotsReportModel[];
+    /**
+     * The list of synchronization reports on the snapshot.
+     */
+    synchronizationReports?: ResourceSnapshotsSynchronizationReportModel[];
+    /**
+     * The list of diff generation reports on the snapshot.
+     */
+    diffGenerationReports?: SnapshotDiffModel[];
+    /**
+     * A summary of the contents of the snapshot.
+     */
+    contentSummary?: Record<string, number>;
+}
+export declare enum ResourceSnapshotType {
+    extension = "EXTENSION",
+    featuredResult = "FEATURED_RESULT",
+    field = "FIELD",
+    filter = "FILTER",
+    mapping = "MAPPING",
+    mlModel = "ML_MODEL",
+    mlModelAssociation = "ML_MODEL_ASSOCIATION",
+    queryParameter = "QUERY_PARAMETER",
+    queryPipeline = "QUERY_PIPELINE",
+    queryPipelineCondition = "QUERY_PIPELINE_CONDITION",
+    rankingExpression = "RANKING_EXPRESSION",
+    rankingWeight = "RANKING_WEIGHT",
+    searchPage = "SEARCH_PAGE",
+    securityProvider = "SECURITY_PROVIDER",
+    source = "SOURCE",
+    stopWord = "STOP_WORD",
+    subscription = "SUBSCRIPTION",
+    thesaurus = "THESAURUS",
+    trigger = "TRIGGER"
+}
+export declare enum SnapshotAccessType {
+    Read = "READ",
+    Write = "WRITE"
+}
+export declare enum SnapshotExportContentFormat {
+    Flat = "FLAT",
+    SplitPerType = "SPLIT_PER_TYPE"
+}
+export declare enum ResourceSnapshotsReportResultCode {
+    AccessDenied = "ACCESS_DENIED",
+    ResourcesInError = "RESOURCES_IN_ERROR",
+    Success = "SUCCESS",
+    UnexpectedError = "UNEXPECTED_ERROR",
+    UnableToPushToOrganization = "UNABLE_TO_PUSH_TO_ORGANIZATION",
+    NoResourceRetrieved = "NO_RESOURCE_RETRIEVED",
+    UnableToRetrieveResources = "UNABLE_TO_RETRIEVE_RESOURCES",
+    ResourceDependencyCyle = "RESOURCE_DEPENDENCY_CYCLE",
+    ExternalServiceCommunicationError = "EXTERNAL_SERVICE_COMMUNICATION_ERROR",
+    AutoSynchronizationFailure = "AUTO_SYNCHRONIZATION_FAILURE"
+}
+export declare enum ResourceSnapshotsReportStatus {
+    Pending = "PENDING",
+    InProgress = "IN_PROGRESS",
+    Completed = "COMPLETED",
+    Aborted = "ABORTED"
+}
+export declare enum ResourceSnapshotsSynchronizationPlanStatus {
+    Creating = "CREATING",
+    Created = "CREATED",
+    InError = "IN_ERROR"
+}
+export declare enum ResourceSnapshotsReportType {
+    CreateSnapshot = "CREATE_SNAPSHOT",
+    DryRun = "DRY_RUN",
+    Apply = "APPLY",
+    CreateSynchronizationPlan = "CREATE_SYNCHRONIZATION_PLAN",
+    ApplySynchronizationPlan = "APPLY_SYNCHRONIZATION_PLAN"
+}
+export declare enum ResourceSnapshotSupportedFileTypes {
+    ZIP = "ZIP",
+    JSON = "JSON"
+}
+export declare enum ResourceSnapshotContentType {
+    PRIMARY = "PRIMARY",
+    CURRENT_STATE = "CURRENT_STATE"
+}
+export interface ResourceSnapshotsReportOperationModel {
+    /**
+     * The number of resources created by the operation.
+     */
+    resourcesCreated: number;
+    /**
+     * The number of resources deleted by the operation.
+     */
+    resourcesDeleted: number;
+    /**
+     * The number of resources for which an error occurred during the operation.
+     */
+    resourcesInError: number;
+    /**
+     * The number of pre-existing resources recreated by the operation. This happens when a resource cannot be updated. For example, it is not possible to rename a query pipeline, so in such a case the pipeline would be deleted and created again with the desired name. This operation counts as one recreation.
+     */
+    resourcesRecreated: number;
+    /**
+     * The number of resources unchanged by the operation.
+     */
+    resourcesUnchanged: number;
+    /**
+     * The number of resources updated by the operation.
+     */
+    resourcesUpdated: number;
+}
+export interface ResourceSnapshotsReportOperationResult {
+    /**
+     * The code of the error that occured.
+     */
+    resultCode: string;
+    /**
+     * A human-friendly message about the error.
+     */
+    message: string;
+}
+export type ResourceSnapshotsReportOperationResults = Record<string, ResourceSnapshotsReportOperationResult[]>;
+export declare enum SnapshotsReportStages {
+    COMPUTING_OPERATIONS = "COMPUTING_OPERATIONS",
+    CREATING_SNAPSHOT = "CREATING_SNAPSHOT",
+    INITIAL_PROCESSING = "INITIAL_PROCESSING",
+    PERFORMING_OPERATIONS = "PERFORMING_OPERATIONS",
+    SYNCHRONIZING = "SYNCHRONIZING",
+    VALIDATING_OPERATIONS = "VALIDATING_OPERATIONS"
+}
+export interface ResourceSnapshotsReportModel {
+    /**
+     * Current stage of the report
+     */
+    currentStage?: {
+        /**
+         * The progress type of the current step
+         */
+        progressType: 'BINARY' | 'PERCENTAGE';
+        /**
+         * The progress value of the current step
+         * The value can be percentage type (from 0 to 100) binary type (0 or 1)
+         */
+        progressValue: number;
+        /**
+         * Current step name
+         */
+        stage: SnapshotsReportStages;
+    };
+    /**
+     * The unique identifier of the report.
+     */
+    id: string;
+    /**
+     * For each type of resource, an object containing failure details, if applicable.
+     */
+    resourceOperationResults: Record<string, ResourceSnapshotsReportOperationResults>;
+    /**
+     * For each type of resource, a breakdown of the number of resources per operation.
+     */
+    resourceOperations: Record<string, ResourceSnapshotsReportOperationModel>;
+    /**
+     * The number of resources processed by the event.
+     */
+    resourcesProcessed: number;
+    /**
+     * The result code of the snapshot event, if applicable.
+     */
+    resultCode: ResourceSnapshotsReportResultCode;
+    /**
+     * The ordered stages the migration operation has to go through in order to complete.
+     */
+    stagesToExecute: SnapshotsReportStages[];
+    /**
+     * The start date ot the report in number of milliseconds since UNIX epoch.
+     */
+    startDate: number;
+    /**
+     * The status of the snapshot.
+     */
+    status: ResourceSnapshotsReportStatus;
+    /**
+     * The type of snapshot event.
+     */
+    type: ResourceSnapshotsReportType;
+    /**
+     * The report creation date in number of milliseconds since UNIX epoch.
+     */
+    updatedDate: number;
+}
+export interface ResourceSnapshotsSynchronizationReportModel {
+    id: string;
+    synchronizationPlanId: string;
+    linkOperations?: Record<string, unknown>;
+    linkOperationDetails?: Record<string, unknown>;
+    resourcesProcessed?: number;
+    resultCode: ResourceSnapshotsReportResultCode;
+    status: ResourceSnapshotsReportStatus;
+    type: ResourceSnapshotsReportType;
+    updatedDate: number;
+}
+export interface ResourceSnapshotsSynchronizationPlanModel {
+    id: string;
+    snapshotId: string;
+    status: ResourceSnapshotsSynchronizationPlanStatus;
+    alreadyLinkedResources?: Record<string, ResourceSnapshotsAlreadyLinkedResourcesModel[]>;
+    resourceSynchronizationOperations?: Record<string, ResourceSnapshotsSynchronizationOperationsModel[]>;
+}
+export interface ResourceSnapshotsSynchronizationOperationsModel {
+    resourceName: string;
+    displayName: string;
+    matches: ResourceSnapshotsSynchronizationMatchModel[];
+}
+export interface ResourceSnapshotsAlreadyLinkedResourcesModel {
+    resourceName: string;
+    linkModel: ResourceSnapshotsLinkModel;
+}
+export interface ResourceSnapshotsSynchronizationMatchModel {
+    associationScore?: number;
+    displayName?: string;
+    linkModel: ResourceSnapshotsLinkModel;
+}
+export interface ResourceSnapshotsLinkModel {
+    id?: string;
+    organizationId: string;
+    resourceId: string;
+    resourceName: string;
+    resourceType: string;
+}
+export interface ResourceSnapshotExportConfigurationModel {
+    resourcesToExport: Partial<Record<ResourceSnapshotType, string[] | null>>;
+}
+export interface ResourceSnapshotUrlModel {
+    url: string;
+    urlExpiration: number;
+}
+export interface SnapshotAccessModel {
+    allowed: boolean;
+}
+export interface SnapshotListParams {
+    filter?: string;
+    sortingOrder?: SortingOrder;
+    sortingType?: SnapshotSortingType;
+}
+export interface PushSnapshotOptions {
+    targetOrganizationId: string;
+    developerNotes?: string;
+}
+export interface CreateFromFileOptions {
+    developerNotes?: string;
+}
+export interface GetSnapshotOptions {
+    /**
+     * Whether to include reports with the snapshot.
+     *
+     * @default false
+     */
+    includeReports?: boolean;
+}
+export interface ExportSnapshotContentOptions {
+    /**
+     * The format of the snapshot content.
+     * - FLAT: Content unified into a single file
+     * - SPLIT_PER_TYPE: Content split into one file per resource type
+     *
+     * @default SnapshotExportContentFormat.Flat
+     */
+    contentFormat?: SnapshotExportContentFormat;
+}
+export interface ValidateAccessOptions {
+    snapshotAccessType: SnapshotAccessType;
+}
+export interface CreateFromOrganizationOptions {
+    developerNotes?: string;
+    targetOrganizationId?: string;
+    includeChildrenResources?: boolean;
+}
+export interface DryRunOptions {
+    deleteMissingResources: boolean;
+}
+export declare enum ApplyOptionsDeletionScope {
+    AllManagedResources = "ALL_MANAGED_RESOURCES",
+    OnlyTypesFromSnapshot = "ONLY_TYPES_FROM_SNAPSHOT"
+}
+export interface ApplyOptions {
+    /**
+     * Whether to delete organization resources not present in the snapshot.
+     *
+     * @default false
+     */
+    deleteMissingResources?: boolean;
+    /**
+     * The scope of the resources on which to calculate deletions.
+     * **Note:** only applies when `deleteMissingResources` is set to `true`.
+     *
+     * @default ApplyOptionsDeletionScope.AllManagedResources
+     *
+     */
+    deletionScope?: ApplyOptionsDeletionScope;
+}
+export interface GenerateUrlOptions {
+    contentType: ResourceSnapshotContentType;
+}
+export interface UpdateChildrenOptions {
+    snapshotParentResourceName: string;
+    parentResourceType: string;
+    targetParentId: string;
+}
+export interface SnapshotDiffFileModel extends ResourceSnapshotUrlModel {
+    numberOfLines: number;
+}
+export interface SnapshotDiffModel {
+    id: string;
+    snapshotId: string;
+    relativeReportId: string;
+    updatedDate: number;
+    status: ResourceSnapshotsReportStatus;
+    files: Partial<Record<ResourceSnapshotType, SnapshotDiffFileModel>>;
+}

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

@@ -0,0 +1,2 @@
+export * from './ResourceSnapshots.js';
+export * from './ResourceSnapshotsInterfaces.js';

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

@@ -0,0 +1,14 @@
+import { New } from '../BaseInterfaces.js';
+import { RealmModel } from '../Groups/index.js';
+import Resource from '../Resource.js';
+import { SamlIdentityProviderEnabledModel, SamlIdentityProviderModel } from './SamlInterfaces.js';
+export default class Saml extends Resource {
+    static baseUrl: string;
+    isEnabled(): Promise<SamlIdentityProviderEnabledModel>;
+    listAvailableProviders(): Promise<SamlIdentityProviderModel[]>;
+    deleteProvider(): Promise<Record<string, unknown>>;
+    getProvider(): Promise<SamlIdentityProviderModel>;
+    create(identityProvider: New<SamlIdentityProviderModel>): Promise<SamlIdentityProviderModel>;
+    update(identityProvider: SamlIdentityProviderModel): Promise<SamlIdentityProviderModel>;
+    listRealms(): Promise<RealmModel[]>;
+}

package/dist/types/resources/Saml/SamlInterfaces.d.ts

@@ -0,0 +1,13 @@
+import { IdAndDisplayNameModel } from '../BaseInterfaces.js';
+export interface SamlIdentityProviderEnabledModel {
+    organizationId: string;
+    samlEnabled: boolean;
+}
+export interface SamlIdentityProviderModel {
+    displayName: string;
+    entityId: string;
+    id: string;
+    organizationIds: IdAndDisplayNameModel[];
+    postBindingEndpoint: string;
+    x509Certificate: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './Saml.js';
+export * from './SamlInterfaces.js';

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

@@ -0,0 +1,61 @@
+import API from '../../APICore.js';
+import Ressource from '../Resource.js';
+import { New } from '../BaseInterfaces.js';
+import { SchemaEntities, SchemaServiceQueryParams, SchemaServiceSource, CreateSchemaSourceModel, CreateSchemaSourceOptions, ObjectsToGet, SchemaEntityFields, SimpleSchemaEntity, GetEntitiesQueryParams, GetEntityQueryParams, SlackTokenValidationResult } from './SchemaServiceInterfaces.js';
+import { SourceType } from '../Enums.js';
+export default class SchemaService extends Ressource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    constructor(api: API, serverlessApi: API);
+    /**
+     * Retrieve entities from the targeted instance
+     * (can be matches of a given query)
+     *
+     * @param {SourceType} sourceType
+     * @param {GetEntitiesQueryParams} [parameters]
+     * @return {SchemaEntities} schemaEntities
+     * @memberof SchemaService
+     */
+    getEntities(sourceType: SourceType, parameters?: GetEntitiesQueryParams): Promise<SchemaEntities>;
+    /**
+     * Retrieve the entity of matching ID from the targeted instance
+     *
+     * @param {SourceType} sourceType
+     * @param {string} entityId
+     * @param {GetEntityQueryParams} [parameters]
+     * @return {SimpleSchemaEntity} simpleSchemaEntity
+     * @memberof SchemaService
+     */
+    getEntity(sourceType: SourceType, entityId: string, parameters?: GetEntityQueryParams): Promise<SimpleSchemaEntity>;
+    /**
+     * Retrieve the fields of the given entity from the targeted instance
+     *
+     * @param {SourceType} sourceType
+     * @param {string} entityId
+     * @param {SchemaServiceQueryParams} [parameters]
+     * @return {SchemaEntityFields} schemaEntityFields
+     * @memberof SchemaService
+     */
+    getFields(sourceType: SourceType, entityId: string, parameters?: SchemaServiceQueryParams): Promise<SchemaEntityFields>;
+    delete(sourceId: string): Promise<Record<string, unknown>>;
+    get(sourceId: string): Promise<SchemaServiceSource>;
+    update(sourceId: string, source: CreateSchemaSourceModel, options?: CreateSchemaSourceOptions): Promise<{
+        id: string;
+    }>;
+    create(source: New<CreateSchemaSourceModel, 'resourceId'>, options?: CreateSchemaSourceOptions): Promise<{
+        id: string;
+    }>;
+    translateToSpecificObjectsToGet(sourceType: SourceType, genericObjectsToGet: ObjectsToGet): Promise<any>;
+    translateToSpecificObjectsToGetWithFields(sourceType: SourceType, genericObjectsToGet: ObjectsToGet, parameters?: SchemaServiceQueryParams): Promise<any>;
+    translateToGenericObjectsToGet(sourceType: SourceType, specificObjectsToGet: any): Promise<ObjectsToGet>;
+    /**
+     * Retrieve the default objectsToGet of the given sourceType
+     *
+     * @param {string} sourceType
+     * @return {ObjectsToGet} ObjectsToGet
+     * @memberof SchemaService
+     */
+    getDefaultObjectsToGet(sourceType: string): Promise<ObjectsToGet>;
+    validateSlackToken(accessToken: string): Promise<SlackTokenValidationResult>;
+}

package/dist/types/resources/SchemaService/SchemaServiceInterfaces.d.ts

@@ -0,0 +1,163 @@
+import { SourceModel, CreateSourceModel, CreateSourceOptions } from '../Sources/SourcesInterfaces.js';
+export interface SimpleSchemaEntity {
+    /**
+     * The id of the entity
+     * (equivalent to ServiceNow Name column)
+     */
+    id: string;
+    /**
+     * The name to be displayed of the entity
+     * (equivalent to ServiceNow Label column)
+     */
+    displayName: string;
+    /**
+     * The number of records that this entity represents
+     * This can be based on the filter sent to the schema-service
+     */
+    recordCount?: number;
+}
+export interface SchemaEntities {
+    /**
+     * A Record containing SimpleSchemaEntities, indexed by their id
+     */
+    entities: Record<string, SimpleSchemaEntity>;
+    /**
+     * The number of entities contained in the query ServiceNow instance
+     */
+    entitiesCount?: number;
+}
+export interface SchemaEntityField {
+    /**
+     * The id of the field
+     * (equivalent to the ServiceNow Label column)
+     */
+    id: string;
+    /**
+     * The name to be displayed of the field
+     * (equivalent to ServiceNow Label column)
+     */
+    displayName: string;
+    /**
+     * The Coveo type of the field
+     */
+    type: string;
+    /**
+     * The id of the entity this field references
+     */
+    reference?: string;
+    /**
+     * Marks fields indexed by default by the connector
+     */
+    isAlwaysIndexed?: boolean;
+}
+export interface SchemaEntityFields {
+    /**
+     * A Record containing SchemaEntityFields, indexed by their id
+     */
+    fields: Record<string, SchemaEntityField>;
+    /**
+     * The number of fields contained in the given entity
+     */
+    fieldsCount: number;
+}
+export interface SchemaServiceQueryParams {
+    instanceUrl: string;
+    username?: string;
+    passwordGuid?: string;
+    clientId?: string;
+    clientSecretGuid?: string;
+    oauthRefreshTokenGuid?: string;
+}
+export interface GetEntitiesQueryParams extends SchemaServiceQueryParams {
+    /**
+     * The offset from which to start retrieving entities
+     * (used for server-side pagination)
+     */
+    offset?: number;
+    /**
+     * The number of entities to fetch
+     * (used for server-side pagination)
+     */
+    limit?: number;
+    /**
+     * A query to fetch matching entity names and ids
+     */
+    query?: string;
+    /**
+     * IDs of the entities to retrieve, as a comma-separated list
+     */
+    entityIds?: string;
+}
+export interface GetEntityQueryParams extends SchemaServiceQueryParams {
+    /**
+     * A filter used to fetch the correct amount of records
+     */
+    filter?: string;
+}
+/**
+ * The object fields to be indexed
+ */
+export interface GenericObjectField {
+    name?: string;
+}
+/**
+ * The fields from other objects that have a junction relation to this one
+ */
+export interface GenericObjectRelation {
+    name?: string;
+    fields?: string[];
+    fromField?: string;
+    toField?: string;
+    toObject?: string;
+}
+/**
+ * The conditions that must be satisfied in order for the object to be indexed
+ */
+export interface GenericObjectCondition {
+    field?: string;
+    operator?: string;
+    type?: string;
+    values?: string[];
+}
+/**
+ * The generic format for a source's entity/object/table
+ */
+export interface GenericObject {
+    name?: string;
+    conditions?: GenericObjectCondition[];
+    fields?: GenericObjectField[];
+    relations?: GenericObjectRelation[];
+    /**
+     * The attachment field name
+     */
+    attachment?: string;
+    /**
+     * The filter applied to the records of the object
+     */
+    filter?: string;
+}
+export interface ObjectsToGet {
+    /**
+     * The list of objects/entities/tables to be indexed
+     */
+    objects?: GenericObject[];
+}
+export interface SchemaServiceSource extends SourceModel {
+    objectsToGet?: ObjectsToGet;
+}
+export interface CreateSchemaSourceModel extends CreateSourceModel {
+    /**
+     * A stringified version of the objectsToGet of a source
+     */
+    objectsToGetConfiguration?: string;
+}
+export interface CreateSchemaSourceOptions extends CreateSourceOptions {
+}
+/**
+ * Wraps whether or not a Slack token can validly be used with a Slack source
+ */
+export interface SlackTokenValidationResult {
+    valid: boolean;
+    workspace?: string;
+    reason?: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './SchemaService.js';
+export * from './SchemaServiceInterfaces.js';

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

@@ -0,0 +1,10 @@
+import { ListFieldValuesBodyQueryParams, PostSearchQuerySuggestBodyParams } from './index.js';
+import Ressource from '../Resource.js';
+import { RestQueryParams, RestTokenParams, TokenModel } from './SearchInterfaces.js';
+export default class Search extends Ressource {
+    static baseUrl: string;
+    createToken(tokenParams: RestTokenParams): Promise<TokenModel>;
+    getFieldValues(fieldName: string, params?: ListFieldValuesBodyQueryParams): Promise<any>;
+    query(restQueryParameters: RestQueryParams & any): Promise<any>;
+    querySuggestPost(restQuerySuggestParameters: PostSearchQuerySuggestBodyParams): Promise<any>;
+}