@coveo/platform-client 37.4.0 → 37.5.0-alpha.0

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

@@ -1,2 +1,2 @@
-export * from './Activities';
-export * from './ActivitiesInterfaces';
+export * from './Activities';
+export * from './ActivitiesInterfaces';

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

@@ -1,12 +1,12 @@
-import { New } from '../BaseInterfaces';
-import Resource from '../Resource';
-import { ApiKeyModel, CreateApiKeyOptions } from './ApiKeysInterfaces';
-export default class ApiKey extends Resource {
-    static baseUrl: string;
-    list(): Promise<ApiKeyModel[]>;
-    create(apiKey: New<ApiKeyModel, 'resourceId'>, options?: CreateApiKeyOptions): Promise<ApiKeyModel>;
-    get(apiKeyId: string): Promise<ApiKeyModel>;
-    update(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
-    toggle(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
-    delete(apiKeyId: string): Promise<Record<string, unknown>>;
-}
+import { New } from '../BaseInterfaces';
+import Resource from '../Resource';
+import { ApiKeyModel, CreateApiKeyOptions } from './ApiKeysInterfaces';
+export default class ApiKey extends Resource {
+    static baseUrl: string;
+    list(): Promise<ApiKeyModel[]>;
+    create(apiKey: New<ApiKeyModel, 'resourceId'>, options?: CreateApiKeyOptions): Promise<ApiKeyModel>;
+    get(apiKeyId: string): Promise<ApiKeyModel>;
+    update(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
+    toggle(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
+    delete(apiKeyId: string): Promise<Record<string, unknown>>;
+}

package/dist/definitions/resources/ApiKeys/ApiKeysInterfaces.d.ts

@@ -1,133 +1,133 @@
-import { GranularResource, PrivilegeModel } from '../BaseInterfaces';
-export interface ApiKeyModel extends GranularResource {
-    /**
-     * The unique identifier of the [organization](https://docs.coveo.com/en/222/) the API key was created for.
-     */
-    organizationId?: string;
-    /**
-     * The unique identifier of the API key.
-     *
-     * **Example:** t4hk287bfj5sg6wskg64ckk5a
-     */
-    id?: string;
-    /**
-     * Whether the API key is enabled.
-     */
-    enabled?: boolean;
-    /**
-     * The value of the API key.
-     *
-     * **Example:** xx65151ec3-7b30-4772-a99a-09b4c0f71343
-     */
-    value?: string;
-    /**
-     * The display name for the API key.
-     *
-     * **Example:** PushApiKey
-     */
-    displayName?: string;
-    /**
-     * A brief description of the API key.
-     *
-     * **Example:** API key used for managing sources.
-     */
-    description?: string;
-    /**
-     * The username or the email address that was used to create this API key.
-     */
-    createdBy?: any;
-    /**
-     * The API key creation date in Unix timestamp in milliseconds.
-     *
-     * **Example:** 1614969486000
-     */
-    createdDate?: number;
-    /**
-     * The approximate API key last used date in Unix timestamp in milliseconds.
-     *
-     * **Example:** 1624575600000
-     */
-    lastUsedDate?: number;
-    /**
-     * A set of IP addresses allowed to use the API key.
-     *
-     * **Notes:**
-     * - IP ranges using CIDR notation are also supported.
-     * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
-     *
-     * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
-     */
-    allowedIps?: string[];
-    /**
-     * A set of IP addresses that will be denied access when attempting to use the API key.
-     *
-     * **Notes:**
-     * - IP ranges using CIDR notation are also supported.
-     * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
-     *
-     * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
-     */
-    deniedIps?: string[];
-    /**
-     * A set of privileges.
-     */
-    privileges?: PrivilegeModel[];
-    /**
-     * The unique identifier of the API key.
-     *
-     * **Example:** t4hk287bfj5sg6wskg64ckk5a
-     */
-    resourceId?: string;
-    /**
-     * Additional configuration to be included in an API key. [to be revised]
-     */
-    additionalConfiguration?: AdditionalConfigurationModel;
-}
-export interface CreateApiKeyOptions {
-    /**
-     * The unique identifier of the template on which to base the API key.
-     */
-    apiKeyTemplateId?: string;
-}
-interface AdditionalConfigurationModel {
-    /**
-     * Configuration specific to commerce organization. [to be revised]
-     */
-    commerce?: CommerceConfigurationModel;
-    search?: SearchConfigurationModel;
-}
-interface CommerceConfigurationModel {
-    /**
-     * The catalog identifier to be linked to an API key. [to be revised]
-     */
-    catalogId: string;
-}
-interface SearchConfigurationModel {
-    apiKeyQueryAuthentication?: QueryAuthenticationModel[];
-    enforcedQueryPipelineConfiguration?: EnforceQueryPipelineConfigurationModel;
-    impersonationRestriction?: ImpersonationRestrictionsModel;
-}
-interface QueryAuthenticationModel {
-    /**
-     * Authentication name. [to be revised]
-     */
-    name: string;
-    /**
-     * Authentication provider. [to be revised]
-     */
-    provider: string;
-    /**
-     * Authentication type. [to be revised]
-     */
-    type: string;
-}
-interface EnforceQueryPipelineConfigurationModel {
-    /**
-     * Search hub name to be linked to an API key. [to be revised]
-     */
-    searchHub: string;
-}
-interface ImpersonationRestrictionsModel {
-    allowedUserIds: QueryAuthenticationModel[];
-}
-export {};
+import { GranularResource, PrivilegeModel } from '../BaseInterfaces';
+export interface ApiKeyModel extends GranularResource {
+    /**
+     * The unique identifier of the [organization](https://docs.coveo.com/en/222/) the API key was created for.
+     */
+    organizationId?: string;
+    /**
+     * The unique identifier of the API key.
+     *
+     * **Example:** t4hk287bfj5sg6wskg64ckk5a
+     */
+    id?: string;
+    /**
+     * Whether the API key is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * The value of the API key.
+     *
+     * **Example:** xx65151ec3-7b30-4772-a99a-09b4c0f71343
+     */
+    value?: string;
+    /**
+     * The display name for the API key.
+     *
+     * **Example:** PushApiKey
+     */
+    displayName?: string;
+    /**
+     * A brief description of the API key.
+     *
+     * **Example:** API key used for managing sources.
+     */
+    description?: string;
+    /**
+     * The username or the email address that was used to create this API key.
+     */
+    createdBy?: any;
+    /**
+     * The API key creation date in Unix timestamp in milliseconds.
+     *
+     * **Example:** 1614969486000
+     */
+    createdDate?: number;
+    /**
+     * The approximate API key last used date in Unix timestamp in milliseconds.
+     *
+     * **Example:** 1624575600000
+     */
+    lastUsedDate?: number;
+    /**
+     * A set of IP addresses allowed to use the API key.
+     *
+     * **Notes:**
+     * - IP ranges using CIDR notation are also supported.
+     * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
+     *
+     * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
+     */
+    allowedIps?: string[];
+    /**
+     * A set of IP addresses that will be denied access when attempting to use the API key.
+     *
+     * **Notes:**
+     * - IP ranges using CIDR notation are also supported.
+     * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
+     *
+     * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
+     */
+    deniedIps?: string[];
+    /**
+     * A set of privileges.
+     */
+    privileges?: PrivilegeModel[];
+    /**
+     * The unique identifier of the API key.
+     *
+     * **Example:** t4hk287bfj5sg6wskg64ckk5a
+     */
+    resourceId?: string;
+    /**
+     * Additional configuration to be included in an API key. [to be revised]
+     */
+    additionalConfiguration?: AdditionalConfigurationModel;
+}
+export interface CreateApiKeyOptions {
+    /**
+     * The unique identifier of the template on which to base the API key.
+     */
+    apiKeyTemplateId?: string;
+}
+interface AdditionalConfigurationModel {
+    /**
+     * Configuration specific to commerce organization. [to be revised]
+     */
+    commerce?: CommerceConfigurationModel;
+    search?: SearchConfigurationModel;
+}
+interface CommerceConfigurationModel {
+    /**
+     * The catalog identifier to be linked to an API key. [to be revised]
+     */
+    catalogId: string;
+}
+interface SearchConfigurationModel {
+    apiKeyQueryAuthentication?: QueryAuthenticationModel[];
+    enforcedQueryPipelineConfiguration?: EnforceQueryPipelineConfigurationModel;
+    impersonationRestriction?: ImpersonationRestrictionsModel;
+}
+interface QueryAuthenticationModel {
+    /**
+     * Authentication name. [to be revised]
+     */
+    name: string;
+    /**
+     * Authentication provider. [to be revised]
+     */
+    provider: string;
+    /**
+     * Authentication type. [to be revised]
+     */
+    type: string;
+}
+interface EnforceQueryPipelineConfigurationModel {
+    /**
+     * Search hub name to be linked to an API key. [to be revised]
+     */
+    searchHub: string;
+}
+interface ImpersonationRestrictionsModel {
+    allowedUserIds: QueryAuthenticationModel[];
+}
+export {};

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

@@ -1,2 +1,2 @@
-export * from './ApiKeys';
-export * from './ApiKeysInterfaces';
+export * from './ApiKeys';
+export * from './ApiKeysInterfaces';

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

@@ -1,51 +1,51 @@
-export declare type PageModel<T = any, TItemsKey extends string = 'items'> = {
-    [key in TItemsKey]: T[];
-} & {
-    totalEntries: number;
-    totalPages: number;
-};
-export declare type New<T, K extends string | number | symbol = null> = Omit<T, 'id' | K>;
-export interface IdAndDisplayNameModel {
-    id: string;
-    displayName?: string;
-}
-export interface PrivilegeModel {
-    /**
-     * The owner of the privilege.
-     * See [Valid Privilege owner, targetDomain, and type Combinations](https://docs.coveo.com/en/159/).
-     */
-    owner: string;
-    /**
-     * The target domain of the privilege.
-     * See [Valid Privilege owner, targetDomain, and type Combinations](https://docs.coveo.com/en/159/).
-     */
-    targetDomain: string;
-    /**
-     * The `displayName` of the source targeted by the privilege.
-     * Note: The wildcard character (`*`) will include all sources.
-     */
-    targetId?: string;
-    /**
-     * The type of the privilege.
-     * See [Valid Privilege owner, targetDomain, and type Combinations](https://docs.coveo.com/en/159/).
-     */
-    type?: string;
-    /**
-     * The access level of the global privileges.
-     */
-    level?: string;
-}
-export interface GranularResource {
-    apiKeysThatCanEdit?: IdAndDisplayNameModel[];
-    groupsThatCanEdit?: IdAndDisplayNameModel[];
-}
-export interface Paginated {
-    /**
-     * The 0-based index number of the page of elements to retrieve.
-     */
-    page?: number;
-    /**
-     * The number of elements to list per page.
-     */
-    perPage?: number;
-}
+export declare type PageModel<T = any, TItemsKey extends string = 'items'> = {
+    [key in TItemsKey]: T[];
+} & {
+    totalEntries: number;
+    totalPages: number;
+};
+export declare type New<T, K extends string | number | symbol = null> = Omit<T, 'id' | K>;
+export interface IdAndDisplayNameModel {
+    id: string;
+    displayName?: string;
+}
+export interface PrivilegeModel {
+    /**
+     * The owner of the privilege.
+     * See [Valid Privilege owner, targetDomain, and type Combinations](https://docs.coveo.com/en/159/).
+     */
+    owner: string;
+    /**
+     * The target domain of the privilege.
+     * See [Valid Privilege owner, targetDomain, and type Combinations](https://docs.coveo.com/en/159/).
+     */
+    targetDomain: string;
+    /**
+     * The `displayName` of the source targeted by the privilege.
+     * Note: The wildcard character (`*`) will include all sources.
+     */
+    targetId?: string;
+    /**
+     * The type of the privilege.
+     * See [Valid Privilege owner, targetDomain, and type Combinations](https://docs.coveo.com/en/159/).
+     */
+    type?: string;
+    /**
+     * The access level of the global privileges.
+     */
+    level?: string;
+}
+export interface GranularResource {
+    apiKeysThatCanEdit?: IdAndDisplayNameModel[];
+    groupsThatCanEdit?: IdAndDisplayNameModel[];
+}
+export interface Paginated {
+    /**
+     * The 0-based index number of the page of elements to retrieve.
+     */
+    page?: number;
+    /**
+     * The number of elements to list per page.
+     */
+    perPage?: number;
+}

package/dist/definitions/resources/CaseAssistConfigs/CaseAssistConfig.d.ts

@@ -1,16 +1,16 @@
-import { New, PageModel } from '../BaseInterfaces';
-import Resource from '../Resource';
-import { CaseAssistConfigListOptions, CaseAssistConfigModel, SuggestionRequestBody } from './CaseAssistConfigInterfaces';
-import { PreviewRequestBody, DocumentSuggestions, CaseClassifications } from './CaseAssistPreviewInterfaces';
-export default class CaseAssistConfig extends Resource {
-    static baseUrl: string;
-    list(options?: CaseAssistConfigListOptions): Promise<PageModel<CaseAssistConfigModel, "configurations">>;
-    create(caseAssistConfig: New<CaseAssistConfigModel>): Promise<CaseAssistConfigModel>;
-    delete(caseAssistConfigId: string): Promise<Record<string, unknown>>;
-    get(caseAssistConfigId: string): Promise<CaseAssistConfigModel>;
-    update(caseAssistConfig: CaseAssistConfigModel): Promise<CaseAssistConfigModel>;
-    classify(caseAssistConfigId: string, body: SuggestionRequestBody): Promise<CaseClassifications>;
-    suggestDocuments(caseAssistConfigId: string, body: SuggestionRequestBody): Promise<DocumentSuggestions>;
-    previewDocumentSuggestion(body: PreviewRequestBody): Promise<DocumentSuggestions>;
-    previewCaseClassication(body: PreviewRequestBody): Promise<CaseClassifications>;
-}
+import { New, PageModel } from '../BaseInterfaces';
+import Resource from '../Resource';
+import { CaseAssistConfigListOptions, CaseAssistConfigModel, SuggestionRequestBody } from './CaseAssistConfigInterfaces';
+import { PreviewRequestBody, DocumentSuggestions, CaseClassifications } from './CaseAssistPreviewInterfaces';
+export default class CaseAssistConfig extends Resource {
+    static baseUrl: string;
+    list(options?: CaseAssistConfigListOptions): Promise<PageModel<CaseAssistConfigModel, "configurations">>;
+    create(caseAssistConfig: New<CaseAssistConfigModel>): Promise<CaseAssistConfigModel>;
+    delete(caseAssistConfigId: string): Promise<Record<string, unknown>>;
+    get(caseAssistConfigId: string): Promise<CaseAssistConfigModel>;
+    update(caseAssistConfig: CaseAssistConfigModel): Promise<CaseAssistConfigModel>;
+    classify(caseAssistConfigId: string, body: SuggestionRequestBody): Promise<CaseClassifications>;
+    suggestDocuments(caseAssistConfigId: string, body: SuggestionRequestBody): Promise<DocumentSuggestions>;
+    previewDocumentSuggestion(body: PreviewRequestBody): Promise<DocumentSuggestions>;
+    previewCaseClassication(body: PreviewRequestBody): Promise<CaseClassifications>;
+}

package/dist/definitions/resources/CaseAssistConfigs/CaseAssistConfigInterfaces.d.ts

@@ -1,59 +1,59 @@
-import { Paginated } from '../BaseInterfaces';
-export declare enum DocumentSuggestionsStrategies {
-    ITD = "ITD"
-}
-export declare enum TypingAidsStrategies {
-    StaticValues = "StaticValues",
-    ValuesFromIndex = "ValuesFromIndex"
-}
-export declare enum CaseClassificationStrategies {
-    Some = "Some",
-    Axon = "Axon"
-}
-export interface CaseAssistConfigListOptions extends Paginated {
-}
-export interface ITDConfigurationModel {
-    pipeline?: string;
-    filter?: string;
-    strategy: DocumentSuggestionsStrategies;
-}
-export interface StaticValuesConfigurationModel {
-    values: string[];
-    strategy: TypingAidsStrategies;
-}
-export interface ValuesFromIndexConfigurationModel {
-    filter: string;
-    field: string;
-    strategy: TypingAidsStrategies;
-}
-export interface FieldToPredict {
-    name: string;
-}
-export interface CaseClassificationSomeConfigurationModel {
-    filter?: string;
-    fieldsToPredict?: FieldToPredict[];
-    strategy: CaseClassificationStrategies;
-}
-export interface CaseClassificationAxonConfigurationModel {
-    modelId: string;
-    strategy: CaseClassificationStrategies;
-}
-export declare type TypingAidsConfigurations = StaticValuesConfigurationModel | ValuesFromIndexConfigurationModel;
-export declare type DocumentSuggestionsConfigurations = ITDConfigurationModel;
-export declare type CaseClassificationConfiguration = CaseClassificationSomeConfigurationModel | CaseClassificationAxonConfigurationModel;
-export interface CaseAssistConfigModel {
-    id: string;
-    name: string;
-    documentSuggestionConfiguration?: DocumentSuggestionsConfigurations;
-    typingAidsConfiguration?: TypingAidsConfigurations;
-    classificationConfigurations?: CaseClassificationConfiguration[];
-}
-export interface ContextField {
-    value: string;
-}
-export declare type ContextFields = Record<string, ContextField>;
-export interface SuggestionRequestBody {
-    visitorId: string;
-    locale: string;
-    fields: ContextFields;
-}
+import { Paginated } from '../BaseInterfaces';
+export declare enum DocumentSuggestionsStrategies {
+    ITD = "ITD"
+}
+export declare enum TypingAidsStrategies {
+    StaticValues = "StaticValues",
+    ValuesFromIndex = "ValuesFromIndex"
+}
+export declare enum CaseClassificationStrategies {
+    Some = "Some",
+    Axon = "Axon"
+}
+export interface CaseAssistConfigListOptions extends Paginated {
+}
+export interface ITDConfigurationModel {
+    pipeline?: string;
+    filter?: string;
+    strategy: DocumentSuggestionsStrategies;
+}
+export interface StaticValuesConfigurationModel {
+    values: string[];
+    strategy: TypingAidsStrategies;
+}
+export interface ValuesFromIndexConfigurationModel {
+    filter: string;
+    field: string;
+    strategy: TypingAidsStrategies;
+}
+export interface FieldToPredict {
+    name: string;
+}
+export interface CaseClassificationSomeConfigurationModel {
+    filter?: string;
+    fieldsToPredict?: FieldToPredict[];
+    strategy: CaseClassificationStrategies;
+}
+export interface CaseClassificationAxonConfigurationModel {
+    modelId: string;
+    strategy: CaseClassificationStrategies;
+}
+export declare type TypingAidsConfigurations = StaticValuesConfigurationModel | ValuesFromIndexConfigurationModel;
+export declare type DocumentSuggestionsConfigurations = ITDConfigurationModel;
+export declare type CaseClassificationConfiguration = CaseClassificationSomeConfigurationModel | CaseClassificationAxonConfigurationModel;
+export interface CaseAssistConfigModel {
+    id: string;
+    name: string;
+    documentSuggestionConfiguration?: DocumentSuggestionsConfigurations;
+    typingAidsConfiguration?: TypingAidsConfigurations;
+    classificationConfigurations?: CaseClassificationConfiguration[];
+}
+export interface ContextField {
+    value: string;
+}
+export declare type ContextFields = Record<string, ContextField>;
+export interface SuggestionRequestBody {
+    visitorId: string;
+    locale: string;
+    fields: ContextFields;
+}

package/dist/definitions/resources/CaseAssistConfigs/CaseAssistPreviewInterfaces.d.ts

@@ -1,27 +1,27 @@
-import { New } from '../BaseInterfaces';
-import { CaseAssistConfigModel, ContextFields } from './CaseAssistConfigInterfaces';
-export interface Document {
-    title: string;
-    clickUri: string;
-    excerpt: string;
-    fields: Record<string, number | string>;
-}
-export interface DocumentSuggestions {
-    documents: Document[];
-    totalCount: number;
-}
-export interface FieldValueSuggestion {
-    predictions: Array<{
-        value: string;
-        confidence: number;
-    }>;
-}
-export interface CaseClassifications {
-    fields: Record<string, FieldValueSuggestion>;
-}
-export interface PreviewRequestBody {
-    visitorId: string;
-    locale: string;
-    fields: ContextFields;
-    configuration: New<CaseAssistConfigModel>;
-}
+import { New } from '../BaseInterfaces';
+import { CaseAssistConfigModel, ContextFields } from './CaseAssistConfigInterfaces';
+export interface Document {
+    title: string;
+    clickUri: string;
+    excerpt: string;
+    fields: Record<string, number | string>;
+}
+export interface DocumentSuggestions {
+    documents: Document[];
+    totalCount: number;
+}
+export interface FieldValueSuggestion {
+    predictions: Array<{
+        value: string;
+        confidence: number;
+    }>;
+}
+export interface CaseClassifications {
+    fields: Record<string, FieldValueSuggestion>;
+}
+export interface PreviewRequestBody {
+    visitorId: string;
+    locale: string;
+    fields: ContextFields;
+    configuration: New<CaseAssistConfigModel>;
+}

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

@@ -1,3 +1,3 @@
-export * from './CaseAssistConfig';
-export * from './CaseAssistConfigInterfaces';
-export * from './CaseAssistPreviewInterfaces';
+export * from './CaseAssistConfig';
+export * from './CaseAssistConfigInterfaces';
+export * from './CaseAssistPreviewInterfaces';