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

package/dist/definitions/resources/SearchUsageMetrics/LicenseMetrics/index.d.ts

@@ -1,2 +1,2 @@
-export * from './LicenseMetrics';
-export * from './LicenseMetricsInterface';
+export * from './LicenseMetrics';
+export * from './LicenseMetricsInterface';

package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/RawMetrics.d.ts

@@ -1,10 +1,10 @@
-import Resource from '../../Resource';
-import { DailyRawMetricParameters, MonthlyRawMetricParameters, MonthlyRawMetricsParameters, RestListOfRawMetrics, RestListOfRawMetricValues, RestListOfSearchHubRawMetrics } from './RawMetricsInterface';
-export default class RawMetrics extends Resource {
-    static baseUrl: string;
-    private addZeroIfRequired;
-    list(): Promise<RestListOfRawMetrics>;
-    listMonthly({ month, minimumQueries }: MonthlyRawMetricsParameters): Promise<RestListOfSearchHubRawMetrics>;
-    getDaily({ to, from, metric, searchHub }: DailyRawMetricParameters): Promise<RestListOfRawMetricValues>;
-    getMonthly({ to, from, metric, searchHub }: MonthlyRawMetricParameters): Promise<RestListOfRawMetricValues>;
-}
+import Resource from '../../Resource';
+import { DailyRawMetricParameters, MonthlyRawMetricParameters, MonthlyRawMetricsParameters, RestListOfRawMetrics, RestListOfRawMetricValues, RestListOfSearchHubRawMetrics } from './RawMetricsInterface';
+export default class RawMetrics extends Resource {
+    static baseUrl: string;
+    private addZeroIfRequired;
+    list(): Promise<RestListOfRawMetrics>;
+    listMonthly({ month, minimumQueries }: MonthlyRawMetricsParameters): Promise<RestListOfSearchHubRawMetrics>;
+    getDaily({ to, from, metric, searchHub }: DailyRawMetricParameters): Promise<RestListOfRawMetricValues>;
+    getMonthly({ to, from, metric, searchHub }: MonthlyRawMetricParameters): Promise<RestListOfRawMetricValues>;
+}

package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/RawMetricsInterface.d.ts

