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

package/dist/definitions/resources/Organizations/OrganizationInterfaces.d.ts

@@ -1,176 +1,176 @@
-import { Paginated } from '../BaseInterfaces';
-import { LicenseModel } from '../License';
-import { ModifierModel, ModifierStatementModel } from '../ModifierTemplates/ModifierTemplateInterfaces';
-/**
- * Describes the status of an organization.
- */
-export interface OrganizationsStatusModel {
-    /**
-     * A list of error codes that are present in the organization at the time of the request.
-     *
-     * **Allowed values:**
-     * - `SEARCH_ERROR`: An error occurred during a search request.
-     * - `PAUSING_FAILED`: An error occurred when attempting to pause the organization.
-     * - `RESUMING_FAILED`: An error occurred when attempting to resume the organization.
-     */
-    errorCodes: string[];
-    /**
-     * The life-cycle state of the organization.
-     *
-     * **Allowed values:**
-     * - `ACTIVE`: The organization is healthy and fully functional.
-     * - `PAUSED`: The organization is currently inactive.
-     * - `DELETING`: The organization is currently in the process of being deleted.
-     *
-     * @example `PAUSED`
-     */
-    lifeCycleState: string;
-    /**
-     * The pause status of the organization.
-     *
-     * **Allowed values:**
-     * - `ACTIVE`: The organization is active.
-     * - `IDLE`: The organization is inactive.
-     * - `PAUSING`: The organization is transitioning to `PAUSED`.
-     * - `PAUSED`: The organization is paused.
-     * - `RESUMING`: The organization is transitioning to `ACTIVE`.
-     * - `PAUSING_FAILED`: The organization threw an error while transitioning to `PAUSED`.
-     * - `RESUMING_FAILED`: The organization threw an error while transitioning to `ACTIVE`.
-     *
-     * @example `PAUSED`
-     */
-    pauseState: string;
-    /**
-     * Whether the organization is currently paused.
-     */
-    paused: boolean;
-    /**
-     * The provisioning status of the organization.
-     */
-    provisioningStatus: {
-        /**
-         * The progress, in percentage, of the ongoing provisioning.
-         *
-         * @example `100`
-         */
-        currentProvisioningProgress: number;
-        /**
-         * Whether the initial provisioning has been completed.
-         */
-        initialProvisioningDone: boolean;
-        /**
-         * The last time provisioning was successfully completed in number of milliseconds since UNIX epoch.
-         *
-         * @example `1556722921779`
-         */
-        lastProvisioningCompletedDate: number;
-        /**
-         * Whether the provisioning is currently ongoing.
-         */
-        ongoing: boolean;
-        /**
-         * The status of the last provisioning.
-         *
-         * **Allowed values:**
-         * - `ERROR`: The last provisioning failed with an error.
-         * - `HEALTHY`: The last provisioning finished successfully.
-         */
-        status: string;
-    };
-    /**
-     * Whether the organization enforces all of its resources (e.g., query pipelines, sources, etc.) to be read-only.
-     *
-     * **Note:** This parameter is typically only updated when an organization is inactive.
-     *
-     * @default `false`
-     */
-    readOnly: boolean;
-    /**
-     * The current status of the organization.
-     *
-     * **Allowed values:**
-     * - `HEALTHY`: The organization is healthy and fully functional.
-     * - `ERROR`: The organization has thrown an error and is currently inactive.
-     *
-     * @example `ERROR`
-     */
-    status: string;
-    /**
-     * Whether support has been activated for the organization.
-     * See [Coveo Customer Global Support and Success Guide](https://docs.coveo.com/en/1352/).
-     */
-    supportActivated: boolean;
-}
-export interface OrganizationModel {
-    id: string;
-    displayName: string;
-    createdDate: number;
-    publicContentOnly: boolean;
-    type: string;
-    owner: {
-        email: string;
-    };
-    readOnly: boolean;
-    license?: LicenseModel;
-    organizationStatusModel?: OrganizationsStatusModel;
-}
-export declare type AdditionalOrganizationField = 'status' | 'license' | string;
-export interface GetOrganizationOptions {
-    additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
-}
-export interface ListOrganizationOptions extends Paginated {
-    additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
-    filter?: string;
-    order?: string;
-    sortBy?: string;
-    type?: string;
-}
-export interface CreateOrganizationOptions {
-    name: string;
-    organizationTemplate?: string;
-    owner?: string;
-    creationOrigin?: OrganizationCreationOrigin;
-}
-export interface DefinitionModel {
-    /**
-     * Id of the organization the definition applies to
-     */
-    organizationId: string;
-    /**
-     * License template used as the "foundation" before applying the modifiers and overrides
-     */
-    baseLicenseTemplateId: string;
-    /**
-     * List of modifiers to apply when computing the resulting license
-     */
-    modifiers: ModifierModel[];
-    /**
-     * List of overrides to apply when computing the resulting license
-     */
-    overrides: OverrideModel[];
-}
-export interface OverrideModel {
-    /**
-     * Id of the override
-     * Every organization is given a "Default" override which should be used a vast majority of the time
-     */
-    id: string;
-    /**
-     * List of statements to apply when computing the resulting license
-     */
-    statements: ModifierStatementModel[];
-}
-export declare enum OrganizationCreationOrigin {
-    ADMIN_UI = "ADMIN_UI",
-    API = "API",
-    CLI = "CLI",
-    BUSINESS_CRM = "BUSINESS_CRM",
-    TRAINING = "TRAINING",
-    PARTNER_PROGRAM = "PARTNER_PROGRAM",
-    TEST = "TEST",
-    WEBSITE = "WEBSITE",
-    SALESFORCE_INTEGRATION_TRIAL = "SALESFORCE_INTEGRATION_TRIAL",
-    SERVICENOW_INTEGRATION_TRIAL = "SERVICENOW_INTEGRATION_TRIAL",
-    SITECORE_INTEGRATION_TRIAL = "SITECORE_INTEGRATION_TRIAL",
-    UNKNOWN = "UNKNOWN"
-}
+import { Paginated } from '../BaseInterfaces';
+import { LicenseModel } from '../License';
+import { ModifierModel, ModifierStatementModel } from '../ModifierTemplates/ModifierTemplateInterfaces';
+/**
+ * Describes the status of an organization.
+ */
+export interface OrganizationsStatusModel {
+    /**
+     * A list of error codes that are present in the organization at the time of the request.
+     *
+     * **Allowed values:**
+     * - `SEARCH_ERROR`: An error occurred during a search request.
+     * - `PAUSING_FAILED`: An error occurred when attempting to pause the organization.
+     * - `RESUMING_FAILED`: An error occurred when attempting to resume the organization.
+     */
+    errorCodes: string[];
+    /**
+     * The life-cycle state of the organization.
+     *
+     * **Allowed values:**
+     * - `ACTIVE`: The organization is healthy and fully functional.
+     * - `PAUSED`: The organization is currently inactive.
+     * - `DELETING`: The organization is currently in the process of being deleted.
+     *
+     * @example `PAUSED`
+     */
+    lifeCycleState: string;
+    /**
+     * The pause status of the organization.
+     *
+     * **Allowed values:**
+     * - `ACTIVE`: The organization is active.
+     * - `IDLE`: The organization is inactive.
+     * - `PAUSING`: The organization is transitioning to `PAUSED`.
+     * - `PAUSED`: The organization is paused.
+     * - `RESUMING`: The organization is transitioning to `ACTIVE`.
+     * - `PAUSING_FAILED`: The organization threw an error while transitioning to `PAUSED`.
+     * - `RESUMING_FAILED`: The organization threw an error while transitioning to `ACTIVE`.
+     *
+     * @example `PAUSED`
+     */
+    pauseState: string;
+    /**
+     * Whether the organization is currently paused.
+     */
+    paused: boolean;
+    /**
+     * The provisioning status of the organization.
+     */
+    provisioningStatus: {
+        /**
+         * The progress, in percentage, of the ongoing provisioning.
+         *
+         * @example `100`
+         */
+        currentProvisioningProgress: number;
+        /**
+         * Whether the initial provisioning has been completed.
+         */
+        initialProvisioningDone: boolean;
+        /**
+         * The last time provisioning was successfully completed in number of milliseconds since UNIX epoch.
+         *
+         * @example `1556722921779`
+         */
+        lastProvisioningCompletedDate: number;
+        /**
+         * Whether the provisioning is currently ongoing.
+         */
+        ongoing: boolean;
+        /**
+         * The status of the last provisioning.
+         *
+         * **Allowed values:**
+         * - `ERROR`: The last provisioning failed with an error.
+         * - `HEALTHY`: The last provisioning finished successfully.
+         */
+        status: string;
+    };
+    /**
+     * Whether the organization enforces all of its resources (e.g., query pipelines, sources, etc.) to be read-only.
+     *
+     * **Note:** This parameter is typically only updated when an organization is inactive.
+     *
+     * @default `false`
+     */
+    readOnly: boolean;
+    /**
+     * The current status of the organization.
+     *
+     * **Allowed values:**
+     * - `HEALTHY`: The organization is healthy and fully functional.
+     * - `ERROR`: The organization has thrown an error and is currently inactive.
+     *
+     * @example `ERROR`
+     */
+    status: string;
+    /**
+     * Whether support has been activated for the organization.
+     * See [Coveo Customer Global Support and Success Guide](https://docs.coveo.com/en/1352/).
+     */
+    supportActivated: boolean;
+}
+export interface OrganizationModel {
+    id: string;
+    displayName: string;
+    createdDate: number;
+    publicContentOnly: boolean;
+    type: string;
+    owner: {
+        email: string;
+    };
+    readOnly: boolean;
+    license?: LicenseModel;
+    organizationStatusModel?: OrganizationsStatusModel;
+}
+export declare type AdditionalOrganizationField = 'status' | 'license' | string;
+export interface GetOrganizationOptions {
+    additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
+}
+export interface ListOrganizationOptions extends Paginated {
+    additionalFields?: AdditionalOrganizationField | AdditionalOrganizationField[];
+    filter?: string;
+    order?: string;
+    sortBy?: string;
+    type?: string;
+}
+export interface CreateOrganizationOptions {
+    name: string;
+    organizationTemplate?: string;
+    owner?: string;
+    creationOrigin?: OrganizationCreationOrigin;
+}
+export interface DefinitionModel {
+    /**
+     * Id of the organization the definition applies to
+     */
+    organizationId: string;
+    /**
+     * License template used as the "foundation" before applying the modifiers and overrides
+     */
+    baseLicenseTemplateId: string;
+    /**
+     * List of modifiers to apply when computing the resulting license
+     */
+    modifiers: ModifierModel[];
+    /**
+     * List of overrides to apply when computing the resulting license
+     */
+    overrides: OverrideModel[];
+}
+export interface OverrideModel {
+    /**
+     * Id of the override
+     * Every organization is given a "Default" override which should be used a vast majority of the time
+     */
+    id: string;
+    /**
+     * List of statements to apply when computing the resulting license
+     */
+    statements: ModifierStatementModel[];
+}
+export declare enum OrganizationCreationOrigin {
+    ADMIN_UI = "ADMIN_UI",
+    API = "API",
+    CLI = "CLI",
+    BUSINESS_CRM = "BUSINESS_CRM",
+    TRAINING = "TRAINING",
+    PARTNER_PROGRAM = "PARTNER_PROGRAM",
+    TEST = "TEST",
+    WEBSITE = "WEBSITE",
+    SALESFORCE_INTEGRATION_TRIAL = "SALESFORCE_INTEGRATION_TRIAL",
+    SERVICENOW_INTEGRATION_TRIAL = "SERVICENOW_INTEGRATION_TRIAL",
+    SITECORE_INTEGRATION_TRIAL = "SITECORE_INTEGRATION_TRIAL",
+    UNKNOWN = "UNKNOWN"
+}

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

