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

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

@@ -1,23 +1,23 @@
-import API from '../../APICore';
-import Resource from '../Resource';
-import Administration from './Read/Administration/Administration';
-import DataShare from './Read/DataShare/DataShare';
-import Dimensions from './Read/Dimensions/Dimensions';
-import Exports from './Read/Exports/Exports';
-import Filters from './Read/Filters/Filters';
-import Reports from './Read/Reports/Reports';
-import Snowflake from './Read/Snowflake/Snowflake';
-import Statistics from './Read/Statistics/Statistics';
-export default class UsageAnalytics extends Resource {
-    protected api: API;
-    protected serverlessApi: API;
-    statistics: Statistics;
-    dimensions: Dimensions;
-    exports: Exports;
-    administration: Administration;
-    snowflake: Snowflake;
-    reports: Reports;
-    filters: Filters;
-    dataShare: DataShare;
-    constructor(api: API, serverlessApi: API);
-}
+import API from '../../APICore';
+import Resource from '../Resource';
+import Administration from './Read/Administration/Administration';
+import DataShare from './Read/DataShare/DataShare';
+import Dimensions from './Read/Dimensions/Dimensions';
+import Exports from './Read/Exports/Exports';
+import Filters from './Read/Filters/Filters';
+import Reports from './Read/Reports/Reports';
+import Snowflake from './Read/Snowflake/Snowflake';
+import Statistics from './Read/Statistics/Statistics';
+export default class UsageAnalytics extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    statistics: Statistics;
+    dimensions: Dimensions;
+    exports: Exports;
+    administration: Administration;
+    snowflake: Snowflake;
+    reports: Reports;
+    filters: Filters;
+    dataShare: DataShare;
+    constructor(api: API, serverlessApi: API);
+}

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

@@ -1,2 +1,2 @@
-export * from './Read';
-export * from './UsageAnalytics';
+export * from './Read';
+export * from './UsageAnalytics';

package/dist/definitions/resources/Users/User.d.ts

@@ -1,9 +1,9 @@
-import { RealmModel } from '../Groups';
-import Resource from '../Resource';
-import { UserModel } from './UserInterfaces';
-export default class User extends Resource {
-    static baseUrl: string;
-    get(username?: string): Promise<UserModel>;
-    update(user: Partial<UserModel>): Promise<Record<string, unknown>>;
-    listRealms(username: string): Promise<RealmModel[]>;
-}
+import { RealmModel } from '../Groups';
+import Resource from '../Resource';
+import { UserModel } from './UserInterfaces';
+export default class User extends Resource {
+    static baseUrl: string;
+    get(username?: string): Promise<UserModel>;
+    update(user: Partial<UserModel>): Promise<Record<string, unknown>>;
+    listRealms(username: string): Promise<RealmModel[]>;
+}

package/dist/definitions/resources/Users/UserInterfaces.d.ts

@@ -1,29 +1,29 @@
-import { AuthProvider } from '../Enums';
-import { RealmModel } from '../Groups';
-export interface UserModel {
-    additionalInformation: Record<string, any>;
-    country: string;
-    credentialsExpired: boolean;
-    displayName: string;
-    email: string;
-    emailAliases: string[];
-    emailConfirmed: boolean;
-    enabled: boolean;
-    expired: boolean;
-    firstName: string;
-    lastLogin: number;
-    lastName: string;
-    locked: boolean;
-    name: string;
-    provider: AuthProvider;
-    providerUserId: string;
-    providerUsername: string;
-    realms: UserRealmModel[];
-    samlIdentityProviderId: string;
-    socialUser: boolean;
-    username: string;
-}
-export interface UserRealmModel {
-    member: boolean;
-    realm: RealmModel;
-}
+import { AuthProvider } from '../Enums';
+import { RealmModel } from '../Groups';
+export interface UserModel {
+    additionalInformation: Record<string, any>;
+    country: string;
+    credentialsExpired: boolean;
+    displayName: string;
+    email: string;
+    emailAliases: string[];
+    emailConfirmed: boolean;
+    enabled: boolean;
+    expired: boolean;
+    firstName: string;
+    lastLogin: number;
+    lastName: string;
+    locked: boolean;
+    name: string;
+    provider: AuthProvider;
+    providerUserId: string;
+    providerUsername: string;
+    realms: UserRealmModel[];
+    samlIdentityProviderId: string;
+    socialUser: boolean;
+    username: string;
+}
+export interface UserRealmModel {
+    member: boolean;
+    realm: RealmModel;
+}

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

@@ -1,2 +1,2 @@
-export * from './User';
-export * from './UserInterfaces';
+export * from './User';
+export * from './UserInterfaces';

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