@@ -1,127 +1,127 @@
-import { SearchHubRawMetrics } from '../../Enums';
-export interface DailyRawMetricParameters extends CommonMetricParameters {
-    /**
-     * The first day to report for
-     */
-    from: DateWithoutTime;
-    /**
-     * The last day to report for
-     */
-    to: DateWithoutTime;
-}
-export interface MonthlyRawMetricParameters extends CommonMetricParameters {
-    /**
-     * The first month to report for
-     */
-    from: DateWithoutTimeAndDay;
-    /**
-     * The last month to report for
-     */
-    to: DateWithoutTimeAndDay;
-}
-export interface MonthlyRawMetricsParameters {
-    /**
-     * The month to report for
-     */
-    month: DateWithoutTimeAndDay;
-    /**
-     * The minimum number of queries required for a search hub to be listed
-     */
-    minimumQueries?: number;
-}
-export interface RestListOfRawMetrics {
-    /**
-     * The list of metrics
-     */
-    metrics: RestMetric[];
-}
-export interface RestListOfRawMetricValues {
-    /**
-     * The list of daily metric values
-     */
-    values: RestMetricValueForDate[];
-}
-export interface RestListOfSearchHubRawMetrics {
-    /**
-     * The list of search hubs
-     */
-    searchHubs: RestSearchHubMetrics[];
-}
-interface RestMetric {
-    /**
-     * The ID of the metric
-     */
-    id: SearchHubRawMetrics;
-    /**
-     * The display name of the metric
-     */
-    label?: string;
-}
-interface RestMetricValueForDate {
-    /**
-     * The date for the usage metric value
-     */
-    date: string;
-    /**
-     * The numeric metric value
-     */
-    value: number;
-}
-interface RestSearchHubMetrics {
-    /**
-     * The name of the search hub
-     */
-    searchHub: string;
-    /**
-     * The usage buckets to which the search hub is assigned
-     */
-    assignment: SearchHubRawMetrics;
-    /**
-     * The number of normal queries
-     */
-    normalQueries: number;
-    /**
-     * The number of recommendation queries
-     */
-    recommendationQueries: number;
-    /**
-     * The number of distinct users
-     */
-    users: number;
-    /**
-     * The number of distinct persistent queries
-     */
-    staticQueries: number;
-    /**
-     * The number of product listing queries
-     */
-    productListingQueries: number;
-}
-interface CommonMetricParameters {
-    /**
-     * The raw metric to report on
-     */
-    metric: SearchHubRawMetrics;
-    /**
-     * The name of the search hub to report on
-     */
-    searchHub: string;
-}
-interface DateWithoutTime {
-    /**
-     * Year of the selected date
-     */
-    year: number;
-    /**
-     * Month of the selected date
-     * Between 1 to 12
-     */
-    month: number;
-    /**
-     * Day of the selected date
-     * Between 1 to 31
-     */
-    day: number;
-}
-declare type DateWithoutTimeAndDay = Omit<DateWithoutTime, 'day'>;
-export {};
+import { SearchHubRawMetrics } from '../../Enums';
+export interface DailyRawMetricParameters extends CommonMetricParameters {
+    /**
+     * The first day to report for
+     */
+    from: DateWithoutTime;
+    /**
+     * The last day to report for
+     */
+    to: DateWithoutTime;
+}
+export interface MonthlyRawMetricParameters extends CommonMetricParameters {
+    /**
+     * The first month to report for
+     */
+    from: DateWithoutTimeAndDay;
+    /**
+     * The last month to report for
+     */
+    to: DateWithoutTimeAndDay;
+}
+export interface MonthlyRawMetricsParameters {
+    /**
+     * The month to report for
+     */
+    month: DateWithoutTimeAndDay;
+    /**
+     * The minimum number of queries required for a search hub to be listed
+     */
+    minimumQueries?: number;
+}
+export interface RestListOfRawMetrics {
+    /**
+     * The list of metrics
+     */
+    metrics: RestMetric[];
+}
+export interface RestListOfRawMetricValues {
+    /**
+     * The list of daily metric values
+     */
+    values: RestMetricValueForDate[];
+}
+export interface RestListOfSearchHubRawMetrics {
+    /**
+     * The list of search hubs
+     */
+    searchHubs: RestSearchHubMetrics[];
+}
+interface RestMetric {
+    /**
+     * The ID of the metric
+     */
+    id: SearchHubRawMetrics;
+    /**
+     * The display name of the metric
+     */
+    label?: string;
+}
+interface RestMetricValueForDate {
+    /**
+     * The date for the usage metric value
+     */
+    date: string;
+    /**
+     * The numeric metric value
+     */
+    value: number;
+}
+interface RestSearchHubMetrics {
+    /**
+     * The name of the search hub
+     */
+    searchHub: string;
+    /**
+     * The usage buckets to which the search hub is assigned
+     */
+    assignment: SearchHubRawMetrics;
+    /**
+     * The number of normal queries
+     */
+    normalQueries: number;
+    /**
+     * The number of recommendation queries
+     */
+    recommendationQueries: number;
+    /**
+     * The number of distinct users
+     */
+    users: number;
+    /**
+     * The number of distinct persistent queries
+     */
+    staticQueries: number;
+    /**
+     * The number of product listing queries
+     */
+    productListingQueries: number;
+}
+interface CommonMetricParameters {
+    /**
+     * The raw metric to report on
+     */
+    metric: SearchHubRawMetrics;
+    /**
+     * The name of the search hub to report on
+     */
+    searchHub: string;
+}
+interface DateWithoutTime {
+    /**
+     * Year of the selected date
+     */
+    year: number;
+    /**
+     * Month of the selected date
+     * Between 1 to 12
+     */
+    month: number;
+    /**
+     * Day of the selected date
+     * Between 1 to 31
+     */
+    day: number;
+}
+declare type DateWithoutTimeAndDay = Omit<DateWithoutTime, 'day'>;
+export {};