@@ -1,3 +1,3 @@
-export * from './Organization';
-export * from './OrganizationInterfaces';
-export * from './Members';
+export * from './Organization';
+export * from './OrganizationInterfaces';
+export * from './Members';

package/dist/definitions/resources/Pipelines/Conditions/Condition.d.ts

@@ -1,11 +1,11 @@
-import { PageModel } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { ConditionModel, ListConditionsOptions, NewConditionModel } from './ConditionInterfaces';
-export default class Condition extends Resource {
-    static baseUrl: string;
-    list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
-    create(conditionModel: NewConditionModel): Promise<ConditionModel>;
-    delete(conditionId: string): Promise<Record<string, unknown>>;
-    get(conditionId: string): Promise<ConditionModel>;
-    update(conditionId: string, conditionModel: ConditionModel | NewConditionModel): Promise<ConditionModel>;
-}
+import { PageModel } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { ConditionModel, ListConditionsOptions, NewConditionModel } from './ConditionInterfaces';
+export default class Condition extends Resource {
+    static baseUrl: string;
+    list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
+    create(conditionModel: NewConditionModel): Promise<ConditionModel>;
+    delete(conditionId: string): Promise<Record<string, unknown>>;
+    get(conditionId: string): Promise<ConditionModel>;
+    update(conditionId: string, conditionModel: ConditionModel | NewConditionModel): Promise<ConditionModel>;
+}