@@ -1,33 +1,33 @@
-import { PageModel } from '../BaseInterfaces';
-import { VaultFetchStrategy } from '../Enums';
-import Resource from '../Resource';
-import { MissingVaultModel, VaultEntryListOptions, VaultEntryModel } from './VaultsInterfaces';
-export default class Vaults extends Resource {
-    static baseUrl: string;
-    /**
-     * Find error vault keys for a given snapshot.
-     *
-     * @param {string} snapshotId The unique identifier of the target snapshot.
-     */
-    findMissing(snapshotId: string): Promise<MissingVaultModel>;
-    /**
-     * Import vault entries from the starting organization into the current organization.
-     *
-     * @param {string} currentSnapshotId The unique identifier of the current snapshot.
-     * @param {string} sourceOrganizationId The unique identifier of the source organization.
-     * @param {VaultFetchStrategy} fetchStrategy Choosing the strategy to use when importing vault entries.
-     */
-    import(currentSnapshotId: string, sourceOrganizationId: string, fetchStrategy: VaultFetchStrategy): Promise<Record<string, unknown>>;
-    /**
-     * Create a vault entry.
-     *
-     * @param {VaultEntryModel} model Vault entry model
-     */
-    create(model: VaultEntryModel): Promise<VaultEntryModel>;
-    /**
-     * Get all vault entries for an organization.
-     *
-     * @param {VaultEntryListOptions} options pagination options
-     */
-    list(options?: VaultEntryListOptions): Promise<PageModel<VaultEntryModel, "items">>;
-}
+import { PageModel } from '../BaseInterfaces';
+import { VaultFetchStrategy } from '../Enums';
+import Resource from '../Resource';
+import { MissingVaultModel, VaultEntryListOptions, VaultEntryModel } from './VaultsInterfaces';
+export default class Vaults extends Resource {
+    static baseUrl: string;
+    /**
+     * Find error vault keys for a given snapshot.
+     *
+     * @param {string} snapshotId The unique identifier of the target snapshot.
+     */
+    findMissing(snapshotId: string): Promise<MissingVaultModel>;
+    /**
+     * Import vault entries from the starting organization into the current organization.
+     *
+     * @param {string} currentSnapshotId The unique identifier of the current snapshot.
+     * @param {string} sourceOrganizationId The unique identifier of the source organization.
+     * @param {VaultFetchStrategy} fetchStrategy Choosing the strategy to use when importing vault entries.
+     */
+    import(currentSnapshotId: string, sourceOrganizationId: string, fetchStrategy: VaultFetchStrategy): Promise<Record<string, unknown>>;
+    /**
+     * Create a vault entry.
+     *
+     * @param {VaultEntryModel} model Vault entry model
+     */
+    create(model: VaultEntryModel): Promise<VaultEntryModel>;
+    /**
+     * Get all vault entries for an organization.
+     *
+     * @param {VaultEntryListOptions} options pagination options
+     */
+    list(options?: VaultEntryListOptions): Promise<PageModel<VaultEntryModel, "items">>;
+}

package/dist/definitions/resources/Vaults/VaultsInterfaces.d.ts

@@ -1,29 +1,29 @@
-import { Paginated } from '../BaseInterfaces';
-import { VaultValueType, VaultVisibilityType } from '../Enums';
-import { DeprecatedPaginated } from '../InternalBaseInterface';
-import { ResourceSnapshotType } from '../ResourceSnapshots';
-export interface MissingVaultModel {
-    /**
-     * The list of vault entry keys used in errors.
-     */
-    missingVaultEntries: string[];
-}
-export interface VaultScopeModel {
-    id: string;
-    resourceType: ResourceSnapshotType;
-}
-export interface AttributeReferenceModel {
-    jsonPath: string;
-    resourceName: string;
-    resourceType: ResourceSnapshotType;
-}
-export interface VaultEntryModel {
-    attributeReferences?: AttributeReferenceModel[];
-    key?: string;
-    organizationId?: string;
-    scopes?: VaultScopeModel[];
-    value?: string;
-    valueType?: VaultValueType;
-    vaultVisibilityType?: VaultVisibilityType;
-}
-export declare type VaultEntryListOptions = Paginated | DeprecatedPaginated;
+import { Paginated } from '../BaseInterfaces';
+import { VaultValueType, VaultVisibilityType } from '../Enums';
+import { DeprecatedPaginated } from '../InternalBaseInterface';
+import { ResourceSnapshotType } from '../ResourceSnapshots';
+export interface MissingVaultModel {
+    /**
+     * The list of vault entry keys used in errors.
+     */
+    missingVaultEntries: string[];
+}
+export interface VaultScopeModel {
+    id: string;
+    resourceType: ResourceSnapshotType;
+}
+export interface AttributeReferenceModel {
+    jsonPath: string;
+    resourceName: string;
+    resourceType: ResourceSnapshotType;
+}
+export interface VaultEntryModel {
+    attributeReferences?: AttributeReferenceModel[];
+    key?: string;
+    organizationId?: string;
+    scopes?: VaultScopeModel[];
+    value?: string;
+    valueType?: VaultValueType;
+    vaultVisibilityType?: VaultVisibilityType;
+}
+export declare type VaultEntryListOptions = Paginated | DeprecatedPaginated;

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