package/dist/definitions/resources/SearchUsageMetrics/RawMetrics/index.d.ts

@@ -1,2 +1,2 @@
-export * from './RawMetrics';
-export * from './RawMetricsInterface';
+export * from './RawMetrics';
+export * from './RawMetricsInterface';

package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/SearchHubs.d.ts

@@ -1,11 +1,11 @@
-import Resource from '../../Resource';
-import { SearchHubNameParams, RestSearchHub, UpdateSearchHubParams, UpdateSearchHubBucketParams, ListSearchHubsParams, ListSearchHubs } from './SearchHubsInterface';
-export default class SearchHubs extends Resource {
-    static baseUrl: string;
-    list(params?: ListSearchHubsParams): Promise<ListSearchHubs>;
-    create(params: RestSearchHub): Promise<void>;
-    get({ hubName }: SearchHubNameParams): Promise<RestSearchHub>;
-    delete({ hubName }: SearchHubNameParams): Promise<void>;
-    update({ hubName, hub }: UpdateSearchHubParams): Promise<void>;
-    updateBucket({ hubName, bucket }: UpdateSearchHubBucketParams): Promise<void>;
-}
+import Resource from '../../Resource';
+import { SearchHubNameParams, RestSearchHub, UpdateSearchHubParams, UpdateSearchHubBucketParams, ListSearchHubsParams, ListSearchHubs } from './SearchHubsInterface';
+export default class SearchHubs extends Resource {
+    static baseUrl: string;
+    list(params?: ListSearchHubsParams): Promise<ListSearchHubs>;
+    create(params: RestSearchHub): Promise<void>;
+    get({ hubName }: SearchHubNameParams): Promise<RestSearchHub>;
+    delete({ hubName }: SearchHubNameParams): Promise<void>;
+    update({ hubName, hub }: UpdateSearchHubParams): Promise<void>;
+    updateBucket({ hubName, bucket }: UpdateSearchHubBucketParams): Promise<void>;
+}

package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/SearchHubsInterface.d.ts

@@ -1,64 +1,64 @@
-import { Paginated } from '../../BaseInterfaces';
-export interface ListSearchHubs {
-    /**
-     * The array of search hubs
-     */
-    hubs: RestSearchHub[];
-    /**
-     * The number of search hub created on the organization
-     */
-    totalCount: number;
-}
-export interface RestSearchHub {
-    /**
-     * The name of the search hub
-     */
-    name: string;
-    /**
-     * The usage bucket to count queries from this hub into
-     */
-    bucket?: string;
-    /**
-     * A description for the search hub
-     */
-    description?: string;
-}
-export interface ListSearchHubsParams extends Paginated {
-    /**
-     * The free-form string to filter the returned list based on the values of the search hub attributes
-     */
-    filter?: string;
-    /**
-     * The maximum number of search hubs to list per page
-     *
-     * @default `100`
-     */
-    perPage?: number;
-    /**
-     * The 0-based index number of page to list
-     *
-     * @default `0`
-     */
-    page?: number;
-}
-export interface SearchHubNameParams {
-    /**
-     * The search hub name
-     */
-    hubName: string;
-}
-interface SearchHubModel {
-    /**
-     * The search hub data
-     */
-    hub: RestSearchHub;
-}
-interface SearchHubBucketParams {
-    /**
-     * The search hub bucket
-     */
-    bucket: string;
-}
-export declare type UpdateSearchHubParams = SearchHubNameParams & SearchHubModel;
-export declare type UpdateSearchHubBucketParams = SearchHubNameParams & SearchHubBucketParams;
-export {};
+import { Paginated } from '../../BaseInterfaces';
+export interface ListSearchHubs {
+    /**
+     * The array of search hubs
+     */
+    hubs: RestSearchHub[];
+    /**
+     * The number of search hub created on the organization
+     */
+    totalCount: number;
+}
+export interface RestSearchHub {
+    /**
+     * The name of the search hub
+     */
+    name: string;
+    /**
+     * The usage bucket to count queries from this hub into
+     */
+    bucket?: string;
+    /**
+     * A description for the search hub
+     */
+    description?: string;
+}
+export interface ListSearchHubsParams extends Paginated {
+    /**
+     * The free-form string to filter the returned list based on the values of the search hub attributes
+     */
+    filter?: string;
+    /**
+     * The maximum number of search hubs to list per page
+     *
+     * @default `100`
+     */
+    perPage?: number;
+    /**
+     * The 0-based index number of page to list
+     *
+     * @default `0`
+     */
+    page?: number;
+}
+export interface SearchHubNameParams {
+    /**
+     * The search hub name
+     */
+    hubName: string;
+}
+interface SearchHubModel {
+    /**
+     * The search hub data
+     */
+    hub: RestSearchHub;
+}
+interface SearchHubBucketParams {
+    /**
+     * The search hub bucket
+     */
+    bucket: string;
+}
+export declare type UpdateSearchHubParams = SearchHubNameParams & SearchHubModel;
+export declare type UpdateSearchHubBucketParams = SearchHubNameParams & SearchHubBucketParams;
+export {};

