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

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

@@ -0,0 +1,8 @@
+export * from './Pipelines.js';
+export * from './PipelinesInterfaces.js';
+export * from './MLAssociations/index.js';
+export * from './Statements/index.js';
+export * from './ResultRankings/index.js';
+export * from './Conditions/index.js';
+export * from './StatementGroups/index.js';
+export * from './FacetStateRules/index.js';

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

@@ -0,0 +1,99 @@
+import Access from './OrganizationAccess/Access.js';
+import Activity from './Activities/Activities.js';
+import API from '../APICore.js';
+import ApiKey from './ApiKeys/ApiKeys.js';
+import AWS from './AWS/AWS.js';
+import CaseAssistConfig from './CaseAssistConfigs/CaseAssistConfig.js';
+import Catalog from './Catalogs/Catalog.js';
+import CatalogConfiguration from './Catalogs/CatalogConfiguration.js';
+import Cluster from './Clusters/Cluster.js';
+import Connectivity from './Connectivity/Connectivity.js';
+import CrawlingModule from './CrawlingModule/CrawlingModule.js';
+import Extensions from './Extensions/Extensions.js';
+import Field from './Fields/Fields.js';
+import Global from './Global/Global.js';
+import GlobalGroup from './GlobalGroups/GlobalGroup.js';
+import Group from './Groups/Groups.js';
+import Index from './Indexes/Indexes.js';
+import InProductExperiences from './InProductExperiences/InProductExperiences.js';
+import InsightPanelConfig from './InsightPanelConfigs/InsightPanelConfig.js';
+import InsightPanelInterface from './InsightPanelInterfaces/InsightPanelInterface.js';
+import License from './License/License.js';
+import Limits from './Limits/Limits.js';
+import Links from './Links/Links.js';
+import Logs from './Logs/Logs.js';
+import MachineLearning from './MachineLearning/MachineLearning.js';
+import ModifierTemplates from './ModifierTemplates/ModifierTemplates.js';
+import Notifications from './Notification/notification.js';
+import Organization from './Organizations/Organization.js';
+import Pipelines from './Pipelines/Pipelines.js';
+import PrivilegeEvaluator from './PrivilegeEvaluator/PrivilegeEvaluator.js';
+import ProductListing from './Catalogs/ProductListing.js';
+import ProductListingConfiguration from './Catalogs/ProductListingConfiguration.js';
+import Products from './Products/Product.js';
+import PushApi from './PushApi/PushApi.js';
+import ResourceSnapshots from './ResourceSnapshots/ResourceSnapshots.js';
+import Saml from './Saml/Saml.js';
+import SchemaService from './SchemaService/SchemaService.js';
+import Search from './Search/Search.js';
+import SearchInterfaces from './SearchInterfaces/SearchInterfaces.js';
+import SearchPages from './SearchPages/SearchPages.js';
+import SearchUsageMetrics from './SearchUsageMetrics/SearchUsageMetrics.js';
+import SecurityCache from './SecurityCache/SecurityCache.js';
+import Sources from './Sources/Sources.js';
+import UsageAnalytics from './UsageAnalytics/UsageAnalytics.js';
+import User from './Users/User.js';
+import Vaults from './Vaults/Vaults.js';
+import TableauService from './TableauService/TableauService.js';
+declare class PlatformResources {
+    protected API: API;
+    protected ServerlessAPI: API;
+    activity: Activity;
+    apiKey: ApiKey;
+    aws: AWS;
+    caseAssistConfig: CaseAssistConfig;
+    catalog: Catalog;
+    catalogConfiguration: CatalogConfiguration;
+    cluster: Cluster;
+    crawlingModule: CrawlingModule;
+    connectivity: Connectivity;
+    extension: Extensions;
+    field: Field;
+    global: Global;
+    globalGroup: GlobalGroup;
+    group: Group;
+    index: Index;
+    insightPanelConfig: InsightPanelConfig;
+    insightPanelInterface: InsightPanelInterface;
+    ipx: InProductExperiences;
+    license: License;
+    limits: Limits;
+    links: Links;
+    logs: Logs;
+    ml: MachineLearning;
+    modifierTemplates: ModifierTemplates;
+    notification: Notifications;
+    organization: Organization;
+    organizationAccess: Access;
+    pipeline: Pipelines;
+    privilegeEvaluator: PrivilegeEvaluator;
+    productListing: ProductListing;
+    productListingConfiguration: ProductListingConfiguration;
+    products: Products;
+    pushApi: PushApi;
+    resourceSnapshot: ResourceSnapshots;
+    saml: Saml;
+    schemaService: SchemaService;
+    search: Search;
+    searchInterfaces: SearchInterfaces;
+    searchPages: SearchPages;
+    searchUsageMetrics: SearchUsageMetrics;
+    securityCache: SecurityCache;
+    source: Sources;
+    ua: UsageAnalytics;
+    user: User;
+    vault: Vaults;
+    tableauService: TableauService;
+    registerAll(): void;
+}
+export default PlatformResources;

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