package/dist/definitions/resources/Pipelines/Conditions/ConditionInterfaces.d.ts

@@ -1,25 +1,25 @@
-import { Paginated } from '../../BaseInterfaces';
-import { ListStatementSortBy } from '../../Enums';
-export interface ConditionModel {
-    id: string;
-    description: string;
-    definition: string;
-    detailed: any;
-    childrenCount: number;
-    feature: string;
-    position: number;
-    ready: boolean;
-    parent?: string;
-    condition?: string;
-}
-export interface NewConditionModel {
-    definition: string;
-    id?: string;
-    description?: string;
-}
-export interface ListConditionsOptions extends Paginated {
-    isOrderDescending?: boolean;
-    filter?: string;
-    sortBy?: ListStatementSortBy;
-    organizationId?: string;
-}
+import { Paginated } from '../../BaseInterfaces';
+import { ListStatementSortBy } from '../../Enums';
+export interface ConditionModel {
+    id: string;
+    description: string;
+    definition: string;
+    detailed: any;
+    childrenCount: number;
+    feature: string;
+    position: number;
+    ready: boolean;
+    parent?: string;
+    condition?: string;
+}
+export interface NewConditionModel {
+    definition: string;
+    id?: string;
+    description?: string;
+}
+export interface ListConditionsOptions extends Paginated {
+    isOrderDescending?: boolean;
+    filter?: string;
+    sortBy?: ListStatementSortBy;
+    organizationId?: string;
+}