@@ -1,2 +1,2 @@
-export * from './Vaults';
-export * from './VaultsInterfaces';
+export * from './Vaults';
+export * from './VaultsInterfaces';

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

@@ -1,46 +1,46 @@
-export { default as Resource } from './Resource';
-export * from './Activities';
-export * from './ApiKeys';
-export * from './AWS';
-export * from './BaseInterfaces';
-export * from './CaseAssistConfigs';
-export * from './Catalogs';
-export * from './Clusters';
-export * from './Connectivity';
-export * from './CrawlingModule';
-export * from './Enums';
-export * from './Extensions';
-export * from './Fields';
-export * from './Global';
-export * from './GlobalGroups';
-export * from './Groups';
-export * from './Indexes';
-export * from './InProductExperiences';
-export * from './InsightPanelConfigs';
-export * from './InsightPanelInterfaces';
-export * from './License';
-export * from './Limits';
-export * from './Links';
-export * from './Logs';
-export * from './MachineLearning';
-export * from './ModifierTemplates';
-export * from './Notification';
-export * from './Organizations';
-export * from './OrganizationAccess';
-export * from './Pipelines';
-export * from './PlatformResources';
-export * from './PrivilegeEvaluator';
-export * from './Products';
-export * from './PushApi';
-export * from './ResourceSnapshots';
-export * from './Saml';
-export * from './SchemaService';
-export * from './Search';
-export * from './SearchInterfaces';
-export * from './SearchPages';
-export * from './SearchUsageMetrics';
-export * from './SecurityCache';
-export * from './Sources';
-export * from './TableauService';
-export * from './UsageAnalytics';
-export * from './Vaults';
+export { default as Resource } from './Resource';
+export * from './Activities';
+export * from './ApiKeys';
+export * from './AWS';
+export * from './BaseInterfaces';
+export * from './CaseAssistConfigs';
+export * from './Catalogs';
+export * from './Clusters';
+export * from './Connectivity';
+export * from './CrawlingModule';
+export * from './Enums';
+export * from './Extensions';
+export * from './Fields';
+export * from './Global';
+export * from './GlobalGroups';
+export * from './Groups';
+export * from './Indexes';
+export * from './InProductExperiences';
+export * from './InsightPanelConfigs';
+export * from './InsightPanelInterfaces';
+export * from './License';
+export * from './Limits';
+export * from './Links';
+export * from './Logs';
+export * from './MachineLearning';
+export * from './ModifierTemplates';
+export * from './Notification';
+export * from './Organizations';
+export * from './OrganizationAccess';
+export * from './Pipelines';
+export * from './PlatformResources';
+export * from './PrivilegeEvaluator';
+export * from './Products';
+export * from './PushApi';
+export * from './ResourceSnapshots';
+export * from './Saml';
+export * from './SchemaService';
+export * from './Search';
+export * from './SearchInterfaces';
+export * from './SearchPages';
+export * from './SearchUsageMetrics';
+export * from './SecurityCache';
+export * from './Sources';
+export * from './TableauService';
+export * from './UsageAnalytics';
+export * from './Vaults';

package/dist/definitions/utils/FormData.d.ts

@@ -0,0 +1 @@
+export declare const getFormData: () => FormData;

package/dist/definitions/utils/Retriever.d.ts

@@ -1,3 +1,3 @@
-export declare type Retrievable<T> = T | (() => T);
-declare const _default: <T>(parameter: Retrievable<T>) => T;
-export default _default;
+export declare type Retrievable<T> = T | (() => T);
+declare const _default: <T>(parameter: Retrievable<T>) => T;
+export default _default;

package/dist/definitions/utils/WithRequired.d.ts

@@ -1,3 +1,3 @@
-export declare type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
-    [Property in Key]-?: Type[Property];
-};
+export declare type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
+    [Property in Key]-?: Type[Property];
+};

package/dist/definitions/utils/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Retriever';
-export * from './WithRequired';
+export * from './Retriever';
+export * from './WithRequired';

package/dist/definitions/utils/normalizePaginatedOptions.d.ts

@@ -1,3 +1,3 @@
-import { Paginated } from '../resources';
-import { DeprecatedPaginated } from '../resources/InternalBaseInterface';
-export declare const normalizePaginatedOptions: (options: Paginated | DeprecatedPaginated) => DeprecatedPaginated;
+import { Paginated } from '../resources';
+import { DeprecatedPaginated } from '../resources/InternalBaseInterface';
+export declare const normalizePaginatedOptions: (options: Paginated | DeprecatedPaginated) => DeprecatedPaginated;