@@ -0,0 +1,11 @@
+import Ressource from '../Resource.js';
+import { PrivilegeEvaluatorModel } from './PrivilegeEvaluatorInterfaces.js';
+export default class PrivilegeEvaluator extends Ressource {
+    static baseUrl: string;
+    /**
+     * Evaluates a specific privilege request
+     *
+     * @param {RestTokenParams} privilegeEvaluatorParams The privilege request to evaluate
+     */
+    evaluate(privilegeEvaluatorParams: PrivilegeEvaluatorModel): Promise<PrivilegeEvaluatorModel>;
+}

package/dist/types/resources/PrivilegeEvaluator/PrivilegeEvaluatorInterfaces.d.ts

@@ -0,0 +1,29 @@
+import { PrivilegeModel } from '../BaseInterfaces.js';
+export interface PrivilegeEvaluatorModel {
+    /**
+     * Whether the request has been approved.
+     */
+    approved?: boolean;
+    /**
+     * A privilege request evaluation report.
+     */
+    evaluationReport?: PrivilegeRequestEvaluationReportModel;
+    /**
+     * The unique identifier of the organization in which the target privilege applies.
+     */
+    organizationId?: string;
+    /**
+     * The unique identifier of the organization in which the target privilege applies.
+     */
+    requestedPrivilege: PrivilegeModel;
+}
+export declare enum PrivilegeRequestEvaluationReportModel {
+    operationForbiddenForAnonymousAuthentication = "OPERATION_FORBIDDEN_FOR_ANONYMOUS_AUTHENTICATION",
+    operationForbiddenForAuthenticationBoundToDifferentOrganization = "OPERATION_FORBIDDEN_FOR_AUTHENTICATION_BOUND_TO_DIFFERENT_ORGANIZATION",
+    operationForbiddenForOrganization = "OPERATION_FORBIDDEN_FOR_ORGANIZATION",
+    operationForbiddenForOrganizationInReadOnly = "OPERATION_FORBIDDEN_FOR_ORGANIZATION_IN_READ_ONLY",
+    operationForbiddenFromRequestLocation = "OPERATION_FORBIDDEN_FROM_REQUEST_LOCATION",
+    operationForbiddenInvalidPrivilegeRequest = "OPERATION_FORBIDDEN_INVALID_PRIVILEGE_REQUEST",
+    operationGranted = "OPERATION_GRANTED",
+    operationNotAllowed = "OPERATION_NOT_ALLOWED"
+}

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

@@ -0,0 +1,2 @@
+export * from './PrivilegeEvaluator.js';
+export * from './PrivilegeEvaluatorInterfaces.js';

package/dist/types/resources/Products/Product.d.ts

@@ -0,0 +1,7 @@
+import { New } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import { ProductsRequestModel, ProductsResultModel } from './ProductInterfaces.js';
+export default class Products extends Resource {
+    static baseUrl: string;
+    get(productsRequest: New<ProductsRequestModel>, refreshCache?: boolean): Promise<ProductsResultModel>;
+}