package/dist/definitions/resources/Pipelines/Conditions/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Condition';
-export * from './ConditionInterfaces';
+export * from './Condition';
+export * from './ConditionInterfaces';

package/dist/definitions/resources/Pipelines/FacetStateRules/FacetStateRules.d.ts

@@ -1,11 +1,11 @@
-import Ressource from '../../Resource';
-import { FacetStateRule, ListFacetStateRuleParams, ListFacetStateRuleResponse } from './FacetStateRulesInterface';
-export default class FacetStateRules extends Ressource {
-    static getBaseUrl: (pipelineId: string) => string;
-    list(pipelineId: string, params?: ListFacetStateRuleParams): Promise<ListFacetStateRuleResponse>;
-    get(pipelineId: string, facetStateRuleId: string): Promise<FacetStateRule>;
-    create(pipelineId: string, facetStateRule: FacetStateRule): Promise<FacetStateRule>;
-    update(pipelineId: string, facetStateRuleId: string, facetStateRule: FacetStateRule): Promise<void>;
-    delete(pipelineId: string, facetStateRuleId: string): Promise<void>;
-    move(pipelineId: string, facetStateRuleId: string, position: number): Promise<void>;
-}
+import Ressource from '../../Resource';
+import { FacetStateRule, ListFacetStateRuleParams, ListFacetStateRuleResponse } from './FacetStateRulesInterface';
+export default class FacetStateRules extends Ressource {
+    static getBaseUrl: (pipelineId: string) => string;
+    list(pipelineId: string, params?: ListFacetStateRuleParams): Promise<ListFacetStateRuleResponse>;
+    get(pipelineId: string, facetStateRuleId: string): Promise<FacetStateRule>;
+    create(pipelineId: string, facetStateRule: FacetStateRule): Promise<FacetStateRule>;
+    update(pipelineId: string, facetStateRuleId: string, facetStateRule: FacetStateRule): Promise<void>;
+    delete(pipelineId: string, facetStateRuleId: string): Promise<void>;
+    move(pipelineId: string, facetStateRuleId: string, position: number): Promise<void>;
+}

package/dist/definitions/resources/Pipelines/FacetStateRules/FacetStateRulesInterface.d.ts