package/dist/definitions/resources/SearchUsageMetrics/SearchHubs/index.d.ts

@@ -1,2 +1,2 @@
-export * from './SearchHubs';
-export * from './SearchHubsInterface';
+export * from './SearchHubs';
+export * from './SearchHubsInterface';

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

@@ -1,13 +1,13 @@
-import API from '../../APICore';
-import Resource from '../Resource';
-import LicenseMetrics from './LicenseMetrics/LicenseMetrics';
-import RawMetrics from './RawMetrics/RawMetrics';
-import SearchHubs from './SearchHubs/SearchHubs';
-export default class SearchUsageMetrics extends Resource {
-    protected api: API;
-    protected serverlessApi: API;
-    licenseMetrics: LicenseMetrics;
-    searchHubs: SearchHubs;
-    rawMetrics: RawMetrics;
-    constructor(api: API, serverlessApi: API);
-}
+import API from '../../APICore';
+import Resource from '../Resource';
+import LicenseMetrics from './LicenseMetrics/LicenseMetrics';
+import RawMetrics from './RawMetrics/RawMetrics';
+import SearchHubs from './SearchHubs/SearchHubs';
+export default class SearchUsageMetrics extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    licenseMetrics: LicenseMetrics;
+    searchHubs: SearchHubs;
+    rawMetrics: RawMetrics;
+    constructor(api: API, serverlessApi: API);
+}

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

@@ -1,4 +1,4 @@
-export * from './SearchUsageMetrics';
-export * from './LicenseMetrics';
-export * from './SearchHubs';
-export * from './RawMetrics';
+export * from './SearchUsageMetrics';
+export * from './LicenseMetrics';
+export * from './SearchHubs';
+export * from './RawMetrics';

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