package/dist/handlers/ResponseHandlerInterfaces.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ResponseHandlerInterfaces.js.map

package/dist/handlers/ResponseHandlers.js

@@ -1,46 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseHandlers = exports.defaultResponseHandlers = void 0;
-var tslib_1 = require("tslib");
-var noContent = {
-    canProcess: function (response) { return response.status === 204; },
-    process: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
-        return [2 /*return*/, ({})];
-    }); }); },
-};
-var success = {
-    canProcess: function (response) { return response.ok; },
-    process: function (response) { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, response.json()];
-            case 1: return [2 /*return*/, _a.sent()];
-        }
-    }); }); },
-};
-var successBlob = {
-    canProcess: function (response) { return response.ok; },
-    process: function (response) { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, response.blob()];
-            case 1: return [2 /*return*/, _a.sent()];
-        }
-    }); }); },
-};
-var error = {
-    canProcess: function () { return true; },
-    process: function (response) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
-        return tslib_1.__generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, response.json()];
-                case 1: throw _a.sent();
-            }
-        });
-    }); },
-};
-exports.defaultResponseHandlers = [noContent, success, error];
-exports.ResponseHandlers = { noContent: noContent, success: success, successBlob: successBlob, error: error };
-exports.default = (function (response, handlers) {
-    if (handlers === void 0) { handlers = exports.defaultResponseHandlers; }
-    return handlers.filter(function (handler) { return handler.canProcess(response); })[0].process(response);
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseHandlers = exports.defaultResponseHandlers = void 0;
+var tslib_1 = require("tslib");
+var noContent = {
+    canProcess: function (response) { return response.status === 204; },
+    process: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
+        return [2 /*return*/, ({})];
+    }); }); },
+};
+var success = {
+    canProcess: function (response) { return response.ok; },
+    process: function (response) { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, response.json()];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    }); }); },
+};
+var successBlob = {
+    canProcess: function (response) { return response.ok; },
+    process: function (response) { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, response.blob()];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    }); }); },
+};
+var error = {
+    canProcess: function () { return true; },
+    process: function (response) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, response.json()];
+                case 1: throw _a.sent();
+            }
+        });
+    }); },
+};
+exports.defaultResponseHandlers = [noContent, success, error];
+exports.ResponseHandlers = { noContent: noContent, success: success, successBlob: successBlob, error: error };
+exports.default = (function (response, handlers) {
+    if (handlers === void 0) { handlers = exports.defaultResponseHandlers; }
+    return handlers.filter(function (handler) { return handler.canProcess(response); })[0].process(response);
+});
 //# sourceMappingURL=ResponseHandlers.js.map

package/dist/handlers/index.js

@@ -1,6 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./ResponseHandlers"), exports);
-tslib_1.__exportStar(require("./ResponseHandlerInterfaces"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./ResponseHandlers"), exports);
+tslib_1.__exportStar(require("./ResponseHandlerInterfaces"), exports);
 //# sourceMappingURL=index.js.map

package/dist/resources/AWS/AWS.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-var Resource_1 = tslib_1.__importDefault(require("../Resource"));
-var AWS = /** @class */ (function (_super) {
-    tslib_1.__extends(AWS, _super);
-    function AWS() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    AWS.prototype.list = function (options) {
-        if (options === void 0) { options = { organizationId: this.api.organizationId }; }
-        return this.api.get(this.buildPath(AWS.baseUrl, options));
-    };
-    AWS.baseUrl = "/rest/aws/instances/agents";
-    return AWS;
-}(Resource_1.default));
-exports.default = AWS;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var Resource_1 = tslib_1.__importDefault(require("../Resource"));
+var AWS = /** @class */ (function (_super) {
+    tslib_1.__extends(AWS, _super);
+    function AWS() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    AWS.prototype.list = function (options) {
+        if (options === void 0) { options = { organizationId: this.api.organizationId }; }
+        return this.api.get(this.buildPath(AWS.baseUrl, options));
+    };
+    AWS.baseUrl = "/rest/aws/instances/agents";
+    return AWS;
+}(Resource_1.default));
+exports.default = AWS;
 //# sourceMappingURL=AWS.js.map

package/dist/resources/AWS/AWSInterfaces.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=AWSInterfaces.js.map

package/dist/resources/AWS/index.js

@@ -1,6 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./AWS"), exports);
-tslib_1.__exportStar(require("./AWSInterfaces"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./AWS"), exports);
+tslib_1.__exportStar(require("./AWSInterfaces"), exports);
 //# sourceMappingURL=index.js.map