@@ -1,45 +1,45 @@
-import { Paginated } from '../../BaseInterfaces';
-import { FacetRuleKind, FacetRuleState, ListStatementSortBy, PredicateKind, PredicateLocaleKind, PredicateMatchOperator } from '../../Enums';
-export interface IdentifiedFacetStateRule {
-    id: string;
-    position: number;
-    rule: FacetStateRule;
-}
-export interface FacetStateRule {
-    condition?: FacetStateRuleCondition;
-    defaultMatchOperator?: FacetStateRuleMatchOperator;
-    description?: string;
-    field?: string;
-    kind: FacetRuleKind;
-    predicates?: FacetStateRulePredicate[];
-    state?: FacetRuleState;
-    values?: string[];
-}
-export interface FacetStateRuleCondition {
-    reference: string;
-}
-export interface FacetStateRulePredicate {
-    basicQueryExpression?: string;
-    code?: string;
-    kind: PredicateKind;
-    locale?: PredicateLocale;
-    matchOperator: FacetStateRuleMatchOperator;
-}
-export interface FacetStateRuleMatchOperator {
-    kind: PredicateMatchOperator;
-}
-export interface PredicateLocale {
-    code: string;
-    kind: PredicateLocaleKind;
-}
-export interface ListFacetStateRuleParams extends Paginated {
-    isOrderAscending?: boolean;
-    filter?: string;
-    sortBy?: ListStatementSortBy;
-    organizationId: string;
-}
-export interface ListFacetStateRuleResponse {
-    facetStateRules: IdentifiedFacetStateRule[];
-    totalCount: number;
-    totalPages: number;
-}
+import { Paginated } from '../../BaseInterfaces';
+import { FacetRuleKind, FacetRuleState, ListStatementSortBy, PredicateKind, PredicateLocaleKind, PredicateMatchOperator } from '../../Enums';
+export interface IdentifiedFacetStateRule {
+    id: string;
+    position: number;
+    rule: FacetStateRule;
+}
+export interface FacetStateRule {
+    condition?: FacetStateRuleCondition;
+    defaultMatchOperator?: FacetStateRuleMatchOperator;
+    description?: string;
+    field?: string;
+    kind: FacetRuleKind;
+    predicates?: FacetStateRulePredicate[];
+    state?: FacetRuleState;
+    values?: string[];
+}
+export interface FacetStateRuleCondition {
+    reference: string;
+}
+export interface FacetStateRulePredicate {
+    basicQueryExpression?: string;
+    code?: string;
+    kind: PredicateKind;
+    locale?: PredicateLocale;
+    matchOperator: FacetStateRuleMatchOperator;
+}
+export interface FacetStateRuleMatchOperator {
+    kind: PredicateMatchOperator;
+}
+export interface PredicateLocale {
+    code: string;
+    kind: PredicateLocaleKind;
+}
+export interface ListFacetStateRuleParams extends Paginated {
+    isOrderAscending?: boolean;
+    filter?: string;
+    sortBy?: ListStatementSortBy;
+    organizationId: string;
+}
+export interface ListFacetStateRuleResponse {
+    facetStateRules: IdentifiedFacetStateRule[];
+    totalCount: number;
+    totalPages: number;
+}

package/dist/definitions/resources/Pipelines/FacetStateRules/index.d.ts

@@ -1,2 +1,2 @@
-export * from './FacetStateRules';
-export * from './FacetStateRulesInterface';
+export * from './FacetStateRules';
+export * from './FacetStateRulesInterface';

package/dist/definitions/resources/Pipelines/MLAssociations/MLAssociations.d.ts

@@ -1,13 +1,13 @@
-import { PageModel } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { AssociatedPipelinesData, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces';
-export default class MLAssociations extends Resource {
-    static getBaseUrl: (pipelineId: string) => string;
-    list(pipelineId: string, options?: ListAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
-    associate(pipelineId: string, options: CreateAssociation): Promise<Record<string, unknown>>;
-    getAssociation(pipelineId: string, associationId: string): Promise<MLAssociationModel>;
-    disassociate(pipelineId: string, associationId: string): Promise<Record<string, unknown>>;
-    updateAssociation(pipelineId: string, associationId: string, options?: EditAssociation): Promise<Record<string, unknown>>;
-    updatePosition(pipelineId: string, associationId: string, position: number): Promise<Record<string, unknown>>;
-    getAssociatedPipelines(): Promise<AssociatedPipelinesData[]>;
-}
+import { PageModel } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { AssociatedPipelinesData, CreateAssociation, EditAssociation, ListAssociationsParams, MLAssociationModel } from './MLAssociationsInterfaces';
+export default class MLAssociations extends Resource {
+    static getBaseUrl: (pipelineId: string) => string;
+    list(pipelineId: string, options?: ListAssociationsParams): Promise<PageModel<MLAssociationModel, "rules">>;
+    associate(pipelineId: string, options: CreateAssociation): Promise<Record<string, unknown>>;
+    getAssociation(pipelineId: string, associationId: string): Promise<MLAssociationModel>;
+    disassociate(pipelineId: string, associationId: string): Promise<Record<string, unknown>>;
+    updateAssociation(pipelineId: string, associationId: string, options?: EditAssociation): Promise<Record<string, unknown>>;
+    updatePosition(pipelineId: string, associationId: string, position: number): Promise<Record<string, unknown>>;
+    getAssociatedPipelines(): Promise<AssociatedPipelinesData[]>;
+}