UNPKG

@coveo/platform-client

Version:

The main goal of this package is to provide an easy to configure and straightforward way of querying Coveo Cloud APIs using JavaScript.

1,125 lines (1,124 loc) 30.5 kB
export declare enum AccessLevel { EDIT_ALL = "EDIT_ALL", CUSTOM = "CUSTOM", VIEW_ALL = "VIEW_ALL", NONE = "NONE" } export declare enum PrivilegeHolderType { API_KEY = "API_KEY", GROUP = "GROUP" } /** * @deprecated use `PrivilegeHolderType` instead. */ export type PrivilegeholderType = PrivilegeHolderType; export declare enum AuthProvider { SALESFORCE = "SALESFORCE", SALESFORCE_SANDBOX = "SALESFORCE_SANDBOX", GOOGLE = "GOOGLE", OFFICE365 = "OFFICE365", SAML = "SAML", EMAIL = "EMAIL" } export declare enum SecurityCacheStateOptions { Unknown = "UNKNOWN", UpToDate = "UP_TO_DATE", NotUpdated = "NOT_UPDATED", OutOfDate = "OUT_OF_DATE", InError = "IN_ERROR", Disabled = "DISABLED" } export declare enum ScheduleType { Minutely = "MINUTELY", Hourly = "HOURLY", Daily = "DAILY", Weekly = "WEEKLY", Monthly = "MONTHLY" } export declare enum FieldTypes { LONG = "LONG", LONG_64 = "LONG_64", DOUBLE = "DOUBLE", DATE = "DATE", STRING = "STRING", VECTOR = "VECTOR" } export declare enum FieldOrigin { ALL = "ALL", USER = "USER", SYSTEM = "SYSTEM" } export declare enum FacetOrSortStatus { ALL = "ALL", TRUE_ONLY = "TRUE_ONLY", FALSE_ONLY = "FALSE_ONLY" } export declare enum SortingOrder { ASC = "ASC", DESC = "DESC" } export declare enum SortingBy { RELEVANCY = "relevancy", DATE = "date", FIELD = "field" } export declare enum OperationType { REBUILD = "REBUILD", FULL_REFRESH = "FULL_REFRESH", INCREMENTAL_REFRESH = "INCREMENTAL_REFRESH", SECURITY_PROVIDER_REFRESH = "SECURITY_PROVIDER_REFRESH", SECURITY_PROVIDER_REFRESH_ENTITIES_IN_ERROR = "SECURITY_PROVIDER_REFRESH_ENTITIES_IN_ERROR", SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED = "SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED", SECURITY_CACHE_REFRESH = "SECURITY_CACHE_REFRESH", SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR = "SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR" } export declare enum DataStreamType { BODY_TEXT = "BODY_TEXT", BODY_HTML = "BODY_HTML", THUMBNAIL = "THUMBNAIL", DOCUMENT_DATA = "DOCUMENT_DATA" } export declare enum ExtensionLanguageType { 'PYTHON3' = "PYTHON3" } export declare enum SourceOperationalStatus { ALL = "ALL", LAST_OPERATION_IN_ERROR = "LAST_OPERATION_IN_ERROR", OK = "OK", PAUSED = "PAUSED", READY = "READY", RUNNING = "RUNNING" } export declare enum SourceStatusType { CREATING = "CREATING", DISABLED = "DISABLED", ERROR = "ERROR", IDLE = "IDLE", PAUSED = "PAUSED", PAUSED_ON_ERROR = "PAUSED_ON_ERROR", PUSH_READY = "PUSH_READY", REFRESHING = "REFRESHING" } export declare enum SourceStatusTypeWithTransition { CANCELING = "CANCELING", CREATING = "CREATING", DELETING = "DELETING", DISABLED = "DISABLED", ERROR = "ERROR", IDLE = "IDLE", PAUSED = "PAUSED", PAUSED_ON_ERROR = "PAUSED_ON_ERROR", PAUSING = "PAUSING", PUSH_READY = "PUSH_READY", REFRESHING = "REFRESHING", RESUMING = "RESUMING", STARTING_REFRESH = "STARTING_REFRESH" } export declare enum SourceType { /** * @deprecated */ ADOBE_EXPERIENCE_MANAGER = "ADOBE_EXPERIENCE_MANAGER", AMAZONS3 = "AMAZONS3", BOX_ENTERPRISE2 = "BOX_ENTERPRISE2", CATALOG = "CATALOG", /** * @deprecated */ CONFLUENCE = "CONFLUENCE", CONFLUENCE2 = "CONFLUENCE2", CONFLUENCE2_HOSTED = "CONFLUENCE2_HOSTED", CUSTOM = "CUSTOM", DATABASE = "DATABASE", DROPBOX_FOR_BUSINESS = "DROPBOX_FOR_BUSINESS", FILE = "FILE", GENERIC_REST = "GENERIC_REST", GOOGLE_DRIVE_DOMAIN_WIDE = "GOOGLE_DRIVE_DOMAIN_WIDE", GRAPHQL = "GRAPHQL", JIRA2 = "JIRA2", JIRA2_HOSTED = "JIRA2_HOSTED", JIVE = "JIVE", JIVE_HOSTED = "JIVE_HOSTED", KHOROS = "KHOROS", LITHIUM = "LITHIUM", MICROSOFT_DYNAMICS = "MICROSOFT_DYNAMICS", PUSH = "PUSH", RSS = "RSS", SALESFORCE = "SALESFORCE", SALESFORCE_SITES = "SALESFORCE_SITES", SAP = "SAP", SERVICENOW = "SERVICENOW", SHAREPOINT = "SHAREPOINT", SHAREPOINT_ONLINE2 = "SHAREPOINT_ONLINE2", SITECORE = "SITECORE", SITEMAP = "SITEMAP", SLACK = "SLACK", WEB2 = "WEB2", YOUTUBE = "YOUTUBE", ZENDESK = "ZENDESK" } export declare enum SourceVisibility { PRIVATE = "PRIVATE", SECURED = "SECURED", SHARED = "SHARED" } export declare enum SourceCategory { CLOUD = "CLOUD", ON_PREM = "ON_PREM", CRAWLING_MODULE = "CRAWLING_MODULE" } export declare enum IndexBackupTypes { FULL = "FULL", NONE = "NONE", REGULAR = "REGULAR" } export declare enum IndexType { COVEO = "COVEO", ELASTIC = "ELASTIC", INDEX_LESS = "INDEX_LESS", ON_PREMISES = "ON_PREMISES" } export declare enum FilterHostType { CLOUD = "CLOUD", CRAWLING_MODULE = "CRAWLING_MODULE", PUSH = "PUSH" } export declare enum FilterLastOperationResultType { SUCCESS = "SUCCESS", ERROR = "ERROR", ABORT = "ABORT" } export declare enum FilterLastOperationType { INCREMENTAL_REFRESH = "INCREMENTAL_REFRESH", FULL_REFRESH = "FULL_REFRESH", REBUILD = "REBUILD" } export declare enum FilterStatusType { CREATING = "CREATING", REFRESHING = "REFRESHING", PAUSED = "PAUSED", PAUSED_ON_ERROR = "PAUSED_ON_ERROR", IDLE = "IDLE", ERROR = "ERROR" } export declare enum UpdateStatusCategory { MINOR = "MINOR", CRITICAL = "CRITICAL", BREAKING = "BREAKING" } export declare enum SortingType { TYPE = "TYPE", NAME = "NAME", STATUS = "STATUS", CONTENT = "CONTENT", LAST_MODIFIED_DATE = "LAST_MODIFIED_DATE", LAST_OPERATION = "LAST_OPERATION", CONTENT_TOTAL_DOCUMENT_SIZE = "CONTENT_TOTAL_DOCUMENT_SIZE", STATUS_PRIORITY = "STATUS_PRIORITY" } export declare enum SnapshotSortingType { CREATED_DATE = "CREATED_DATE", DEVELOPER_NOTE = "DEVELOPER_NOTE", CREATED_BY = "CREATED_BY", ORIGIN_ID = "ORIGIN_ID" } export declare enum ActivityOperation { APPLY = "APPLY", ARCHIVE = "ARCHIVE", ARCHIVE_WARNING = "ARCHIVE_WARNING", BACKUP = "BACKUP", CHANGE_ONLINE = "CHANGE_ONLINE", CHANGE_READ_ONLY = "CHANGE_READ_ONLY", COMMIT = "COMMIT", CONFIG_CHANGE = "CONFIG_CHANGE", CONFIG_CREATE = "CONFIG_CREATE", CREATE = "CREATE", DECLINE = "DECLINE", DELETE = "DELETE", DISABLE = "DISABLE", DUPLICATE = "DUPLICATE", ENABLE = "ENABLE", ENABLE_DISABLED_ENTITIES = "ENABLE_DISABLED_ENTITIES", EXPORT = "EXPORT", FULL_REFRESH = "FULL_REFRESH", IDLE = "IDLE", IMPORT = "IMPORT", INCREMENTAL_REFRESH = "INCREMENTAL_REFRESH", LIMIT_ALMOST_REACHED = "LIMIT_ALMOST_REACHED", LIMIT_EXCEEDED = "LIMIT_EXCEEDED", LIMIT_REACHED = "LIMIT_REACHED", LOG_REQUEST = "LOG_REQUEST", METADATA_REPORT = "METADATA_REPORT", MODEL_BUILD = "MODEL_BUILD", MODEL_REFRESH = "MODEL_REFRESH", ORG_PROVISIONING_CHECK = "ORG_PROVISIONING_CHECK", PAUSE = "PAUSE", PAUSE_ON_ERROR = "PAUSE_ON_ERROR", REBUILD = "REBUILD", REFRESH = "REFRESH", REFRESH_CANCEL = "REFRESH_CANCEL", REFRESH_ENTITIES_IN_ERROR = "REFRESH_ENTITIES_IN_ERROR", REFRESH_ENTITIES_NOT_UPDATED = "REFRESH_ENTITIES_NOT_UPDATED", REFRESH_ENTITY = "REFRESH_ENTITY", RESIZE = "RESIZE", RESTORE = "RESTORE", RESUME = "RESUME", ROTATE = "ROTATE", SCHEDULE_CHANGE = "SCHEDULE_CHANGE", SCHEDULE_CREATE = "SCHEDULE_CREATE", SCHEDULE_DELETE = "SCHEDULE_DELETE", SEARCH_CERTIFICATE_UPDATE = "SEARCH_CERTIFICATE_UPDATE", SEARCH_INCIDENT = "SEARCH_INCIDENT", SEND_RESOURCE_SNAPSHOT = "SEND_RESOURCE_SNAPSHOT", START = "START", STOP = "STOP", SYNCHRONIZE = "SYNCHRONIZE", TEST = "TEST", UPDATE = "UPDATE", UPGRADE = "UPGRADE", UPGRADE_REVERT = "UPGRADE_REVERT", VALIDATE = "VALIDATE" } export declare enum SecurityProviderType { /** * @deprecated */ ACTIVE_DIRECTORY = "ACTIVE_DIRECTORY", ACTIVE_DIRECTORY2 = "ACTIVE_DIRECTORY2", BOX = "BOX", CLAIMS = "CLAIMS", CLAIMS_TO_EMAIL = "CLAIMS_TO_EMAIL", /** * @deprecated */ CONFLUENCE = "CONFLUENCE", CONFLUENCE2 = "CONFLUENCE2", CUSTOM = "CUSTOM", DATABASE = "DATABASE", DROPBOX_FOR_BUSINESS = "DROPBOX_FOR_BUSINESS", EMAIL = "EMAIL", EXPANDED = "EXPANDED", FILE = "FILE", GOOGLE_DRIVE_DOMAIN_WIDE = "GOOGLE_DRIVE_DOMAIN_WIDE", GENERIC_REST = "GENERIC_REST", GRAPHQL = "GRAPHQL", JIRA2 = "JIRA2", JIVE = "JIVE", KHOROS_COMMUNITY = "KHOROS_COMMUNITY", MICROSOFT_DYNAMICS = "MICROSOFT_DYNAMICS", OFFICE365 = "OFFICE365", SALESFORCE = "SALESFORCE", SERVICENOW = "SERVICENOW", SHAREPOINT = "SHAREPOINT", SHAREPOINT_ONLINE = "SHAREPOINT_ONLINE", SITECORE = "SITECORE", SLACK = "SLACK", ZENDESK = "ZENDESK" } export declare enum SecurityProviderStatusType { PENDING_REFRESH = "PENDING_REFRESH", REFRESHING = "REFRESHING", IDLE = "IDLE", ERROR = "ERROR" } export declare enum RestUserIdType { User = "User", Group = "Group", VirtualGroup = "VirtualGroup", Unknown = "Unknown" } export declare enum ExcerptSource { Document = "Document", Summary = "Summary" } export declare enum MappingModelKind { COMMON = "COMMON", MAPPING = "MAPPING" } export declare enum DocumentPermissionState { UNKNOWN = "UNKNOWN", VALID = "VALID", PENDING = "PENDING", INCOMPLETE = "INCOMPLETE", IN_ERROR = "IN_ERROR", WARNING = "WARNING" } export declare enum DocumentConfigurationType { DEFAULT = "DEFAULT", PUSH = "PUSH" } export declare enum SourceExtensionActionOnError { REJECT_DOCUMENT = "REJECT_DOCUMENT", SKIP_EXTENSION = "SKIP_EXTENSION" } export declare enum UrlFilterType { WILDCARD = "WILDCARD", REGEX = "REGEX" } export declare enum SinglePermissionIdentityType { USER = "USER", GROUP = "GROUP", VIRTUAL_GROUP = "VIRTUAL_GROUP", UNKNOWN = "UNKNOWN" } export declare enum SinglePermissionResult { NONE = "NONE", SUCCESS = "SUCCESS", ACCESS_DENIED = "ACCESS_DENIED", TIMED_OUT = "TIMED_OUT", ENTITY_IS_INVALID = "ENTITY_IS_INVALID", ENTITY_IS_UNAVAILABLE = "ENTITY_IS_UNAVAILABLE", SECURITY_PROVIDER_IS_UNAVAILABLE = "SECURITY_PROVIDER_IS_UNAVAILABLE", SECURITY_PROVIDER_IS_UNREACHABLE = "SECURITY_PROVIDER_IS_UNREACHABLE", SECURITY_PROVIDER_IS_NOT_READY = "SECURITY_PROVIDER_IS_NOT_READY", UNEXPECTED_ERROR = "UNEXPECTED_ERROR" } export declare enum SinglePermissionState { UNKNOWN = "UNKNOWN", UP_TO_DATE = "UP_TO_DATE", NOT_UPDATED = "NOT_UPDATED", OUT_OF_DATE = "OUT_OF_DATE", IN_ERROR = "IN_ERROR", DISABLED = "DISABLED" } export declare enum SourceSecurityOption { Retrieve = "Retrieve", Specified = "Specified", Merge = "Merge" } export declare enum PatternType { Wildcard = "Wildcard", RegEx = "RegEx" } export declare enum AuthenticationActionMethod { Post = "Post", Get = "Get" } export declare enum AuthenticationInputType { Text = "Text", Password = "Password", Checkbox = "Checkbox", Radio = "Radio", Submit = "Submit", Reset = "Reset", File = "File", Hidden = "Hidden", Image = "Image", Button = "Button" } export declare enum ExtensionSettingAction { Retrieve = "Retrieve", Reference = "Reference", Ignore = "Ignore" } export declare enum ExtensionSettingActionOnError { Reference = "Reference", Ignore = "Ignore" } export declare enum ExtensionSettingConverter { Detect = "Detect", Skip = "Skip", Html = "Html", IFilter = "IFilter", Wordperfect = "Wordperfect", Rtf = "Rtf", Excel = "Excel", Word = "Word", Pdf = "Pdf", Powerpoint = "Powerpoint", Plain = "PlainText", Zip = "Zip", Xml = "Xml", Msg = "Msg", Mime = "Mime", Image = "Image" } export declare enum PermissionIdentityType { Unknown = "Unknown", User = "User", Group = "Group", VirtualGroup = "VirtualGroup" } export declare enum SecurityCacheFilteringMode { PREFIX = "PREFIX", SUBSTRING = "SUBSTRING" } export declare enum SecurityProviderReferenceType { SOURCE = "SOURCE", SECURITY_PROVIDER = "SECURITY_PROVIDER" } export declare enum IntervalUnit { DAY = "DAY", WEEK = "WEEK", MONTH = "MONTH" } export declare enum ModelStatus { DELETED = "DELETED", SCHEDULING = "SCHEDULING", SCHEDULED = "SCHEDULED", ERROR = "ERROR", PENDING = "PENDING", REGISTERED = "REGISTERED", REGISTERED_DEGRADED = "REGISTERED_DEGRADED", PAUSED = "PAUSED", REGISTERING = "REGISTERING", REGISTERING_DEGRADED = "REGISTERING_DEGRADED", REGISTERING_UPDATE_DEGRADED = "REGISTERING_UPDATE_DEGRADED", IN_PROGRESS = "IN_PROGRESS", ERROR_DELETING = "ERROR_DELETING", COMPLETED = "COMPLETED", COMPLETED_DEGRADED = "COMPLETED_DEGRADED", ONLINE = "ONLINE", ONLINE_DEGRADED = "ONLINE_DEGRADED", OFFLINE = "OFFLINE", IN_QUEUE = "IN_QUEUE", BUILDING = "BUILDING", FAILED = "FAILED", IN_QUEUE_UPDATING = "IN_QUEUE_UPDATING", IN_PROGRESS_UPDATING = "IN_PROGRESS_UPDATING", UPDATING = "UPDATING", DEGRADED = "DEGRADED", UPDATING_DEGRADED = "UPDATING_DEGRADED", UPDATE_FAILED = "UPDATE_FAILED" } export declare enum ModelActivenessState { ACTIVE = "ACTIVE", INACTIVE = "INACTIVE", ARCHIVED = "ARCHIVED", ARCHIVED_PENDING_REBUILD = "ARCHIVED_PENDING_REBUILD" } export declare enum ModelConfigFileType { ADVANCED_CONFIGURATION = "ADVANCED_CONFIGURATION", STOPWORDS = "STOPWORDS", BLACKLISTS = "BLACKLISTS", ID_MAPPING = "ID_MAPPING", FACET_ID_MAPPING = "FACET_ID_MAPPING", DEFAULT_QUERIES = "DEFAULT_QUERIES" } export declare enum ProductType { ALLIANCE = "ALLIANCE", INTERNAL = "INTERNAL", SALES = "SALES", SANDBOX = "SANDBOX", STANDARD = "STANDARD", TEST = "TEST", TRIAL = "TRIAL" } export declare enum ProductEdition { BASE = "BASE", ENTERPRISE = "ENTERPRISE", FREE = "FREE", PRO = "PRO", STANDARD = "STANDARD" } export declare enum ProductName { COVEO_CLOUD = "COVEO_CLOUD", DYNAMICS = "DYNAMICS", SALESFORCE = "SALESFORCE", SERVICENOW = "SERVICENOW", SITECORE = "SITECORE", USAGE_ANALYTICS = "USAGE_ANALYTICS" } export declare enum LanguageCode { AA = "aa", AB = "ab", AE = "ae", AF = "af", AK = "ak", AM = "am", AN = "an", AR = "ar", AS = "as", AV = "av", AY = "ay", AZ = "az", BA = "ba", BE = "be", BG = "bg", BH = "bh", BI = "bi", BM = "bm", BN = "bn", BO = "bo", BR = "br", BS = "bs", CA = "ca", CE = "ce", CH = "ch", CO = "co", CR = "cr", CS = "cs", CU = "cu", CV = "cv", CY = "cy", DA = "da", DE = "de", DV = "dv", EE = "ee", EL = "el", EN = "en", EO = "eo", ES = "es", ET = "et", EU = "eu", FA = "fa", FF = "ff", FI = "fi", FJ = "fj", FO = "fo", FR = "fr", FY = "fy", GA = "ga", GD = "gd", GL = "gl", GN = "gn", GU = "gu", GV = "gv", HA = "ha", HE = "he", HI = "hi", HO = "ho", HR = "hr", HT = "ht", HU = "hu", HY = "hy", HZ = "hz", IA = "ia", ID = "id", IE = "ie", IG = "ig", II = "ii", IK = "ik", IO = "io", IS = "is", IT = "it", IU = "iu", JA = "ja", JV = "jv", KA = "ka", KG = "kg", KI = "ki", KJ = "kj", KK = "kk", KL = "kl", KM = "km", KN = "kn", KO = "ko", KR = "kr", KS = "ks", KU = "ku", KV = "kv", KW = "kw", KY = "ky", LA = "la", LB = "lb", LG = "lg", LI = "li", LN = "ln", LO = "lo", LT = "lt", LU = "lu", LV = "lv", MG = "mg", MH = "mh", MI = "mi", MK = "mk", ML = "ml", MN = "mn", MR = "mr", MS = "ms", MT = "mt", MY = "my", NA = "na", NB = "nb", ND = "nd", NE = "ne", NG = "ng", NL = "nl", NN = "nn", NO = "no", NR = "nr", NV = "nv", NY = "ny", OC = "oc", OJ = "oj", OM = "om", OR = "or", OS = "os", PA = "pa", PI = "pi", PL = "pl", PS = "ps", PT = "pt", QU = "qu", RM = "rm", RN = "rn", RO = "ro", RU = "ru", RW = "rw", SA = "sa", SC = "sc", SD = "sd", SE = "se", SG = "sg", SI = "si", SK = "sk", SL = "sl", SM = "sm", SN = "sn", SO = "so", SQ = "sq", SR = "sr", SS = "ss", ST = "st", SU = "su", SV = "sv", SW = "sw", TA = "ta", TE = "te", TG = "tg", TH = "th", TI = "ti", TK = "tk", TL = "tl", TN = "tn", TO = "to", TR = "tr", TS = "ts", TT = "tt", TW = "tw", TY = "ty", UG = "ug", UK = "uk", UR = "ur", UZ = "uz", VE = "ve", VI = "vi", VO = "vo", WA = "wa", WO = "wo", XH = "xh", YI = "yi", YO = "yo", ZA = "za", ZH = "zh" } export declare enum StatementsFeature { Filter = "filter", Trigger = "trigger", Ranking = "ranking", Stop = "stop", Thesaurus = "thesaurus", Top = "top", ResultRankings = "resultRankings", TopClicks = "topClicks", QuerySuggest = "querySuggest", RankingWeight = "rankingweight", Recommendation = "recommendation", QueryParamOverride = "queryParamOverride" } export declare enum StatementsSubFeature { QueryParamOverride = "queryParamOverride", QuerySuggestParamOverride = "querySuggestParamOverride" } export declare enum ResultRankingsKind { featuredResults = "featured_result", rankingExpression = "ranking_expression" } export declare enum ResultRankingsRuleTypes { featuredResults = "featuredResults", rankingExpressions = "rankingExpressions" } export declare enum ResultRankingsStatuses { active = "active", inactive = "inactive" } export declare enum ResultRankingLocales { all = "all", unspecified = "unspecified", specific = "specific" } export declare enum ResultRankingMatchOperators { is = "is", contains = "contains", matches = "matches" } export declare enum ResultRankingPredicateKind { basicExpressionAndLocalePredicate = "basicExpressionAndLocalePredicate", qplPredicate = "qplPredicate" } export declare enum PredicateKind { BasicExpressionAndLocalePredicate = "basicExpressionAndLocalePredicate", QPLPredicate = "qplPredicate" } export declare enum PredicateLocaleKind { All = "all", Unspecified = "unspecified", Specific = "specific" } export declare enum PredicateMatchOperator { Is = "is", Contain = "contains", Matches = "matches" } export declare enum FacetRuleKind { AutoSelect = "autoSelect" } export declare enum FacetRuleState { Selected = "selected" } export declare enum ResultRankingLocalizedContentLocales { auto = "auto", specific = "specific" } export declare enum ListStatementSortBy { Position = "position", Definition = "definition", Description = "description" } export declare enum StatementGroupType { campaign = "campaign", permanent = "permanent" } /** * An union of all the possible status that you can filter on. */ export declare enum ListStatementGroupStatusType { Active = "active", Inactive = "inactive", Expired = "expired", NotStarted = "notStarted" } export declare enum CampaignStatementGroupStatusType { Active = "active", Inactive = "inactive", Expired = "expired", NotStarted = "notStarted" } export declare enum PermanentStatementGroupStatusType { Active = "active", Inactive = "inactive" } export declare enum DimensionType { TEXT = "TEXT", NUMBER = "NUMBER", SHORT = "SHORT", BOOLEAN = "BOOLEAN", DATE = "DATE", DATETIME = "DATETIME" } export declare enum AccountStatus { AVAILABLE = "AVAILABLE", CREATING = "CREATING", DELETING = "DELETING" } export declare enum DimensionStatus { AVAILABLE = "AVAILABLE", UPDATING = "UPDATING" } export declare enum DimensionEventTypes { searches = "searches", clicks = "clicks", custom_events = "custom_events" } export declare enum RegionType { Primary = "PRIMARY", Secondary = "SECONDARY" } export declare enum FormAuthenticationFailedMethod { RedirectedToUrl = "RedirectedToUrl", PageDoesNotContain = "PageDoesNotContain", PageContains = "PageContains", CookieNotSet = "CookieNotSet", UrlMatch = "UrlMatch", UrlDoesNotMatch = "UrlDoesNotMatch" } export declare enum FormInputType { Username = "Username", Password = "Password", Input = "Input" } export declare enum ModelTypes { TopClicks = "topclicks", PredictiveQuerySuggest = "predictivequerysuggest", QuerySuggest = "querysuggest", PQSForCommerce = "pqsforcommerce", EventRecommendation = "eventrecommendation", FacetSense = "facetsense", ECommerce = "ecommerce", CaseClassification = "caseclassification", SmartSnippets = "mlquestionanswering", IntentAwareProductRanking = "intentranking", RelevanceGenerativeAnswering = "genqa", SemanticEncoder = "embeddings" } export declare enum LicenseSection { internal = "internal", organization = "organization", usageAnalytics = "usageAnalytics", inProductExperience = "inProductExperience", commerce = "commerce", content = "content", searchapi = "searchapi" } export declare enum SearchHubRawMetrics { normalQueries = "normalQueries", recommendationQueries = "recommendationQueries", commerceProductListingQueries = "commerceProductListingQueries", users = "users", staticQueries = "staticQueries" } export declare enum SearchHubLicenseMetrics { normalQueries = "normalQueries", commerceProductListingQueries = "commerceProductListingQueries", recommendationsQueries = "recommendationsQueries", agents = "agents", intranetUsers = "intranetUsers", partnerUsers = "partnerUsers", platformIntranetUsers = "platformIntranetUsers", platformAgents = "platformAgents", platformPortalUsers = "platformPortalUsers", salesforceServiceCloudAgents = "salesforceServiceCloudAgents", salesforceSalesCloudUsers = "salesforceSalesCloudUsers", salesforcePlatformUsers = "salesforcePlatformUsers", salesforceCommunityCloudUsers = "salesforceCommunityCloudUsers", snowCSMAgents = "snowCSMAgents", snowFulfillers = "snowFulfillers", snowITSMUsers = "snowITSMUsers", snowHRSDUsers = "snowHRSDUsers", dynamicsCustomerEngagementUsers = "dynamicsCustomerEngagementUsers", staticQueries = "staticQueries", coveoForServiceNowFulfillersAndFieldAgents = "coveoForServiceNowFulfillersAndFieldAgents", coveoForSalesforceExperienceCloudCommunity = "coveoForSalesforceExperienceCloudCommunity", coveoForSalesforceExperienceCloud = "coveoForSalesforceExperienceCloud", coveoForDynamicsCustomerEngagement = "coveoForDynamicsCustomerEngagement", coveoForServiceNowEmployeeExperience = "coveoForServiceNowEmployeeExperience", coveoForServiceNowCSMPortal = "coveoForServiceNowCSMPortal", coveoForSalesforceSalesCloud = "coveoForSalesforceSalesCloud", coveoForAppDirect = "coveoForAppDirect", coveoForB2BECommerce = "coveoForB2BECommerce", coveoForCommerce = "coveoForCommerce", coveoForEcommerce = "coveoForEcommerce", coveoForEcommerceSitecore = "coveoForEcommerceSitecore", coveoForSalesforceB2BEcommerce = "coveoForSalesforceB2BEcommerce", coveoForSAPCommerceCloud = "coveoForSAPCommerceCloud", coveoForSAPHybris = "coveoForSAPHybris", coveoForSitecoreDigitalCommerceV4 = "coveoForSitecoreDigitalCommerceV4", coveoForSitecoreUnifiedCommerceV4 = "coveoForSitecoreUnifiedCommerceV4", coveoForSitecoreEcommerce = "coveoForSitecoreEcommerce", coveoSearchForEcommerce = "coveoSearchForEcommerce", coveoForSalesforcePlatform = "coveoForSalesforcePlatform", coveoForSelfService = "coveoForSelfService", coveoForZendeskPortals = "coveoForZendeskPortals", coveoForSalesforceServiceCloud = "coveoForSalesforceServiceCloud", coveoForAdobe = "coveoForAdobe", coveoForSitecore = "coveoForSitecore", coveoForSitecoreStandard = "coveoForSitecoreStandard", coveoForWebsites = "coveoForWebsites", coveoSearchForSitecore = "coveoSearchForSitecore", coveoSearchForWebsites = "coveoSearchForWebsites", coveoPlatform = "coveoPlatform", coveoSearch = "coveoSearch", coveoForContactCenter = "coveoForContactCenter", coveoForZendeskAgents = "coveoForZendeskAgents", coveoForIntranets = "coveoForIntranets", coveoSearchForIntranets = "coveoSearchForIntranets", coveoForDynamicsPortal = "coveoForDynamicsPortal", coveoForSelfServicePlatformPortals = "coveoForSelfServicePlatformPortals", coveoForServiceNowCsmAgents = "coveoForServiceNowCsmAgents" } export declare enum SearchHubLicenseType { assignment = "assignment", global = "global" } export declare enum SubscriptionFrequencyEnum { live = "LIVE", hourly = "HOURLY", daily = "DAILY", weekly = "WEEKLY" } export declare enum SubscriptionTypeEnum { email = "EMAIL", emailJson = "EMAIL_JSON", webHook = "WEB_HOOK" } export declare enum SubscriptionStatusHealthIndicatorEnum { good = "GOOD", warning = "WARNING", problematic = "PROBLEMATIC", unknown = "UNKNOWN" } export declare enum IndexingPipelineLogOperations { add = "ADD", addByReference = "ADD_BY_REFERENCE", batchFile = "BATCH_FILE", delete = "DELETE", deleteAndChildren = "DELETE_AND_CHILDREN", deleteOlderThan = "DELETE_OLDER_THAN", update = "UPDATE" } export declare enum IndexingPipelineLogResults { completed = "COMPLETED", error = "ERROR", rejected = "REJECTED", skipped = "SKIPPED", warning = "WARNING" } export declare enum IndexingPipelineLogTasks { consuming = "CONSUMING", consumingBatch = "CONSUMING_BATCH", crawling = "CRAWLING", streamingExtension = "STREAMING_EXTENSION", extension = "EXTENSION", indexing = "INDEXING", mapping = "MAPPING", processing = "PROCESSING", streaming = "STREAMING", streamingBatch = "STREAMING_BATCH", preindexing = "PREINDEXING" } export declare enum ExportStatus { available = "AVAILABLE", pending = "PENDING", failed = "FAILED", expired = "EXPIRED" } export declare enum ExportTables { searches = "SEARCHES", clicks = "CLICKS", customEvents = "CUSTOM_EVENTS", keywords = "KEYWORDS", groups = "GROUPS", allEvents = "ALL_EVENTS" } export declare enum CSVFileFormat { excel = "EXCEL", noNewline = "NO_NEWLINE" } export declare enum SnowflakeReaderAccountStatus { creating = "CREATING", available = "AVAILABLE" } export declare enum DayOfWeek { monday = "MONDAY", tuesday = "TUESDAY", wednesday = "WEDNESDAY", thursday = "THURSDAY", friday = "FRIDAY", saturday = "SATURDAY", sunday = "SUNDAY" } export declare enum ExportScheduleFrequency { daily = "DAILY", monthly = "MONTHLY", weekly = "WEEKLY" } export declare enum ReportType { Dashboard = "DASHBOARD", Explorer = "EXPLORER" } export declare enum VaultFetchStrategy { allOrNothing = "ALL_OR_NOTHING", onlyMissing = "ONLY_MISSING", overwrite = "OVERWRITE" } export declare enum DataShareStatus { UNKNOWN = "UNKNOWN", PENDING = "PENDING", ACTIVE = "ACTIVE", INVALID = "INVALID" } export declare enum VaultVisibilityType { OBFUSCATED = "OBFUSCATED", PUBLIC = "PUBLIC", STRICT = "STRICT" } export declare enum VaultValueType { BOOLEAN = "BOOLEAN", FLOAT = "FLOAT", INTEGER = "INTEGER", STRING = "STRING" } export declare enum FieldOperatorType { IS_ANY_OF = "isAnyOf", IS_BETWEEN = "isBetween", IS_EXACTLY = "isExactly", IS_EXACTLY_NOT = "isExactlyNot", IS_GREATER_THAN = "isGreaterThan", IS_GREATER_THAN_OR_EQUAL_TO = "isGreaterThanOrEqualTo", IS_LESS_THAN = "isLessThan", IS_LESS_THAN_OR_EQUAL_TO = "isLessThanOrEqualTo", CONTAINS = "contains", DOES_NOT_CONTAIN = "doesNotContain", IS_DEFINED = "isDefined", IS_NOT_DEFINED = "isNotDefined" } export declare enum FieldValueType { RANGE = "range", STRING = "string", DECIMAL = "decimal", ARRAY = "array", HIERARCHIC_MULTI_VALUE = "hierarchicMultiValue" } export declare enum ProductsFacetRequestSortType { alphanumeric = "alphanumeric", score = "score" } export declare enum ProductsSortByType { fields = "fields", relevance = "relevance" } export declare enum FeedbackConsumerType { SOURCE_MANAGEMENT_IMPROVEMENTS = "SOURCE_MANAGEMENT_IMPROVEMENTS" } export declare enum ApiKeyStatus { ENABLED = "ENABLED", DISABLED = "DISABLED", DISABLED_FOR_INACTIVITY = "DISABLED_FOR_INACTIVITY", EXPIRED = "EXPIRED", SOON_TO_BE_EXPIRED = "SOON_TO_BE_EXPIRED", SOON_TO_BE_DISABLED = "SOON_TO_BE_DISABLED", DISABLED_EXPOSED = "DISABLED_EXPOSED" } /** * Represents the different statuses an API key can be filtered by. */ export declare enum ApiKeyStatusFilter { /** Keys that are currently active and usable */ ACTIVE = "ACTIVE", /** Keys that will be disabled in the near future */ SOON_TO_BE_DISABLED = "SOON_TO_BE_DISABLED", /** Keys that will expire in the near future */ SOON_TO_BE_EXPIRED = "SOON_TO_BE_EXPIRED", /** Keys that are active but have been flagged as exposed */ ACTIVE_AND_EXPOSED = "ACTIVE_AND_EXPOSED", /** Keys that have been exposed */ ALL_EXPOSED = "ALL_EXPOSED", /** Keys that have been deactivated */ DEACTIVATED = "DEACTIVATED" } export declare enum ApiKeyReportCreationType { MANUAL = "MANUAL", AUTOMATED = "AUTOMATED" } export declare enum ApiKeyExposureReportSeverity { CRITICAL = "CRITICAL", HIGH = "HIGH", MEDIUM = "MEDIUM", LOW = "LOW", WARN = "WARN" } export declare enum ApiKeyPrivacyLevel { PUBLIC = "PUBLIC", PRIVATE = "PRIVATE" } export declare enum ExpansionScore { SINGLE = "SINGLE", ALL = "ALL", INERROR = "INERROR", NOTUPDATED = "NOTUPDATED" } export declare enum ApiKeyExposureReportReasonSource { GITHUB = "GITHUB", MANUAL = "MANUAL" }