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

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

@@ -1,9 +1,9 @@
-import API from '../../APICore';
-import Resource from '../Resource';
-import ContentQuery from './ContentQuery/ContentQuery';
-export default class TableauService extends Resource {
-    protected api: API;
-    protected serverlessApi: API;
-    contentQuery: ContentQuery;
-    constructor(api: API, serverlessApi: API);
-}
+import API from '../../APICore';
+import Resource from '../Resource';
+import ContentQuery from './ContentQuery/ContentQuery';
+export default class TableauService extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    contentQuery: ContentQuery;
+    constructor(api: API, serverlessApi: API);
+}

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

@@ -1,2 +1,2 @@
-export * from './ContentQuery';
-export * from './TableauService';
+export * from './ContentQuery';
+export * from './TableauService';

package/dist/definitions/resources/UsageAnalytics/Read/Administration/Administration.d.ts

@@ -1,10 +1,10 @@
-import { RedshiftEndpointStatus } from '../../../Enums';
-import Resource from '../../../Resource';
-import { AccountInfoModelV15, AccountResponseV15, StrictValidationTestParams, StrictValidationTestResponseV15 } from './AdministrationInterfaces';
-export default class Administration extends Resource {
-    static baseUrl: string;
-    getAccount(): Promise<AccountResponseV15>;
-    updateAccount(model: AccountInfoModelV15): Promise<AccountResponseV15>;
-    setRedshiftStatus(endpoint: string, status: RedshiftEndpointStatus): Promise<Record<string, unknown>>;
-    getStrictValidationTest(params: StrictValidationTestParams): Promise<StrictValidationTestResponseV15>;
-}
+import { RedshiftEndpointStatus } from '../../../Enums';
+import Resource from '../../../Resource';
+import { AccountInfoModelV15, AccountResponseV15, StrictValidationTestParams, StrictValidationTestResponseV15 } from './AdministrationInterfaces';
+export default class Administration extends Resource {
+    static baseUrl: string;
+    getAccount(): Promise<AccountResponseV15>;
+    updateAccount(model: AccountInfoModelV15): Promise<AccountResponseV15>;
+    setRedshiftStatus(endpoint: string, status: RedshiftEndpointStatus): Promise<Record<string, unknown>>;
+    getStrictValidationTest(params: StrictValidationTestParams): Promise<StrictValidationTestResponseV15>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Administration/AdministrationInterfaces.d.ts

@@ -1,21 +1,21 @@
-export interface AccountInfoModelV15 {
-    internalEventIps: string[];
-    useStrictFieldValidation: boolean;
-}
-export interface AccountResponseV15 extends AccountInfoModelV15 {
-    name: string;
-    enabled: boolean;
-    status: any;
-}
-export interface StrictValidationTestResponseV15 {
-    dimensionName: string;
-    validationTestResults: Array<Record<string, unknown>>;
-}
-export interface StrictValidationTestParams {
-    from: string;
-    to: string;
-    d: string;
-    p?: number;
-    n?: number;
-    org?: string;
-}
+export interface AccountInfoModelV15 {
+    internalEventIps: string[];
+    useStrictFieldValidation: boolean;
+}
+export interface AccountResponseV15 extends AccountInfoModelV15 {
+    name: string;
+    enabled: boolean;
+    status: any;
+}
+export interface StrictValidationTestResponseV15 {
+    dimensionName: string;
+    validationTestResults: Array<Record<string, unknown>>;
+}
+export interface StrictValidationTestParams {
+    from: string;
+    to: string;
+    d: string;
+    p?: number;
+    n?: number;
+    org?: string;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Administration/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Administration';
-export * from './AdministrationInterfaces';
+export * from './Administration';
+export * from './AdministrationInterfaces';

package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShare.d.ts

@@ -1,9 +1,9 @@
-import Resource from '../../../Resource';
-import { SnowflakeAccountDataSharingParams, SnowflakeAccountDataSharingAccountModel, SnowflakeAccountDataSharingRegionsModel } from './DataShareInterfaces';
-export default class DataShare extends Resource {
-    static baseUrl: string;
-    listSnowflakeAccount(): Promise<SnowflakeAccountDataSharingAccountModel[]>;
-    addSnowflakeAccount(snowflakeAccount: SnowflakeAccountDataSharingParams): Promise<void>;
-    deleteSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
-    listAllowedSnowflakeRegions(): Promise<SnowflakeAccountDataSharingRegionsModel>;
-}
+import Resource from '../../../Resource';
+import { SnowflakeAccountDataSharingParams, SnowflakeAccountDataSharingAccountModel, SnowflakeAccountDataSharingRegionsModel } from './DataShareInterfaces';
+export default class DataShare extends Resource {
+    static baseUrl: string;
+    listSnowflakeAccount(): Promise<SnowflakeAccountDataSharingAccountModel[]>;
+    addSnowflakeAccount(snowflakeAccount: SnowflakeAccountDataSharingParams): Promise<void>;
+    deleteSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
+    listAllowedSnowflakeRegions(): Promise<SnowflakeAccountDataSharingRegionsModel>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShareInterfaces.d.ts

@@ -1,43 +1,43 @@
-import { DataShareStatus } from '../../../Enums';
-export interface SnowflakeAccountDataSharingAccountModel {
-    /**
-     * The Snowflake account locator.
-     */
-    locator: string;
-    /**
-     * The region the Snowflake account resides in.
-     */
-    region: string;
-    /**
-     * The date and time at which the share was initiated.
-     */
-    createdAt?: string;
-    /**
-     * The share status of the account.
-     */
-    status: DataShareStatus;
-    /**
-     * The error message in case of an 'UNKNOWN' or 'INVALID' status.
-     */
-    errorMessage?: string;
-}
-export interface SnowflakeAccountDataSharingParams {
-    /**
-     * The snowflake account locator.
-     */
-    accountLocator: string;
-    /**
-     * The region of the snowflake account.
-     */
-    snowflakeRegion: string;
-}
-export interface SnowflakeAccountDataSharingRegionsModel {
-    /**
-     * The primary Snowflake region.
-     */
-    primaryRegion: string;
-    /**
-     * Other supported Snowflake regions.
-     */
-    secondaryRegions: string[];
-}
+import { DataShareStatus } from '../../../Enums';
+export interface SnowflakeAccountDataSharingAccountModel {
+    /**
+     * The Snowflake account locator.
+     */
+    locator: string;
+    /**
+     * The region the Snowflake account resides in.
+     */
+    region: string;
+    /**
+     * The date and time at which the share was initiated.
+     */
+    createdAt?: string;
+    /**
+     * The share status of the account.
+     */
+    status: DataShareStatus;
+    /**
+     * The error message in case of an 'UNKNOWN' or 'INVALID' status.
+     */
+    errorMessage?: string;
+}
+export interface SnowflakeAccountDataSharingParams {
+    /**
+     * The snowflake account locator.
+     */
+    accountLocator: string;
+    /**
+     * The region of the snowflake account.
+     */
+    snowflakeRegion: string;
+}
+export interface SnowflakeAccountDataSharingRegionsModel {
+    /**
+     * The primary Snowflake region.
+     */
+    primaryRegion: string;
+    /**
+     * Other supported Snowflake regions.
+     */
+    secondaryRegions: string[];
+}

package/dist/definitions/resources/UsageAnalytics/Read/DataShare/index.d.ts

@@ -1,2 +1,2 @@
-export * from './DataShare';
-export * from './DataShareInterfaces';
+export * from './DataShare';
+export * from './DataShareInterfaces';

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/Dimensions.d.ts

@@ -1,21 +1,21 @@
-import { DimensionEventTypes } from '../../../Enums';
-import Resource from '../../../Resource';
-import { CreateCustomDimensionParams, CustomDimensionModel, CustomDimensionSuggestionModel, DimensionModel, DimensionValuesModel, GetDimensionValuesParams, ListDimensionsParams, ListUncreatedDimensionsParams } from './DimensionsInterfaces';
-export default class Dimensions extends Resource {
-    static baseUrl: string;
-    list(params?: ListDimensionsParams): Promise<DimensionModel[]>;
-    listExportableDimensions(params?: ListDimensionsParams): Promise<DimensionModel[]>;
-    get(apiName: string): Promise<DimensionModel>;
-    getValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
-    getStatus(): Promise<Record<string, string>>;
-    checkHealth(): Promise<Record<string, string>>;
-    listCustomDimensions(includeOnlyParents?: boolean): Promise<DimensionModel[]>;
-    createCustomDimension(model: CustomDimensionModel, params: CreateCustomDimensionParams): Promise<DimensionModel>;
-    getCustomDimension(apiName: string): Promise<DimensionModel>;
-    getCustomDimensionValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
-    updateCustomDimension(apiName: string, model: CustomDimensionModel, updatePastEvents?: boolean): Promise<DimensionModel>;
-    deleteCustomDimension(apiName: string): Promise<void>;
-    getCustomDimensionStatus(): Promise<Record<string, string>>;
-    checkCustomDimensionHealth(): Promise<Record<string, string>>;
-    listUncreatedDimensions(event: DimensionEventTypes, params?: ListUncreatedDimensionsParams): Promise<CustomDimensionSuggestionModel[]>;
-}
+import { DimensionEventTypes } from '../../../Enums';
+import Resource from '../../../Resource';
+import { CreateCustomDimensionParams, CustomDimensionModel, CustomDimensionSuggestionModel, DimensionModel, DimensionValuesModel, GetDimensionValuesParams, ListDimensionsParams, ListUncreatedDimensionsParams } from './DimensionsInterfaces';
+export default class Dimensions extends Resource {
+    static baseUrl: string;
+    list(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    listExportableDimensions(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    get(apiName: string): Promise<DimensionModel>;
+    getValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    getStatus(): Promise<Record<string, string>>;
+    checkHealth(): Promise<Record<string, string>>;
+    listCustomDimensions(includeOnlyParents?: boolean): Promise<DimensionModel[]>;
+    createCustomDimension(model: CustomDimensionModel, params: CreateCustomDimensionParams): Promise<DimensionModel>;
+    getCustomDimension(apiName: string): Promise<DimensionModel>;
+    getCustomDimensionValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    updateCustomDimension(apiName: string, model: CustomDimensionModel, updatePastEvents?: boolean): Promise<DimensionModel>;
+    deleteCustomDimension(apiName: string): Promise<void>;
+    getCustomDimensionStatus(): Promise<Record<string, string>>;
+    checkCustomDimensionHealth(): Promise<Record<string, string>>;
+    listUncreatedDimensions(event: DimensionEventTypes, params?: ListUncreatedDimensionsParams): Promise<CustomDimensionSuggestionModel[]>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/DimensionsInterfaces.d.ts

@@ -1,101 +1,101 @@
-import { DimensionStatus, DimensionType } from '../../../Enums';
-export interface DimensionModel {
-    /**
-     * A collection of possible names to use when querying the statistics service with this dimension
-     */
-    apiNames: string[];
-    /**
-     * Whether the dimension is available in a visit's statistics.
-     */
-    availableInVisit?: boolean;
-    /**
-     * A flag indicating if the dimension is a custom dimension
-     */
-    custom: boolean;
-    /**
-     * The display name of the dimension
-     */
-    displayName: string;
-    /**
-     * Indicates the type of events that this dimension can be attached to.
-     */
-    eventTypes: string[];
-    /**
-     * The name of the dimension when returned by the statistics service
-     */
-    returnName: string;
-    /**
-     * The status of the dimension
-     */
-    status: DimensionStatus;
-    /**
-     * The type of the dimension
-     */
-    type: DimensionType;
-    /**
-     * The path in the custom_datas map corresponding to this dimension. For custom dimensions only.
-     */
-    path?: string[];
-}
-export interface DimensionValuesModel {
-    values: Array<Record<string, string | number>>;
-}
-export interface CustomDimensionSuggestionModel {
-    eventName?: string;
-    apiName?: string;
-    values?: string[];
-}
-export interface CustomDimensionModel {
-    /**
-     * The type of the dimension.
-     */
-    type: DimensionType;
-    /**
-     * The display name of the dimension. Should be human readable.
-     */
-    displayName: string;
-    /**
-     * The path in the custom_datas map corresponding to this dimension. For custom dimensions only.
-     */
-    path?: string[];
-}
-export interface ListDimensionsParams {
-    org?: string;
-    includeOnlyParents?: boolean;
-    includeCustom?: boolean;
-}
-export interface GetDimensionValuesParams {
-    from: string;
-    to: string;
-    tz?: string;
-    org?: string;
-    f?: string[];
-    p?: number;
-    n?: number;
-}
-export interface CreateCustomDimensionParams {
-    /**
-     * The name of the custom dimension. It should start with the 'c_' prefix.
-     * If not present, the prefix will be added automatically.
-     */
-    name: string;
-    /**
-     * The name of the organization (Coveo Cloud V2 only)
-     */
-    org?: string;
-    /**
-     * The types of event where this dimension will be added.
-     */
-    event?: string[];
-    /**
-     * Whether to update the custom dimension in past events.
-     */
-    updatePastEvents?: boolean;
-}
-export interface ListUncreatedDimensionsParams {
-    org?: string;
-    from?: string;
-    to?: string;
-    includeValueSamples?: boolean;
-    depth?: number;
-}
+import { DimensionStatus, DimensionType } from '../../../Enums';
+export interface DimensionModel {
+    /**
+     * A collection of possible names to use when querying the statistics service with this dimension
+     */
+    apiNames: string[];
+    /**
+     * Whether the dimension is available in a visit's statistics.
+     */
+    availableInVisit?: boolean;
+    /**
+     * A flag indicating if the dimension is a custom dimension
+     */
+    custom: boolean;
+    /**
+     * The display name of the dimension
+     */
+    displayName: string;
+    /**
+     * Indicates the type of events that this dimension can be attached to.
+     */
+    eventTypes: string[];
+    /**
+     * The name of the dimension when returned by the statistics service
+     */
+    returnName: string;
+    /**
+     * The status of the dimension
+     */
+    status: DimensionStatus;
+    /**
+     * The type of the dimension
+     */
+    type: DimensionType;
+    /**
+     * The path in the custom_datas map corresponding to this dimension. For custom dimensions only.
+     */
+    path?: string[];
+}
+export interface DimensionValuesModel {
+    values: Array<Record<string, string | number>>;
+}
+export interface CustomDimensionSuggestionModel {
+    eventName?: string;
+    apiName?: string;
+    values?: string[];
+}
+export interface CustomDimensionModel {
+    /**
+     * The type of the dimension.
+     */
+    type: DimensionType;
+    /**
+     * The display name of the dimension. Should be human readable.
+     */
+    displayName: string;
+    /**
+     * The path in the custom_datas map corresponding to this dimension. For custom dimensions only.
+     */
+    path?: string[];
+}
+export interface ListDimensionsParams {
+    org?: string;
+    includeOnlyParents?: boolean;
+    includeCustom?: boolean;
+}
+export interface GetDimensionValuesParams {
+    from: string;
+    to: string;
+    tz?: string;
+    org?: string;
+    f?: string[];
+    p?: number;
+    n?: number;
+}
+export interface CreateCustomDimensionParams {
+    /**
+     * The name of the custom dimension. It should start with the 'c_' prefix.
+     * If not present, the prefix will be added automatically.
+     */
+    name: string;
+    /**
+     * The name of the organization (Coveo Cloud V2 only)
+     */
+    org?: string;
+    /**
+     * The types of event where this dimension will be added.
+     */
+    event?: string[];
+    /**
+     * Whether to update the custom dimension in past events.
+     */
+    updatePastEvents?: boolean;
+}
+export interface ListUncreatedDimensionsParams {
+    org?: string;
+    from?: string;
+    to?: string;
+    includeValueSamples?: boolean;
+    depth?: number;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Dimensions';
-export * from './DimensionsInterfaces';
+export * from './Dimensions';
+export * from './DimensionsInterfaces';

package/dist/definitions/resources/UsageAnalytics/Read/Exports/Exports.d.ts

@@ -1,20 +1,20 @@
-import Resource from '../../../Resource';
-import { CreateExportScheduleModel, EstimateExportParams, EstimateVisitExportParams, ExportDownloadLink, ExportEstimateModel, ExportModel, ExportScheduleModel, GenerateExportParams, GenerateVisitExportParams } from './ExportsInterfaces';
-export default class Exports extends Resource {
-    static baseUrl: string;
-    list(): Promise<ExportModel[]>;
-    generate(params: GenerateExportParams): Promise<ExportModel>;
-    get(exportId: string, redirect?: boolean): Promise<ExportModel>;
-    getExportDownloadLink(exportId: string): Promise<ExportDownloadLink>;
-    delete(exportId: string): Promise<void>;
-    estimateRowsCount(params: EstimateExportParams): Promise<ExportEstimateModel>;
-    getStatus(): Promise<Record<string, string>>;
-    checkHealth(): Promise<Record<string, string>>;
-    generateVisitExport(params: GenerateVisitExportParams): Promise<ExportModel>;
-    estimateVisitExportRowsCount(params: EstimateVisitExportParams): Promise<ExportEstimateModel>;
-    listSchedules(): Promise<ExportScheduleModel[]>;
-    createSchedule(model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
-    getSchedule(exportScheduleId: string): Promise<ExportScheduleModel>;
-    updateSchedule(exportScheduleId: string, model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
-    deleteSchedule(exportScheduleId: string): Promise<void>;
-}
+import Resource from '../../../Resource';
+import { CreateExportScheduleModel, EstimateExportParams, EstimateVisitExportParams, ExportDownloadLink, ExportEstimateModel, ExportModel, ExportScheduleModel, GenerateExportParams, GenerateVisitExportParams } from './ExportsInterfaces';
+export default class Exports extends Resource {
+    static baseUrl: string;
+    list(): Promise<ExportModel[]>;
+    generate(params: GenerateExportParams): Promise<ExportModel>;
+    get(exportId: string, redirect?: boolean): Promise<ExportModel>;
+    getExportDownloadLink(exportId: string): Promise<ExportDownloadLink>;
+    delete(exportId: string): Promise<void>;
+    estimateRowsCount(params: EstimateExportParams): Promise<ExportEstimateModel>;
+    getStatus(): Promise<Record<string, string>>;
+    checkHealth(): Promise<Record<string, string>>;
+    generateVisitExport(params: GenerateVisitExportParams): Promise<ExportModel>;
+    estimateVisitExportRowsCount(params: EstimateVisitExportParams): Promise<ExportEstimateModel>;
+    listSchedules(): Promise<ExportScheduleModel[]>;
+    createSchedule(model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
+    getSchedule(exportScheduleId: string): Promise<ExportScheduleModel>;
+    updateSchedule(exportScheduleId: string, model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
+    deleteSchedule(exportScheduleId: string): Promise<void>;
+}