@@ -1,26 +1,26 @@
-import { PageModel } from '../BaseInterfaces';
-import Ressource from '../Resource';
-import { DetailedSecurityCacheMemberModel, ScheduleModel, SecurityCacheIdentityModel, SecurityCacheListOptions, SecurityCacheStatus, SecurityProviderModelWithStatus, SecurityCacheListRelationshipsOptions, SecurityCacheMemberModel, SecurityProviderModel, SecurityProviderIdentitiesFilters } from './SecurityCacheInterfaces';
-export default class SecurityCache extends Ressource {
-    static baseUrl: string;
-    static cacheUrl: string;
-    static providersUrl: string;
-    listMembers(providerId: string, options?: SecurityCacheListOptions): Promise<PageModel<DetailedSecurityCacheMemberModel>>;
-    listEntities(providerId: string, options?: SecurityCacheListOptions): Promise<PageModel<SecurityCacheIdentityModel, "items">>;
-    listSecurityProviderIdentities(providerId: string, { page, perPage, ...rest }?: SecurityProviderIdentitiesFilters): Promise<PageModel<SecurityCacheIdentityModel, "items">>;
-    listChildren(providerId: string, member: SecurityCacheMemberModel, options?: SecurityCacheListRelationshipsOptions): Promise<PageModel<DetailedSecurityCacheMemberModel, "items">>;
-    listParents(providerId: string, member: SecurityCacheMemberModel, options?: SecurityCacheListRelationshipsOptions): Promise<PageModel<DetailedSecurityCacheMemberModel, "items">>;
-    listSchedules(): Promise<ScheduleModel[]>;
-    getStatus(): Promise<SecurityCacheStatus>;
-    refreshCache(): Promise<Record<string, unknown>>;
-    refreshProvider(providerId: string): Promise<Record<string, unknown>>;
-    refreshIdentity(identityModel: SecurityCacheMemberModel): Promise<Record<string, unknown>>;
-    listProviders(): Promise<SecurityProviderModelWithStatus[]>;
-    getProvider(securityProviderId: string): Promise<SecurityProviderModelWithStatus>;
-    createOrUpdateProvider(securityProvider: SecurityProviderModel): Promise<SecurityProviderModelWithStatus>;
-    deleteProvider(securityProviderId: string): Promise<Record<string, unknown>>;
-    getSchedules(securityProviderId: string): Promise<ScheduleModel[]>;
-    updateSchedule(securityProviderId: string, schedule: ScheduleModel): Promise<ScheduleModel>;
-    getProviderEntity(providerId: string, member: SecurityCacheMemberModel): Promise<DetailedSecurityCacheMemberModel>;
-    cancelRefresh(providerId: string): Promise<Record<string, unknown>>;
-}
+import { PageModel } from '../BaseInterfaces';
+import Ressource from '../Resource';
+import { DetailedSecurityCacheMemberModel, ScheduleModel, SecurityCacheIdentityModel, SecurityCacheListOptions, SecurityCacheStatus, SecurityProviderModelWithStatus, SecurityCacheListRelationshipsOptions, SecurityCacheMemberModel, SecurityProviderModel, SecurityProviderIdentitiesFilters } from './SecurityCacheInterfaces';
+export default class SecurityCache extends Ressource {
+    static baseUrl: string;
+    static cacheUrl: string;
+    static providersUrl: string;
+    listMembers(providerId: string, options?: SecurityCacheListOptions): Promise<PageModel<DetailedSecurityCacheMemberModel>>;
+    listEntities(providerId: string, options?: SecurityCacheListOptions): Promise<PageModel<SecurityCacheIdentityModel, "items">>;
+    listSecurityProviderIdentities(providerId: string, { page, perPage, ...rest }?: SecurityProviderIdentitiesFilters): Promise<PageModel<SecurityCacheIdentityModel, "items">>;
+    listChildren(providerId: string, member: SecurityCacheMemberModel, options?: SecurityCacheListRelationshipsOptions): Promise<PageModel<DetailedSecurityCacheMemberModel, "items">>;
+    listParents(providerId: string, member: SecurityCacheMemberModel, options?: SecurityCacheListRelationshipsOptions): Promise<PageModel<DetailedSecurityCacheMemberModel, "items">>;
+    listSchedules(): Promise<ScheduleModel[]>;
+    getStatus(): Promise<SecurityCacheStatus>;
+    refreshCache(): Promise<Record<string, unknown>>;
+    refreshProvider(providerId: string): Promise<Record<string, unknown>>;
+    refreshIdentity(identityModel: SecurityCacheMemberModel): Promise<Record<string, unknown>>;
+    listProviders(): Promise<SecurityProviderModelWithStatus[]>;
+    getProvider(securityProviderId: string): Promise<SecurityProviderModelWithStatus>;
+    createOrUpdateProvider(securityProvider: SecurityProviderModel): Promise<SecurityProviderModelWithStatus>;
+    deleteProvider(securityProviderId: string): Promise<Record<string, unknown>>;
+    getSchedules(securityProviderId: string): Promise<ScheduleModel[]>;
+    updateSchedule(securityProviderId: string, schedule: ScheduleModel): Promise<ScheduleModel>;
+    getProviderEntity(providerId: string, member: SecurityCacheMemberModel): Promise<DetailedSecurityCacheMemberModel>;
+    cancelRefresh(providerId: string): Promise<Record<string, unknown>>;
+}