package/dist/types/resources/Products/ProductInterfaces.d.ts

@@ -0,0 +1,209 @@
+import { ProductsFacetRequestSortType, ProductsSortByType, SortingOrder } from '../Enums.js';
+export interface AdvancedFiltersModel {
+    queryFilter: string;
+}
+export interface AdvancedParametersModel {
+    /**
+     * Used to retrieve debug information. Will have an impact on query performance.
+     */
+    debug?: boolean;
+    /**
+     * Used to retrieve all documents regardless of their security model.
+     */
+    viewAllContent?: boolean;
+}
+export interface FacetRequestOptions {
+    /**
+     * Whether to take into account the scores generated by the index when reordering facets.
+     */
+    enableIndexFacetOrdering?: boolean;
+    /**
+     * Whether facets should be returned in the same order in which they were requested.
+     */
+    freezeFacetOrder?: boolean;
+}
+export interface FacetRequestItem {
+    /**
+     * The values displayed by the facet in the search interface at the moment of the request.
+     */
+    currentValues?: any[];
+    /**
+     * A custom sort order for the facet values.
+     */
+    customOrder?: string[];
+    /**
+     * The unique identifier of the facet in the search interface.
+     */
+    facetId?: string;
+    /**
+     * The name of the field on which to base the facet request.
+     */
+    field: string;
+    /**
+     * Whether the facet is expanded in the search interface at the moment of the request.
+     */
+    isFieldExpanded?: boolean;
+    /**
+     * The maximum number of facet values to fetch.
+     */
+    numberOfValues?: number;
+    /**
+     * Whether to prevent Coveo ML from automatically selecting facet values.
+     */
+    preventAutoSelect?: boolean;
+    /**
+     * The criterion to use for sorting returned facet values.
+     */
+    sortCriteria?: ProductsFacetRequestSortType;
+}
+export interface FacetsRequestModel {
+    /**
+     * The facet options to add to the request.
+     */
+    options?: FacetRequestOptions;
+    /**
+     * The facet operations to perform on the products listings.
+     */
+    requests: FacetRequestItem[];
+}
+export interface PaginatedModel {
+    /**
+     * The number of elements to list per page.
+     */
+    numberOfValues?: number;
+    /**
+     * The 0-based index number of the page of elements to retrieve.
+     */
+    page?: number;
+}
+export interface SortByFields {
+    /**
+     * The name of the field.
+     */
+    name: string;
+    /**
+     * The sorting direction.
+     */
+    direction: SortingOrder;
+}
+export interface SortModel {
+    /**
+     * The name of the field to sort by.
+     */
+    by: ProductsSortByType;
+    /**
+     * The fields to take into consideration when sorting.
+     */
+    fields?: SortByFields[];
+}
+export interface ProductsRequestModel {
+    /**
+     * Additional fields allow you to collect additional information, besides the standard data.
+     */
+    additionalFields?: string[];
+    /**
+     *
+     */
+    advancedFiltersModel?: AdvancedFiltersModel;
+    /**
+     * Advanced parameters to retrieve more information from the search queries.
+     */
+    advancedParameters?: AdvancedParametersModel;
+    /**
+     * An anonymous identifier used to determine from which identity the query comes from.
+     */
+    clientId?: string;
+    /**
+     * Parameters related to the facet request.
+     */
+    facets?: FacetsRequestModel;
+    /**
+     * Pagination parameters for the returned products.
+     */
+    pagination?: PaginatedModel;
+    /**
+     * Determines the order in which to retrieve the results.
+     */
+    sort?: SortModel;
+    /**
+     * The URL used to retrieve the products listings.
+     */
+    url: string;
+}
+export interface FacetResultModel {
+    facetId: string;
+    field: string;
+    fromAutoSelect: boolean;
+    indexScore: number;
+    mlScore: number;
+    moreValuesAvailable: boolean;
+    values: any[];
+}
+export interface FacetResponseModel {
+    /**
+     * A list of facet results.
+     */
+    results: FacetResultModel[];
+}
+export interface PaginationResultModel {
+    /**
+     * The number of elements.
+     */
+    totalCount: number;
+}
+export interface ProductListingIdentityModel {
+    /**
+     * Associated catalog id.
+     */
+    catalogId: string;
+    /**
+     * The product listing unique id.
+     */
+    id: string;
+}
+export interface ProductModel {
+    additionalFields: Map<string, any>;
+    childResults: ProductModel[];
+    clickUri: string;
+    ec_brand: string;
+    ec_category: string[];
+    ec_cogs: number;
+    ec_description: string;
+    ec_images: string[];
+    ec_in_stock: boolean;
+    ec_item_group_id: string;
+    ec_name: string;
+    ec_price: number;
+    ec_promo_price: number;
+    ec_rating: number;
+    ec_shortdesc: string;
+    ec_thumbnails: string[];
+    permanentid: string;
+    totalNumberOfChildResults: number;
+}
+export interface ProductsResultModel {
+    /**
+     * The execution report.
+     */
+    executionReport: Map<string, any>;
+    /**
+     * The list of facet results.
+     */
+    facets: FacetResponseModel;
+    /**
+     * The number of total elements returned.
+     */
+    pagination: PaginationResultModel;
+    /**
+     * The product listing identity model.
+     */
+    productListing: ProductListingIdentityModel;
+    /**
+     * A list of products.
+     */
+    products: ProductModel[];
+    /**
+     * The response unique id.
+     */
+    responseId: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './Product.js';
+export * from './ProductInterfaces.js';

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

@@ -0,0 +1,10 @@
+import Resource from '../Resource.js';
+import { SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces.js';
+export default class PushApi extends Resource {
+    static baseUrl: string;
+    createOrUpdateSecurityIdentityAlias(securityProviderId: string, alias: SecurityIdentityAliasModel, options?: SecurityIdentityOptions): Promise<void>;
+    deleteSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityDelete, options?: SecurityIdentityOptions): Promise<void>;
+    createOrUpdateSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel, options?: SecurityIdentityOptions): Promise<void>;
+    manageSecurityIdentities(securityProviderId: string, batchConfig: SecurityIdentityBatchConfig): Promise<void>;
+    deleteOldSecurityIdentities(securityProviderId: string, batchDelete: SecurityIdentityDeleteOptions): Promise<void>;
+}

package/dist/types/resources/PushApi/PushApiInterfaces.d.ts

@@ -0,0 +1,37 @@
+import { SinglePermissionResult, SinglePermissionIdentityType } from '../Enums.js';
+export interface SecurityIdentityAliasModel extends SecurityIdentityBase {
+    mappings: AliasMappings;
+}
+export interface SecurityIdentityModel extends SecurityIdentityBase {
+    members?: Identity[];
+}
+export interface SecurityIdentityDelete {
+    identity: Identity;
+}
+export interface SecurityIdentityDeleteOptions extends Required<SecurityIdentityOptions> {
+    queueDelay?: number;
+}
+export interface SecurityIdentityOptions {
+    orderingId?: number;
+}
+export interface SecurityIdentityBatchConfig {
+    fileId: string;
+    orderingId?: string;
+}
+interface SecurityIdentityBase {
+    Result?: {
+        errorDetails: string;
+        result: SinglePermissionResult;
+    };
+    identity?: Identity;
+    wellKnowns?: Identity[];
+}
+interface AliasMappings extends Identity {
+    provider: string;
+}
+interface Identity {
+    additionalInfo: Record<string, string>;
+    name: string;
+    type: SinglePermissionIdentityType;
+}
+export {};

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

@@ -0,0 +1,2 @@
+export * from './PushApi.js';
+export * from './PushApiInterfaces.js';

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

@@ -0,0 +1,10 @@
+import API from '../APICore.js';
+declare class Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    constructor(api: API, serverlessApi: API);
+    protected buildPath(route: string, parameters: any): string;
+    private convertObjectToQueryString;
+}
+export default Resource;

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

@@ -0,0 +1,52 @@
+import Resource from '../Resource.js';
+import { ApplyOptions, CreateFromFileOptions, CreateFromOrganizationOptions, DryRunOptions, ExportSnapshotContentOptions, GenerateUrlOptions, GetSnapshotOptions, PushSnapshotOptions, ResourceSnapshotExportConfigurationModel, ResourceSnapshotsModel, ResourceSnapshotsReportModel, ResourceSnapshotsSynchronizationPlanModel, ResourceSnapshotsSynchronizationReportModel, ResourceSnapshotType, ResourceSnapshotUrlModel, SnapshotAccessModel, SnapshotDiffModel, SnapshotListParams, UpdateChildrenOptions, ValidateAccessOptions } from './ResourceSnapshotsInterfaces.js';
+export default class ResourceSnapshots extends Resource {
+    static baseUrl: string;
+    list(params?: SnapshotListParams): Promise<ResourceSnapshotsModel[]>;
+    get(snapshotId: string, options?: GetSnapshotOptions): Promise<ResourceSnapshotsModel>;
+    /**
+     * Lists the resources that the authenticated user can leverage in snapshots in the target organization.
+     */
+    listResourceAccess(): Promise<ResourceSnapshotType[]>;
+    /**
+     * Shows whether the authenticated user has the specified access level (i.e., read or write) to the content of the target snapshot.
+     */
+    validateAccess(snapshotId: string, options: ValidateAccessOptions): Promise<SnapshotAccessModel>;
+    /**
+     * Retrieves a ZIP file holding the content of the target snapshot, in the target format.
+     *
+     * @param {string} snapshotId The unique identifier of the target snapshot.
+     * @param {ExportSnapshotContentOptions} [options]
+     * @returns {Promise<Blob>} A newly created Blob object which contains the zipped snapshot
+     */
+    export(snapshotId: string, options?: ExportSnapshotContentOptions): Promise<Blob>;
+    getContent(snapshotId: string, options: GenerateUrlOptions): Promise<Response>;
+    /**
+     * Creates a snapshot from a file containing the configuration.
+     *
+     * @param {File} file The file containing the configuration.
+     * @param {CreateFromFileOptions} options
+     */
+    createFromFile(file: File, options?: CreateFromFileOptions): Promise<ResourceSnapshotsModel>;
+    createFromOrganization(exportConfigurationModel: ResourceSnapshotExportConfigurationModel, options: CreateFromOrganizationOptions): Promise<ResourceSnapshotsModel>;
+    generateUrl(snapshotId: string, options: GenerateUrlOptions): Promise<ResourceSnapshotUrlModel>;
+    dryRun(snapshotId: string, options: DryRunOptions): Promise<ResourceSnapshotsReportModel>;
+    apply(snapshotId: string, options: ApplyOptions): Promise<ResourceSnapshotsReportModel>;
+    push(snapshotId: string, options: PushSnapshotOptions): Promise<Record<string, unknown>>;
+    delete(snapshotId: string): Promise<Record<string, unknown>>;
+    createSynchronizationPlan(snapshotId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    getSynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    updateSynchronizationPlan(snapshotId: string, synchronizationPlanId: string, synchronizationPlanModel: ResourceSnapshotsSynchronizationPlanModel): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    applySynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationReportModel>;
+    updateSynchronizationPlanForChildren(snapshotId: string, synchronizationPlanId: string, options: UpdateChildrenOptions): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    private getSnapshotFileType;
+    /**
+     * @description Shows the diff report for the target snapshot and dry-run report
+     * @experimental
+     *
+     * @param {string} snapshotId - The unique identifier of the target snapshot.
+     * @param {string} relativeReportId - The unique identifier of the dry-run operation report associated with the target diff report.
+     * @param {(number|undefined)} [numberOfLinesMax=undefined] - Maximum number of lines before the diff is downloaded to a file.
+     */
+    diff(snapshotId: string, relativeReportId: string, numberOfLinesMax?: number): Promise<SnapshotDiffModel>;
+}