{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.58.0", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@jsx", "syntaxKind": "block" }, { "tagName": "@jsxRuntime", "syntaxKind": "block" }, { "tagName": "@jsxFrag", "syntaxKind": "block" }, { "tagName": "@jsxImportSource", "syntaxKind": "block" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "@empathyco/x-types!", "docComment": "/**\n * Search-types library with the search API models. It also includes model schemas for testing purpose.\n *\n * @remarks\n *\n * Entry point to export search-type models and testing schemas in a unified api-extractor model.\n *\n * @packageDocumentation\n */\n", "name": "@empathyco/x-types", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "@empathyco/x-types!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiQuestion:interface", "docComment": "/**\n * A question is an entity generated by the AI. It contains the question text, the response text and the search queries.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiQuestion " } ], "fileUrlPath": "temp/types/ai/question.model.d.ts", "releaseTag": "Public", "name": "AiQuestion", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#content:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Content", "text": "{\n responseText?: string;\n searchQueries: string[];\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#expanded:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "expanded?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "expanded", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#id:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#metadata:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "metadata: " }, { "kind": "Content", "text": "{\n origin: string;\n source: string;\n createdAt: string;\n generatedWithModel: string;\n generatedWithConfig: string;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "metadata", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#responseText:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "responseText?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#suggestionImageUrl:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestionImageUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "suggestionImageUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#suggestionText:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestionText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestionText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#tagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tagging?: " }, { "kind": "Content", "text": "{\n toolingDisplay: string;\n toolingDisplayClick: string;\n searchQueries: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiQuestionsRequest:interface", "docComment": "/**\n * Request for the question endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiQuestionsRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/ai/questions.model.d.ts", "releaseTag": "Public", "name": "AiQuestionsRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsRequest#lang:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "lang: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lang", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsRequest#query:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "query?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse:interface", "docComment": "/**\n * Response for the question endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiQuestionsResponse " } ], "fileUrlPath": "temp/types/response/ai/questions.model.d.ts", "releaseTag": "Public", "name": "AiQuestionsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#context:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "context: " }, { "kind": "Content", "text": "{\n query?: string;\n lang: string;\n instance: string;\n filters?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#items:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "AiQuestion", "canonicalReference": "@empathyco/x-types!AiQuestion:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#numItems:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "numItems: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#resolved:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "resolved: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resolved", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#taskId:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "taskId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "taskId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#totalItems:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "totalItems: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "totalItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionQuery:interface", "docComment": "/**\n * Data for each query suggested.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionQuery " } ], "fileUrlPath": "temp/types/ai/suggestions.model.d.ts", "releaseTag": "Public", "name": "AiSuggestionQuery", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionQuery#categories:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "categories: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "categories", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionQuery#query:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch:interface", "docComment": "/**\n * Each suggestion search is a query and the results of that query.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionSearch " } ], "fileUrlPath": "temp/types/ai/suggestion-search.model.d.ts", "releaseTag": "Public", "name": "AiSuggestionSearch", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch#numFound:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "numFound: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numFound", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch#query:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch#results:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "results: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch#tagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tagging: " }, { "kind": "Content", "text": "{\n query: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionsRequest:interface", "docComment": "/**\n * Request for the ai suggestions endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionsRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FilterableRequest", "canonicalReference": "@empathyco/x-types!FilterableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/ai/suggestions.model.d.ts", "releaseTag": "Public", "name": "AiSuggestionsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchRequest:interface", "docComment": "/**\n * Request for the suggestions-search endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionsSearchRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FilterableRequest", "canonicalReference": "@empathyco/x-types!FilterableRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/ai/suggestions-search.model.d.ts", "releaseTag": "Public", "name": "AiSuggestionsSearchRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchRequest#queries:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "queries: " }, { "kind": "Content", "text": "{\n query: string;\n categories: string[];\n }[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchResponse:interface", "docComment": "/**\n * Response for the AI suggestions search endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionsSearchResponse " } ], "fileUrlPath": "temp/types/response/ai/suggestions-search.model.d.ts", "releaseTag": "Public", "name": "AiSuggestionsSearchResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchResponse#suggestions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestions: " }, { "kind": "Reference", "text": "AiSuggestionSearch", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionTagging:interface", "docComment": "/**\n * Interface for the AI suggestion tagging.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionTagging " } ], "fileUrlPath": "temp/types/ai/suggestions.model.d.ts", "releaseTag": "Public", "name": "AiSuggestionTagging", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionTagging#searchQueries:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "searchQueries: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 9 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionTagging#toolingDisplay:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toolingDisplay: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toolingDisplay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionTagging#toolingDisplayClick:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toolingDisplayClick: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toolingDisplayClick", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiTasksRequest:interface", "docComment": "/**\n * Request for the task endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiTasksRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/ai/tasks.model.d.ts", "releaseTag": "Public", "name": "AiTasksRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiTasksRequest#taskId:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "taskId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "taskId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiTasksResponse:interface", "docComment": "/**\n * Response for the task endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiTasksResponse " } ], "fileUrlPath": "temp/types/response/ai/tasks.model.d.ts", "releaseTag": "Public", "name": "AiTasksResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiTasksResponse#result:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "result: " }, { "kind": "Reference", "text": "AiQuestionsResponse", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "result", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiTasksResponse#steps:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "steps: " }, { "kind": "Reference", "text": "StepEmpathising", "canonicalReference": "@empathyco/x-types!StepEmpathising:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "steps", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Banner:interface", "docComment": "/**\n * A banner is an image with a title, that when clicked redirect the user to an URL. Often it is represented as a 100% wide element that appears on top of the results inside the grid or between rows.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Banner extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'Banner'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Identifiable", "canonicalReference": "@empathyco/x-types!Identifiable:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Taggable", "canonicalReference": "@empathyco/x-types!Taggable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/banner.model.d.ts", "releaseTag": "Public", "name": "Banner", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Banner#image:member", "docComment": "/**\n * Banner image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "image: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "image", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Banner#position:member", "docComment": "/**\n * Banner position (= row) inside the grid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "position?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Banner#title:member", "docComment": "/**\n * Banner title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Banner#url:member", "docComment": "/**\n * URL to redirect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!BannerSchema:var", "docComment": "/**\n * Jest schema for validating Banner entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BannerSchema: " }, { "kind": "Reference", "text": "Banner", "canonicalReference": "@empathyco/x-types!Banner:interface" } ], "fileUrlPath": "temp/types/schemas/banner.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "BannerSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!BooleanFilter:interface", "docComment": "/**\n * A boolean filter used in a {@link FacetFilter}, which status can be selected or not and it may contains the total results number that the filter should return.\n *\n * @remarks\n *\n * It is like an \"abstract\" interface because it is not going to be implemented but it is extended by other interfaces. There will never be an object with this type.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BooleanFilter extends " }, { "kind": "Reference", "text": "FacetFilter", "canonicalReference": "@empathyco/x-types!FacetFilter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/boolean-filter.model.d.ts", "releaseTag": "Public", "name": "BooleanFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!BooleanFilter#label:member", "docComment": "/**\n * Text to render the filter label.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!BooleanFilter#modelName:member", "docComment": "/**\n * Type to narrow {@link ModelNameType} from the extended Filter for the known subtypes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Reference", "text": "BooleanFilterModelName", "canonicalReference": "@empathyco/x-types!BooleanFilterModelName:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!BooleanFilter#totalResults:member", "docComment": "/**\n * Amount of matching results.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "totalResults?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "totalResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "TypeAlias", "canonicalReference": "@empathyco/x-types!BooleanFilterModelName:type", "docComment": "/**\n * Type to ease the usage of a model name in a {@link BooleanFilter} with autocomplete suggestions.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type BooleanFilterModelName = " }, { "kind": "Content", "text": "(typeof " }, { "kind": "Reference", "text": "BooleanFilterModelNames", "canonicalReference": "@empathyco/x-types!BooleanFilterModelNames:var" }, { "kind": "Content", "text": ")[number]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/named-model.model.d.ts", "releaseTag": "Public", "name": "BooleanFilterModelName", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!BooleanFilterModelNames:var", "docComment": "/**\n * Const to use in the {@link BooleanFilterModelName} Type definition and also in Type Guards.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BooleanFilterModelNames: " }, { "kind": "Content", "text": "readonly [\"SimpleFilter\", \"HierarchicalFilter\", \"NumberRangeFilter\"]" } ], "fileUrlPath": "temp/types/named-model.model.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "BooleanFilterModelNames", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!BooleanFilterSchema:var", "docComment": "/**\n * Jest schema for validating BooleanFilter entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "BooleanFilterSchema: " }, { "kind": "Reference", "text": "BooleanFilter", "canonicalReference": "@empathyco/x-types!BooleanFilter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "BooleanFilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet:interface", "docComment": "/**\n * Editable Number Range Facet is a trait for filtering results using user editable {@link RangeValue}.Editable means that the value max and min can be changed by the user instead of havingseveral boolean filters with different values. It extends from {@link Facet},changes the modelName and uses {@link EditableNumberRangeFilter} as filters.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditableNumberRangeFacet extends " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/editable-number-range-facet.model.d.ts", "releaseTag": "Public", "name": "EditableNumberRangeFacet", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet#filters:member", "docComment": "/**\n * Filters available for the facet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters: " }, { "kind": "Reference", "text": "EditableNumberRangeFilter", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet#modelName:member", "docComment": "/**\n * Model name to indicate the facet type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'EditableNumberRangeFacet'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFacetSchema:var", "docComment": "/**\n * Jest schema for validating EditableNumberRangeFacet entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "EditableNumberRangeFacetSchema: " }, { "kind": "Reference", "text": "EditableNumberRangeFacet", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet:interface" } ], "fileUrlPath": "temp/types/schemas/facet.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "EditableNumberRangeFacetSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter:interface", "docComment": "/**\n * A type of filter used in {@link EditableNumberRangeFacet} and extends from {@link FacetFilter}. This filter has the particularity that its {@link RangeValue} is editable by the user. Editable means that the value max and min can be changed by the user instead of having several boolean filters with different values.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EditableNumberRangeFilter extends " }, { "kind": "Reference", "text": "FacetFilter", "canonicalReference": "@empathyco/x-types!FacetFilter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/editable-number-range-filter.model.d.ts", "releaseTag": "Public", "name": "EditableNumberRangeFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter#modelName:member", "docComment": "/**\n * Model name to indicate the filter type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'EditableNumberRangeFilter'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter#range:member", "docComment": "/**\n * Filter range to use in the frontend.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "range: " }, { "kind": "Reference", "text": "RangeValue", "canonicalReference": "@empathyco/x-types!RangeValue:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "range", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFilterSchema:var", "docComment": "/**\n * Jest schema for validating EditableNumberRangeFilterSchema entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "EditableNumberRangeFilterSchema: " }, { "kind": "Reference", "text": "EditableNumberRangeFilter", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "EditableNumberRangeFilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!ExperienceControlsRequest:interface", "docComment": "/**\n * Request for Experience Controls endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ExperienceControlsRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/experience-controls-request.model.d.ts", "releaseTag": "Public", "name": "ExperienceControlsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!ExperienceControlsResponse:interface", "docComment": "/**\n * Response for the experience controls endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ExperienceControlsResponse " } ], "fileUrlPath": "temp/types/response/experience-controls-response.model.d.ts", "releaseTag": "Public", "name": "ExperienceControlsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ExperienceControlsResponse#controls:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "controls: " }, { "kind": "Reference", "text": "Dictionary", "canonicalReference": "@empathyco/x-utils!Dictionary:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "controls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ExperienceControlsResponse#events:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "events: " }, { "kind": "Reference", "text": "Dictionary", "canonicalReference": "@empathyco/x-utils!Dictionary:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "events", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface", "docComment": "/**\n * Interface to support extra params in any request.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ExtraParamsRequest " } ], "fileUrlPath": "temp/types/request/request.model.d.ts", "releaseTag": "Public", "name": "ExtraParamsRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest#extraParams:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "extraParams?: " }, { "kind": "Content", "text": "{\n [key: string]: unknown;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "extraParams", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Facet:interface", "docComment": "/**\n * Facet is a trait for filtering results. It uses {@link Filter} as filters.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Facet extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FacetModelName", "canonicalReference": "@empathyco/x-types!FacetModelName:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Identifiable", "canonicalReference": "@empathyco/x-types!Identifiable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/facet.model.d.ts", "releaseTag": "Public", "name": "Facet", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Facet#filters:member", "docComment": "/**\n * Filters available for the facet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Facet#label:member", "docComment": "/**\n * Label that represents the facet text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "label", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!FacetFilter:interface", "docComment": "/**\n * A filter which is associated with a {@link Facet}.\n *\n * @remarks\n *\n * It is like an \"abstract\" interface because it is not going to be implemented but it is extended by other interfaces. There will never be an object with this type.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FacetFilter extends " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/facet-filter.model.d.ts", "releaseTag": "Public", "name": "FacetFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!FacetFilter#facetId:member", "docComment": "/**\n * An unique ID that identifies the facet that uses this filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "facetId: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "['id']" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "facetId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!FacetFilter#modelName:member", "docComment": "/**\n * The filter {@link ModelNameType | model name} excluding {@link RawFilter | RawFilter} model name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Reference", "text": "Exclude", "canonicalReference": "!Exclude:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FilterModelName", "canonicalReference": "@empathyco/x-types!FilterModelName:type" }, { "kind": "Content", "text": ", 'RawFilter'>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!FacetFilterSchema:var", "docComment": "/**\n * Jest schema for validating FacetFilter entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FacetFilterSchema: " }, { "kind": "Reference", "text": "FacetFilter", "canonicalReference": "@empathyco/x-types!FacetFilter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "FacetFilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@empathyco/x-types!FacetModelName:type", "docComment": "/**\n * Facets model names type. It can be: SimpleFacet, HierarchicalFacet, NumberRangeFacet or EditableNumberRangeFacet.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type FacetModelName = " }, { "kind": "Content", "text": "'SimpleFacet' | 'HierarchicalFacet' | 'NumberRangeFacet' | 'EditableNumberRangeFacet'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/named-model.model.d.ts", "releaseTag": "Public", "name": "FacetModelName", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!FacetSchema:var", "docComment": "/**\n * Jest schema for validating Facet entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FacetSchema: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" } ], "fileUrlPath": "temp/types/schemas/facet.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "FacetSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!FacetsRequest:interface", "docComment": "/**\n * The Request for the Facets endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FacetsRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FilterableRequest", "canonicalReference": "@empathyco/x-types!FilterableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/facets-request.model.d.ts", "releaseTag": "Public", "name": "FacetsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!FacetsResponse:interface", "docComment": "/**\n * Response for the facet endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FacetsResponse " } ], "fileUrlPath": "temp/types/response/facets-response.model.d.ts", "releaseTag": "Public", "name": "FacetsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!FacetsResponse#facets:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "facets?: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "facets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Filter:interface", "docComment": "/**\n * A basic filter.\n *\n * @remarks\n *\n * It is like an \"abstract\" interface because it is not going to be implemented but it is extended by other interfaces. There will never be an object with this type.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Filter extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FilterModelName", "canonicalReference": "@empathyco/x-types!FilterModelName:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Identifiable", "canonicalReference": "@empathyco/x-types!Identifiable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/filter.model.d.ts", "releaseTag": "Public", "name": "Filter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Filter#selected:member", "docComment": "/**\n * Flag if the filter is selected or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selected: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selected", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!FilterableRequest:interface", "docComment": "/**\n * Interface for any Request with a `filters` parameter.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FilterableRequest " } ], "fileUrlPath": "temp/types/request/request.model.d.ts", "releaseTag": "Public", "name": "FilterableRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!FilterableRequest#filters:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "filters?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@empathyco/x-types!FilterModelName:type", "docComment": "/**\n * Filters model names type. It can be: {@link BooleanFilterModelName}, RawFilter or EditableNumberRangeFilter.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type FilterModelName = " }, { "kind": "Reference", "text": "BooleanFilterModelName", "canonicalReference": "@empathyco/x-types!BooleanFilterModelName:type" }, { "kind": "Content", "text": " | 'EditableNumberRangeFilter' | 'RawFilter'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/named-model.model.d.ts", "releaseTag": "Public", "name": "FilterModelName", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!FilterSchema:var", "docComment": "/**\n * Jest schema for validating Filter entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FilterSchema: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "FilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!HierarchicalFacet:interface", "docComment": "/**\n * Hierarchical facet is a trait for filtering results. It extends from {@link Facet} changes the modelName and uses {@link HierarchicalFilter} as filters.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HierarchicalFacet extends " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/hierarchical-facet.model.d.ts", "releaseTag": "Public", "name": "HierarchicalFacet", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!HierarchicalFacet#filters:member", "docComment": "/**\n * Filters available for the facet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters: " }, { "kind": "Reference", "text": "HierarchicalFilter", "canonicalReference": "@empathyco/x-types!HierarchicalFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!HierarchicalFacet#modelName:member", "docComment": "/**\n * Model name to indicate the facet type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'HierarchicalFacet'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!HierarchicalFacetSchema:var", "docComment": "/**\n * Jest schema for validating HierarchicalFacet entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "HierarchicalFacetSchema: " }, { "kind": "Reference", "text": "HierarchicalFacet", "canonicalReference": "@empathyco/x-types!HierarchicalFacet:interface" } ], "fileUrlPath": "temp/types/schemas/facet.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "HierarchicalFacetSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!HierarchicalFilter:interface", "docComment": "/**\n * A type of filter used in {@link HierarchicalFacet} and extends from {@link BooleanFilter}. This filter has the particularity that it has recursive children.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HierarchicalFilter extends " }, { "kind": "Reference", "text": "BooleanFilter", "canonicalReference": "@empathyco/x-types!BooleanFilter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/hierarchical-filter.model.d.ts", "releaseTag": "Public", "name": "HierarchicalFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!HierarchicalFilter#children:member", "docComment": "/**\n * Descendants filters.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "children?: " }, { "kind": "Reference", "text": "HierarchicalFilter", "canonicalReference": "@empathyco/x-types!HierarchicalFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!HierarchicalFilter#modelName:member", "docComment": "/**\n * Model name to indicate the filter type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'HierarchicalFilter'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!HierarchicalFilter#parentId:member", "docComment": "/**\n * A unique id used to reference the parent filter or null if it hasn't.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "parentId: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "['id'] | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "parentId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!HierarchicalFilterSchema:var", "docComment": "/**\n * Jest schema for validating HierarchicalFilter entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "HierarchicalFilterSchema: " }, { "kind": "Reference", "text": "HierarchicalFilter", "canonicalReference": "@empathyco/x-types!HierarchicalFilter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "HierarchicalFilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!HistoryQuery:interface", "docComment": "/**\n * Represents a query that has been made by the user.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface HistoryQuery extends " }, { "kind": "Reference", "text": "Previewable", "canonicalReference": "@empathyco/x-types!Previewable:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'HistoryQuery'>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/history-query.model.d.ts", "releaseTag": "Public", "name": "HistoryQuery", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!HistoryQuery#selectedFilters:member", "docComment": "/**\n * Filters selected for the query to search for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selectedFilters?: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "selectedFilters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!HistoryQuery#timestamp:member", "docComment": "/**\n * Timestamp when the history query was created.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "timestamp: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "timestamp", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!HistoryQuerySchema:var", "docComment": "/**\n * Jest schema for validating Next query entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "HistoryQuerySchema: " }, { "kind": "Reference", "text": "HistoryQuery", "canonicalReference": "@empathyco/x-types!HistoryQuery:interface" } ], "fileUrlPath": "temp/types/schemas/history-query.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "HistoryQuerySchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Identifiable:interface", "docComment": "/**\n * Represents an Object with id property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Identifiable " } ], "fileUrlPath": "temp/types/identifiable.model.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "Identifiable", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Identifiable#id:member", "docComment": "/**\n * A unique ID that identifies the Object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "ID" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!IdentifierResultsRequest:interface", "docComment": "/**\n * Request for Identifier Results endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IdentifierResultsRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PageableRequest", "canonicalReference": "@empathyco/x-types!PageableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/identifier-results-request.model.d.ts", "releaseTag": "Public", "name": "IdentifierResultsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!IdentifierResultsResponse:interface", "docComment": "/**\n * Response for the identifier results endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IdentifierResultsResponse " } ], "fileUrlPath": "temp/types/response/identifier-results-response.model.d.ts", "releaseTag": "Public", "name": "IdentifierResultsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!IdentifierResultsResponse#results:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "results: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isBooleanFilter:function(1)", "docComment": "/**\n * Type guard to check if a filter is a {@link BooleanFilter}.\n *\n * @param filter - The filter to check.\n *\n * @returns True if the filter is a {@link BooleanFilter}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isBooleanFilter(filter: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "filter", "canonicalReference": "@empathyco/x-types!~filter" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "BooleanFilter", "canonicalReference": "@empathyco/x-types!BooleanFilter:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/filter/boolean-filter.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isBooleanFilter" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isEditableNumberRangeFacet:function(1)", "docComment": "/**\n * Type guard to check if a facet is an {@link EditableNumberRangeFacet}.\n *\n * @param facet - The facet to check.\n *\n * @returns A boolean that represents if a facet is an {@link EditableNumberRangeFacet}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isEditableNumberRangeFacet(facet: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "facet", "canonicalReference": "@empathyco/x-types!~facet" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "EditableNumberRangeFacet", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/editable-number-range-facet.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "facet", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isEditableNumberRangeFacet" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isEditableNumberRangeFilter:function(1)", "docComment": "/**\n * Type guard to check if a filter is an {@link EditableNumberRangeFilter}.\n *\n * @param filter - The filter to check.\n *\n * @returns True if the filter is an {@link EditableNumberRangeFilter}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isEditableNumberRangeFilter(filter: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "filter", "canonicalReference": "@empathyco/x-types!~filter" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "EditableNumberRangeFilter", "canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/filter/editable-number-range-filter.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isEditableNumberRangeFilter" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isFacetFilter:function(1)", "docComment": "/**\n * Type guard to check if a filter is a {@link FacetFilter}.\n *\n * @param filter - The filter to check.\n *\n * @returns True if the filter is a {@link FacetFilter}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isFacetFilter(filter: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "filter", "canonicalReference": "@empathyco/x-types!~filter" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "FacetFilter", "canonicalReference": "@empathyco/x-types!FacetFilter:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/filter/facet-filter.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isFacetFilter" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isHierarchicalFacet:function(1)", "docComment": "/**\n * Type guard to check if a facet is an {@link HierarchicalFacet}.\n *\n * @param facet - The facet to check.\n *\n * @returns True if the facet is a {@link HierarchicalFacet}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isHierarchicalFacet(facet: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "facet", "canonicalReference": "@empathyco/x-types!~facet" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "HierarchicalFacet", "canonicalReference": "@empathyco/x-types!HierarchicalFacet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/hierarchical-facet.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "facet", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isHierarchicalFacet" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isHierarchicalFilter:function(1)", "docComment": "/**\n * Type guard to check if a filter is a {@link HierarchicalFilter}.\n *\n * @param filter - The filter to check.\n *\n * @returns True if the filter is a {@link HierarchicalFilter}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isHierarchicalFilter(filter: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "filter", "canonicalReference": "@empathyco/x-types!~filter" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "HierarchicalFilter", "canonicalReference": "@empathyco/x-types!HierarchicalFilter:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/filter/hierarchical-filter.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isHierarchicalFilter" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isNumberRangeFacet:function(1)", "docComment": "/**\n * Type guard to check if a facet is an {@link NumberRangeFacet}.\n *\n * @param facet - The facet to check.\n *\n * @returns True if the facet is a {@link NumberRangeFacet}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isNumberRangeFacet(facet: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "facet", "canonicalReference": "@empathyco/x-types!~facet" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "NumberRangeFacet", "canonicalReference": "@empathyco/x-types!NumberRangeFacet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/number-range-facet.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "facet", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isNumberRangeFacet" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isNumberRangeFilter:function(1)", "docComment": "/**\n * Type guard to check if a filter is a {@link NumberRangeFilter}.\n *\n * @param filter - The filter to check.\n *\n * @returns True if the filter is a {@link NumberRangeFilter}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isNumberRangeFilter(filter: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "filter", "canonicalReference": "@empathyco/x-types!~filter" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "NumberRangeFilter", "canonicalReference": "@empathyco/x-types!NumberRangeFilter:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/filter/number-range-filter.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isNumberRangeFilter" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isRawFilter:function(1)", "docComment": "/**\n * Type guard to check if a filter is a {@link RawFilter}.\n *\n * @param filter - The filter to check.\n *\n * @returns True if the filter is a {@link RawFilter}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isRawFilter(filter: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "filter", "canonicalReference": "@empathyco/x-types!~filter" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "RawFilter", "canonicalReference": "@empathyco/x-types!RawFilter:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/filter/raw-filter.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isRawFilter" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isSimpleFacet:function(1)", "docComment": "/**\n * Type guard to check if a facet is an {@link SimpleFacet}.\n *\n * @param facet - The facet to check.\n *\n * @returns True if the facet is a {@link SimpleFacet}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isSimpleFacet(facet: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "facet", "canonicalReference": "@empathyco/x-types!~facet" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "SimpleFacet", "canonicalReference": "@empathyco/x-types!SimpleFacet:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/simple-facet.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "facet", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isSimpleFacet" }, { "kind": "Function", "canonicalReference": "@empathyco/x-types!isSimpleFilter:function(1)", "docComment": "/**\n * Type guard to check if a filter is a {@link SimpleFilter}.\n *\n * @param filter - The filter to check.\n *\n * @returns True if the filter is a {@link SimpleFilter}, false otherwise.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isSimpleFilter(filter: " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "filter", "canonicalReference": "@empathyco/x-types!~filter" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "SimpleFilter", "canonicalReference": "@empathyco/x-types!SimpleFilter:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/facet/filter/simple-filter.model.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isSimpleFilter" }, { "kind": "TypeAlias", "canonicalReference": "@empathyco/x-types!ModelNameType:type", "docComment": "/**\n * Type to ease the usage of the ModelNames interface with autocomplete suggestions.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type ModelNameType = " }, { "kind": "Content", "text": "'Result' | 'NextQueries' | 'NextQuery' | 'RelatedTag' | 'PopularSearch' | 'QuerySuggestion' | 'HistoryQuery' | 'Banner' | 'Promoted' | 'Redirection' | " }, { "kind": "Reference", "text": "FilterModelName", "canonicalReference": "@empathyco/x-types!FilterModelName:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FacetModelName", "canonicalReference": "@empathyco/x-types!FacetModelName:type" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/named-model.model.d.ts", "releaseTag": "Public", "name": "ModelNameType", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!NamedModel:interface", "docComment": "/**\n * Common interface to ease the differentiate between different model types.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NamedModel " } ], "fileUrlPath": "temp/types/named-model.model.d.ts", "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "NamedModel", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NamedModel#modelName:member", "docComment": "/**\n * The {@link ModelNameType | model name} value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly modelName: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!NextQueries:interface", "docComment": "/**\n * A group of next queries.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NextQueries extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'NextQueries'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Identifiable", "canonicalReference": "@empathyco/x-types!Identifiable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/query-signals/next-queries.model.d.ts", "releaseTag": "Public", "name": "NextQueries", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NextQueries#nextQueries:member", "docComment": "/**\n * Array of next queries available inside the group.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nextQueries: " }, { "kind": "Reference", "text": "NextQuery", "canonicalReference": "@empathyco/x-types!NextQuery:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nextQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!NextQueriesRequest:interface", "docComment": "/**\n * Request for Next Queries endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NextQueriesRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PageableRequest", "canonicalReference": "@empathyco/x-types!PageableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/next-queries-request.model.d.ts", "releaseTag": "Public", "name": "NextQueriesRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!NextQueriesResponse:interface", "docComment": "/**\n * Response for the next queries endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NextQueriesResponse " } ], "fileUrlPath": "temp/types/response/next-queries-response.model.d.ts", "releaseTag": "Public", "name": "NextQueriesResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NextQueriesResponse#nextQueries:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "nextQueries: " }, { "kind": "Reference", "text": "NextQuery", "canonicalReference": "@empathyco/x-types!NextQuery:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nextQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!NextQuery:interface", "docComment": "/**\n * A next query is a suggestion of a new query that the user may be interested after searching for an specific term.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NextQuery extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'NextQuery'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Required", "canonicalReference": "!Required:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Previewable", "canonicalReference": "@empathyco/x-types!Previewable:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/query-signals/next-query.model.d.ts", "releaseTag": "Public", "name": "NextQuery", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NextQuery#isCurated:member", "docComment": "/**\n * If it's a curated next query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCurated?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isCurated", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 8 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!NextQuerySchema:var", "docComment": "/**\n * Jest schema for validating Next query entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "NextQuerySchema: " }, { "kind": "Reference", "text": "NextQuery", "canonicalReference": "@empathyco/x-types!NextQuery:interface" } ], "fileUrlPath": "temp/types/schemas/next-query.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "NextQuerySchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!NumberRangeFacet:interface", "docComment": "/**\n * Number Range Facet is a trait for filtering results. It extends from {@link Facet}, changes the modelName and uses {@link NumberRangeFilter} as filters.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NumberRangeFacet extends " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/number-range-facet.model.d.ts", "releaseTag": "Public", "name": "NumberRangeFacet", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NumberRangeFacet#filters:member", "docComment": "/**\n * Filters available for the facet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters: " }, { "kind": "Reference", "text": "NumberRangeFilter", "canonicalReference": "@empathyco/x-types!NumberRangeFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NumberRangeFacet#modelName:member", "docComment": "/**\n * Model name to indicate the facet type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'NumberRangeFacet'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!NumberRangeFacetSchema:var", "docComment": "/**\n * Jest schema for validating NumberRangeFacet entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "NumberRangeFacetSchema: " }, { "kind": "Reference", "text": "NumberRangeFacet", "canonicalReference": "@empathyco/x-types!NumberRangeFacet:interface" } ], "fileUrlPath": "temp/types/schemas/facet.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "NumberRangeFacetSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!NumberRangeFilter:interface", "docComment": "/**\n * A type of filter used in {@link NumberRangeFacet} and extends from {@link BooleanFilter}. This filter has the particularity that its range property is an object with a range of numbers. The difference with {@link EditableNumberRangeFilter} is that range's values are not editable. There are different NumberRangeFilters within the facet to cover different predefined range options.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NumberRangeFilter extends " }, { "kind": "Reference", "text": "BooleanFilter", "canonicalReference": "@empathyco/x-types!BooleanFilter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/number-range-filter.model.d.ts", "releaseTag": "Public", "name": "NumberRangeFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NumberRangeFilter#modelName:member", "docComment": "/**\n * Model name to indicate the filter type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'NumberRangeFilter'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!NumberRangeFilter#range:member", "docComment": "/**\n * Filter range to use in the frontend.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "range: " }, { "kind": "Reference", "text": "RangeValue", "canonicalReference": "@empathyco/x-types!RangeValue:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "range", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!NumberRangeFilterSchema:var", "docComment": "/**\n * Jest schema for validating NumberRangeFilter entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "NumberRangeFilterSchema: " }, { "kind": "Reference", "text": "NumberRangeFilter", "canonicalReference": "@empathyco/x-types!NumberRangeFilter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "NumberRangeFilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!PageableRequest:interface", "docComment": "/**\n * Interface for any Request which supports pagination.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PageableRequest " } ], "fileUrlPath": "temp/types/request/request.model.d.ts", "releaseTag": "Public", "name": "PageableRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PageableRequest#rows:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "rows?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rows", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PageableRequest#start:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "start?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "start", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!PartialResult:interface", "docComment": "/**\n * A partial result represents a sub-query of a user search term which normally has not enough results (or not results at all). It includes a preview of these results and the number of total results that match against the sub-query.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PartialResult extends " }, { "kind": "Reference", "text": "Previewable", "canonicalReference": "@empathyco/x-types!Previewable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/partial-result.model.d.ts", "releaseTag": "Public", "name": "PartialResult", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PartialResult#results:member", "docComment": "/**\n * The results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "results: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PartialResult#totalResults:member", "docComment": "/**\n * The number of results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "totalResults: " }, { "kind": "Content", "text": "number | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "totalResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!PopularSearchesRequest:interface", "docComment": "/**\n * Request for Popular Searches endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PopularSearchesRequest extends " }, { "kind": "Reference", "text": "PageableRequest", "canonicalReference": "@empathyco/x-types!PageableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/popular-searches-request.model.d.ts", "releaseTag": "Public", "name": "PopularSearchesRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!PopularSearchesResponse:interface", "docComment": "/**\n * Response for the popular searches endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PopularSearchesResponse " } ], "fileUrlPath": "temp/types/response/popular-searches-response.model.d.ts", "releaseTag": "Public", "name": "PopularSearchesResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PopularSearchesResponse#suggestions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestions: " }, { "kind": "Reference", "text": "Suggestion", "canonicalReference": "@empathyco/x-types!Suggestion:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Previewable:interface", "docComment": "/**\n * Represents an item that is searchable, and the results associated to it.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Previewable " } ], "fileUrlPath": "temp/types/previewable.model.d.ts", "releaseTag": "Public", "name": "Previewable", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Previewable#facets:member", "docComment": "/**\n * Facets to apply to the `query` property when searching.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "facets?: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "facets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Previewable#query:member", "docComment": "/**\n * The query to search for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Previewable#results:member", "docComment": "/**\n * The results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "results?: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Previewable#totalResults:member", "docComment": "/**\n * The number of results that the combination of `query` and `facets` properties return, or `null` if they have not been loaded yet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "totalResults?: " }, { "kind": "Content", "text": "number | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "totalResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!PreviewResults:interface", "docComment": "/**\n * Interface to type the query preview objects.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PreviewResults " } ], "fileUrlPath": "temp/types/preview-results.model.d.ts", "releaseTag": "Public", "name": "PreviewResults", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PreviewResults#items:member", "docComment": "/**\n * The results to preview the search request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PreviewResults#query:member", "docComment": "/**\n * The searched query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!PreviewResults#totalResults:member", "docComment": "/**\n * The number of results of the query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "totalResults: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "totalResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Promoted:interface", "docComment": "/**\n * A promoted is an image with a title, that when clicked redirect the user to an URL. Often it is represented taking up the same space than a normal result.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Promoted extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'Promoted'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Identifiable", "canonicalReference": "@empathyco/x-types!Identifiable:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Taggable", "canonicalReference": "@empathyco/x-types!Taggable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/promoted.model.d.ts", "releaseTag": "Public", "name": "Promoted", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Promoted#image:member", "docComment": "/**\n * Promoted image.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "image: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "image", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Promoted#position:member", "docComment": "/**\n * Promoted position inside the grid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "position?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Promoted#title:member", "docComment": "/**\n * Promoted title.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Promoted#url:member", "docComment": "/**\n * URL to redirect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!PromotedSchema:var", "docComment": "/**\n * Jest schema for validating Promoted entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "PromotedSchema: " }, { "kind": "Reference", "text": "Promoted", "canonicalReference": "@empathyco/x-types!Promoted:interface" } ], "fileUrlPath": "temp/types/schemas/promoted.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "PromotedSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface", "docComment": "/**\n * Interface for any Request with a `query` parameter.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface QueryableRequest " } ], "fileUrlPath": "temp/types/request/request.model.d.ts", "releaseTag": "Public", "name": "QueryableRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!QueryableRequest#query:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!QuerySuggestionsRequest:interface", "docComment": "/**\n * Request for Query Suggestions endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface QuerySuggestionsRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PageableRequest", "canonicalReference": "@empathyco/x-types!PageableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/query-suggestions-request.model.d.ts", "releaseTag": "Public", "name": "QuerySuggestionsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!QuerySuggestionsResponse:interface", "docComment": "/**\n * Response for the query suggestions endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface QuerySuggestionsResponse " } ], "fileUrlPath": "temp/types/response/query-suggestions-response.model.d.ts", "releaseTag": "Public", "name": "QuerySuggestionsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!QuerySuggestionsResponse#suggestions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestions: " }, { "kind": "Reference", "text": "Suggestion", "canonicalReference": "@empathyco/x-types!Suggestion:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RangeValue:interface", "docComment": "/**\n * A numeric range filter value.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RangeValue " } ], "fileUrlPath": "temp/types/facet/filter/range-value.model.d.ts", "releaseTag": "Public", "name": "RangeValue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RangeValue#max:member", "docComment": "/**\n * The maximum value allowed. `null` means unset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "max: " }, { "kind": "Content", "text": "number | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "max", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RangeValue#min:member", "docComment": "/**\n * The minimum value allowed. `null` means unset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "min: " }, { "kind": "Content", "text": "number | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "min", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RawFilter:interface", "docComment": "/**\n * A filter which id is the value of the filter. It can be selected or not.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RawFilter extends " }, { "kind": "Reference", "text": "Filter", "canonicalReference": "@empathyco/x-types!Filter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/raw-filter.model.d.ts", "releaseTag": "Public", "name": "RawFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RawFilter#id:member", "docComment": "/**\n * The value of the filter.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RawFilter#modelName:member", "docComment": "/**\n * Model name to indicate the filter type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'RawFilter'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RawFilter#selected:member", "docComment": "/**\n * Force {@link Filter | Filter} `selected` property to true.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "selected: " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "selected", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!RawFilterSchema:var", "docComment": "/**\n * Jest schema for validating RawFilter entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RawFilterSchema: " }, { "kind": "Reference", "text": "RawFilter", "canonicalReference": "@empathyco/x-types!RawFilter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "RawFilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!RecommendationSchema:var", "docComment": "/**\n * Jest schema for validating Recommendation (AKA Result) entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RecommendationSchema: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" } ], "fileUrlPath": "temp/types/schemas/result.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "RecommendationSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RecommendationsRequest:interface", "docComment": "/**\n * Request for Recommendations endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RecommendationsRequest extends " }, { "kind": "Reference", "text": "PageableRequest", "canonicalReference": "@empathyco/x-types!PageableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/recommendations-request.model.d.ts", "releaseTag": "Public", "name": "RecommendationsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RecommendationsResponse:interface", "docComment": "/**\n * Response for the recommendations endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RecommendationsResponse " } ], "fileUrlPath": "temp/types/response/recommendations-response.model.d.ts", "releaseTag": "Public", "name": "RecommendationsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RecommendationsResponse#results:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "results: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Redirection:interface", "docComment": "/**\n * A redirection (AKA Direct Link) is simply a URL. Normally, the user is just redirected to it after making a query that matches the configuration of this URL. In other cases it is shown as a button that the user can click, and which will trigger the redirect action.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Redirection extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'Redirection'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Identifiable", "canonicalReference": "@empathyco/x-types!Identifiable:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Taggable", "canonicalReference": "@empathyco/x-types!Taggable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/redirection.model.d.ts", "releaseTag": "Public", "name": "Redirection", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Redirection#url:member", "docComment": "/**\n * URL to redirect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!RedirectionSchema:var", "docComment": "/**\n * Jest schema for validating Redirection entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RedirectionSchema: " }, { "kind": "Reference", "text": "Redirection", "canonicalReference": "@empathyco/x-types!Redirection:interface" } ], "fileUrlPath": "temp/types/schemas/redirection.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "RedirectionSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RelatedPrompt:interface", "docComment": "/**\n * Represents a related prompt.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelatedPrompt extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'RelatedPrompt'>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/query-signals/related-prompt.model.d.ts", "releaseTag": "Public", "name": "RelatedPrompt", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPrompt#nextQueries:member", "docComment": "/**\n * The queries of the next queries related to the prompt.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "nextQueries: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nextQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPrompt#relatedPromptNextQueries:member", "docComment": "/**\n * The next queries related to the prompt.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "relatedPromptNextQueries?: " }, { "kind": "Reference", "text": "RelatedPromptNextQuery", "canonicalReference": "@empathyco/x-types!RelatedPromptNextQuery:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "relatedPromptNextQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPrompt#suggestionImageUrl:member", "docComment": "/**\n * The prompt image\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggestionImageUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "suggestionImageUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPrompt#suggestionText:member", "docComment": "/**\n * The prompt.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "suggestionText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestionText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPrompt#tagging:member", "docComment": "/**\n * Related prompt tagging.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tagging?: " }, { "kind": "Content", "text": "{\n toolingDisplayTagging?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";\n toolingDisplayClickTagging?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";\n nextQueriesTagging?: " }, { "kind": "Reference", "text": "RelatedPromptNextQuery", "canonicalReference": "@empathyco/x-types!RelatedPromptNextQuery:interface" }, { "kind": "Content", "text": "[];\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 8 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPrompt#toolingDisplayTagging:member", "docComment": "/**\n * The tooling display tagging of the prompt.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toolingDisplayTagging?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "toolingDisplayTagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPrompt#type:member", "docComment": "/**\n * The type of the prompt.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RelatedPromptNextQuery:interface", "docComment": "/**\n * Represents a related prompt nextQuery.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelatedPromptNextQuery " } ], "fileUrlPath": "temp/types/query-signals/related-prompt.model.d.ts", "releaseTag": "Public", "name": "RelatedPromptNextQuery", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPromptNextQuery#query:member", "docComment": "/**\n * The query of the next query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPromptNextQuery#toolingDisplayAdd2CartTagging:member", "docComment": "/**\n * The tooling display add2cart tagging of the next query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toolingDisplayAdd2CartTagging: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toolingDisplayAdd2CartTagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPromptNextQuery#toolingDisplayClickTagging:member", "docComment": "/**\n * The tooling display click tagging of the next query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toolingDisplayClickTagging: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toolingDisplayClickTagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPromptNextQuery#toolingDisplayTagging:member", "docComment": "/**\n * The tooling display tagging of the next query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "toolingDisplayTagging: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "toolingDisplayTagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RelatedPromptsRequest:interface", "docComment": "/**\n * Request for Related Prompts endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelatedPromptsRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/related-prompts-request.model.d.ts", "releaseTag": "Public", "name": "RelatedPromptsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RelatedPromptsResponse:interface", "docComment": "/**\n * Response for the related prompts endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelatedPromptsResponse " } ], "fileUrlPath": "temp/types/response/related-prompts-response.model.d.ts", "releaseTag": "Public", "name": "RelatedPromptsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedPromptsResponse#relatedPrompts:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "relatedPrompts: " }, { "kind": "Reference", "text": "RelatedPrompt", "canonicalReference": "@empathyco/x-types!RelatedPrompt:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "relatedPrompts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RelatedTag:interface", "docComment": "/**\n * A related tag is just a term that refines the current query.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelatedTag extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'RelatedTag'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Previewable", "canonicalReference": "@empathyco/x-types!Previewable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/query-signals/related-tag.model.d.ts", "releaseTag": "Public", "name": "RelatedTag", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedTag#isCurated:member", "docComment": "/**\n * If it's a curated related tag.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCurated?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isCurated", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedTag#tag:member", "docComment": "/**\n * The term to add to the current query.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tag: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tag", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 5 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!RelatedTagSchema:var", "docComment": "/**\n * Jest schema for validating Related Tag entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RelatedTagSchema: " }, { "kind": "Reference", "text": "RelatedTag", "canonicalReference": "@empathyco/x-types!RelatedTag:interface" } ], "fileUrlPath": "temp/types/schemas/related-tag.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "RelatedTagSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RelatedTagsRequest:interface", "docComment": "/**\n * Request for Related Tags endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelatedTagsRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PageableRequest", "canonicalReference": "@empathyco/x-types!PageableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/related-tags-request.model.d.ts", "releaseTag": "Public", "name": "RelatedTagsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!RelatedTagsResponse:interface", "docComment": "/**\n * Response for the related tags endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RelatedTagsResponse " } ], "fileUrlPath": "temp/types/response/related-tags-response.model.d.ts", "releaseTag": "Public", "name": "RelatedTagsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!RelatedTagsResponse#relatedTags:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "relatedTags: " }, { "kind": "Reference", "text": "RelatedTag", "canonicalReference": "@empathyco/x-types!RelatedTag:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "relatedTags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Result:interface", "docComment": "/**\n * A search result.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Result extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'Result'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Identifiable", "canonicalReference": "@empathyco/x-types!Identifiable:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Taggable", "canonicalReference": "@empathyco/x-types!Taggable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/result/result.model.d.ts", "releaseTag": "Public", "name": "Result", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#identifier:member", "docComment": "/**\n * {@link ResultIdentifier | Result identifier}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "identifier?: " }, { "kind": "Reference", "text": "ResultIdentifier", "canonicalReference": "@empathyco/x-types!ResultIdentifier:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "identifier", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#images:member", "docComment": "/**\n * Images of the result. It should be the URLs.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "images?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "images", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#isWishlisted:member", "docComment": "/**\n * Flag if the results has been added to the wishlist or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isWishlisted?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isWishlisted", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#name:member", "docComment": "/**\n * Result name.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#price:member", "docComment": "/**\n * {@link ResultPrice | Result price}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "price?: " }, { "kind": "Reference", "text": "ResultPrice", "canonicalReference": "@empathyco/x-types!ResultPrice:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "price", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#rating:member", "docComment": "/**\n * {@link ResultRating | Result rating}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rating?: " }, { "kind": "Reference", "text": "ResultRating", "canonicalReference": "@empathyco/x-types!ResultRating:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "rating", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#type:member", "docComment": "/**\n * The type of the result: product, article, pack, etc...\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#url:member", "docComment": "/**\n * Result URL to redirect to PDP.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Result#variants:member", "docComment": "/**\n * {@link ResultVariant | Variants of the result}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "variants?: " }, { "kind": "Reference", "text": "ResultVariant", "canonicalReference": "@empathyco/x-types!ResultVariant:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "variants", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!ResultIdentifier:interface", "docComment": "/**\n * The client result identifier (SKU, MOCACO, a simple ID...).\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultIdentifier " } ], "fileUrlPath": "temp/types/result/result-identifier.model.d.ts", "releaseTag": "Public", "name": "ResultIdentifier", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ResultIdentifier#value:member", "docComment": "/**\n * Result identifier value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!ResultPrice:interface", "docComment": "/**\n * The result price.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultPrice " } ], "fileUrlPath": "temp/types/result/result-price.model.d.ts", "releaseTag": "Public", "name": "ResultPrice", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ResultPrice#hasDiscount:member", "docComment": "/**\n * Whether this result has a discount.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hasDiscount: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hasDiscount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ResultPrice#originalValue:member", "docComment": "/**\n * The old value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "originalValue: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "originalValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ResultPrice#value:member", "docComment": "/**\n * The current value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!ResultRating:interface", "docComment": "/**\n * The result rating.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultRating " } ], "fileUrlPath": "temp/types/result/result-rating.model.d.ts", "releaseTag": "Public", "name": "ResultRating", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!ResultRating#value:member", "docComment": "/**\n * The value of the rating. `null` means unset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Content", "text": "number | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!ResultSchema:var", "docComment": "/**\n * Jest schema for validating Result entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ResultSchema: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" } ], "fileUrlPath": "temp/types/schemas/result.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "ResultSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!ResultVariant:interface", "docComment": "/**\n * A result variant.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ResultVariant extends " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": ", 'id' | 'modelName' | 'tagging'>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/result/result.model.d.ts", "releaseTag": "Public", "name": "ResultVariant", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SearchRequest:interface", "docComment": "/**\n * The Request for the Search endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SearchRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FilterableRequest", "canonicalReference": "@empathyco/x-types!FilterableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PageableRequest", "canonicalReference": "@empathyco/x-types!PageableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "SortableRequest", "canonicalReference": "@empathyco/x-types!SortableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/search-request.model.d.ts", "releaseTag": "Public", "name": "SearchRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 }, { "startIndex": 9, "endIndex": 10 }, { "startIndex": 11, "endIndex": 12 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SearchResponse:interface", "docComment": "/**\n * Response for the search endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SearchResponse " } ], "fileUrlPath": "temp/types/response/search-response.model.d.ts", "releaseTag": "Public", "name": "SearchResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#banners:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "banners?: " }, { "kind": "Reference", "text": "Banner", "canonicalReference": "@empathyco/x-types!Banner:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "banners", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#displayTagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "displayTagging?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "displayTagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#facets:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "facets?: " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "facets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#partialResults:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "partialResults?: " }, { "kind": "Reference", "text": "PartialResult", "canonicalReference": "@empathyco/x-types!PartialResult:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "partialResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#promoteds:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "promoteds?: " }, { "kind": "Reference", "text": "Promoted", "canonicalReference": "@empathyco/x-types!Promoted:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "promoteds", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#queryTagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "queryTagging?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "queryTagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#redirections:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "redirections?: " }, { "kind": "Reference", "text": "Redirection", "canonicalReference": "@empathyco/x-types!Redirection:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "redirections", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#results:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "results: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#spellcheck:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "spellcheck?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "spellcheck", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#stats:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "stats?: " }, { "kind": "Reference", "text": "Stats", "canonicalReference": "@empathyco/x-types!Stats:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "stats", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SearchResponse#totalResults:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "totalResults: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "totalResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SemanticQueriesRequest:interface", "docComment": "/**\n * Request for the SemanticQueriesEndpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SemanticQueriesRequest extends " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/request/semantic-queries-request.model.d.ts", "releaseTag": "Public", "name": "SemanticQueriesRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SemanticQueriesResponse:interface", "docComment": "/**\n * Response for the semantic queries endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SemanticQueriesResponse " } ], "fileUrlPath": "temp/types/response/semantic-queries-response.model.d.ts", "releaseTag": "Public", "name": "SemanticQueriesResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SemanticQueriesResponse#semanticQueries:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "semanticQueries: " }, { "kind": "Reference", "text": "SemanticQuery", "canonicalReference": "@empathyco/x-types!SemanticQuery:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "semanticQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SemanticQuery:interface", "docComment": "/**\n * A semantic query is a term related to another in a semantic way.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SemanticQuery extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'SemanticQuery'>" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/query-signals/semantic-query.model.d.ts", "releaseTag": "Public", "name": "SemanticQuery", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SemanticQuery#distance:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "distance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "distance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SemanticQuery#query:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "query: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!SemanticQuerySchema:var", "docComment": "/**\n * Jest schema for validating SemanticQuery entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SemanticQuerySchema: " }, { "kind": "Reference", "text": "SemanticQuery", "canonicalReference": "@empathyco/x-types!SemanticQuery:interface" } ], "fileUrlPath": "temp/types/schemas/semantic-query.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "SemanticQuerySchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SimpleFacet:interface", "docComment": "/**\n * Simple facet is a trait for filtering results. It extends from {@link Facet}, changes the modelName and uses {@link SimpleFilter} as filters.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SimpleFacet extends " }, { "kind": "Reference", "text": "Facet", "canonicalReference": "@empathyco/x-types!Facet:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/simple-facet.model.d.ts", "releaseTag": "Public", "name": "SimpleFacet", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SimpleFacet#filters:member", "docComment": "/**\n * Filters available for the facet.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filters: " }, { "kind": "Reference", "text": "SimpleFilter", "canonicalReference": "@empathyco/x-types!SimpleFilter:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SimpleFacet#modelName:member", "docComment": "/**\n * Model name to indicate the facet type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'SimpleFacet'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!SimpleFacetSchema:var", "docComment": "/**\n * Jest schema for validating SimpleFacet entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SimpleFacetSchema: " }, { "kind": "Reference", "text": "SimpleFacet", "canonicalReference": "@empathyco/x-types!SimpleFacet:interface" } ], "fileUrlPath": "temp/types/schemas/facet.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "SimpleFacetSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SimpleFilter:interface", "docComment": "/**\n * A type of filter used in {@link SimpleFacet} and extends from {@link Filter}. It can be selected or not.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SimpleFilter extends " }, { "kind": "Reference", "text": "BooleanFilter", "canonicalReference": "@empathyco/x-types!BooleanFilter:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/facet/filter/simple-filter.model.d.ts", "releaseTag": "Public", "name": "SimpleFilter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SimpleFilter#modelName:member", "docComment": "/**\n * Model name to indicate the filter type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modelName: " }, { "kind": "Content", "text": "'SimpleFilter'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!SimpleFilterSchema:var", "docComment": "/**\n * Jest schema for validating SimpleFilter entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SimpleFilterSchema: " }, { "kind": "Reference", "text": "SimpleFilter", "canonicalReference": "@empathyco/x-types!SimpleFilter:interface" } ], "fileUrlPath": "temp/types/schemas/filter.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "SimpleFilterSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@empathyco/x-types!Sort:type", "docComment": "/**\n * The Sort model represents a way of arranging a list of items.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Sort = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "temp/types/sort.model.d.ts", "releaseTag": "Public", "name": "Sort", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!SortableRequest:interface", "docComment": "/**\n * Interface for any Request with sorting.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SortableRequest " } ], "fileUrlPath": "temp/types/request/request.model.d.ts", "releaseTag": "Public", "name": "SortableRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!SortableRequest#sort:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "sort?: " }, { "kind": "Reference", "text": "Sort", "canonicalReference": "@empathyco/x-types!Sort:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "sort", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Stats:interface", "docComment": "/**\n * Statistics for the current search results.\n *\n * Price - interval of the prices of the results.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Stats " } ], "fileUrlPath": "temp/types/stats.model.d.ts", "releaseTag": "Public", "name": "Stats", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Stats#price:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "price: " }, { "kind": "Content", "text": "{\n min: number | undefined;\n max: number | undefined;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "price", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!StepEmpathising:interface", "docComment": "/**\n * Model for each step of the empathising task.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StepEmpathising " } ], "fileUrlPath": "temp/types/response/ai/tasks.model.d.ts", "releaseTag": "Public", "name": "StepEmpathising", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!StepEmpathising#stepDescription:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "stepDescription: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stepDescription", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!StepEmpathising#stepName:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "stepName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "stepName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Suggestion:interface", "docComment": "/**\n * A suggestion represents a query that has been proposed to the user, due of being popular, matching with the current search query...\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Suggestion extends " }, { "kind": "Reference", "text": "NamedModel", "canonicalReference": "@empathyco/x-types!NamedModel:interface" }, { "kind": "Content", "text": "<'QuerySuggestion' | 'PopularSearch' | 'SemanticQuery' | 'NextQuery' | 'HistoryQuery'>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Previewable", "canonicalReference": "@empathyco/x-types!Previewable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "temp/types/suggestion.model.d.ts", "releaseTag": "Public", "name": "Suggestion", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Suggestion#isCurated:member", "docComment": "/**\n * If it's a curated suggestion.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isCurated?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "isCurated", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Suggestion#key:member", "docComment": "/**\n * Unique identifier of the suggestion.\n *\n * @deprecated\n *\n * - The key field should be calculated if needed using the `query` and the `facets` properties.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "key?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 }, { "startIndex": 4, "endIndex": 5 } ] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!SuggestionSchema:var", "docComment": "/**\n * Jest schema for validating Suggestion entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SuggestionSchema: " }, { "kind": "Reference", "text": "Suggestion", "canonicalReference": "@empathyco/x-types!Suggestion:interface" } ], "fileUrlPath": "temp/types/schemas/suggestion.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "SuggestionSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Taggable:interface", "docComment": "/**\n * A taggable entity.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Taggable " } ], "fileUrlPath": "temp/types/tagging.model.d.ts", "releaseTag": "Public", "name": "Taggable", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Taggable#tagging:member", "docComment": "/**\n * Tagging object containing the different taggable events.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "tagging?: " }, { "kind": "Reference", "text": "Tagging", "canonicalReference": "@empathyco/x-types!Tagging:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!TaggableSchema:var", "docComment": "/**\n * Jest schema for validating Taggable entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TaggableSchema: " }, { "kind": "Reference", "text": "Taggable", "canonicalReference": "@empathyco/x-types!Taggable:interface" } ], "fileUrlPath": "temp/types/schemas/tagging.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "TaggableSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!Tagging:interface", "docComment": "/**\n * The tagging user actions.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Tagging " } ], "fileUrlPath": "temp/types/tagging.model.d.ts", "releaseTag": "Public", "name": "Tagging", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "@empathyco/x-types!Tagging:index(1)", "docComment": "/**\n * Any other {@link TaggingRequest | tagging} key-value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Tagging#add2cart:member", "docComment": "/**\n * {@link TaggingRequest | add to cart tagging}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "add2cart?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "add2cart", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Tagging#checkout:member", "docComment": "/**\n * {@link TaggingRequest | checkout tagging}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "checkout?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "checkout", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Tagging#click:member", "docComment": "/**\n * {@link TaggingRequest | click tagging}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "click?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "click", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Tagging#query:member", "docComment": "/**\n * {@link TaggingRequest | query tagging}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "query?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!Tagging#wishlist:member", "docComment": "/**\n * {@link TaggingRequest | wishlist tagging}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wishlist?: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "wishlist", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface", "docComment": "/**\n * The request for the tagging API.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TaggingRequest " } ], "fileUrlPath": "temp/types/request/tagging-request.model.d.ts", "releaseTag": "Public", "name": "TaggingRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!TaggingRequest#params:member", "docComment": "/**\n * Params of the tagging URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "params: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "params", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!TaggingRequest#url:member", "docComment": "/**\n * Tagging URL.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!TaggingRequestSchema:var", "docComment": "/**\n * Jest schema for validating TaggingRequest entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TaggingRequestSchema: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" } ], "fileUrlPath": "temp/types/schemas/tagging.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "TaggingRequestSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@empathyco/x-types!TaggingSchema:var", "docComment": "/**\n * Jest schema for validating Tagging entities.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TaggingSchema: " }, { "kind": "Reference", "text": "Tagging", "canonicalReference": "@empathyco/x-types!Tagging:interface" } ], "fileUrlPath": "temp/types/schemas/tagging.schema.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "TaggingSchema", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface", "docComment": "/**\n * Interface for any Request with tagging.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TrackableRequest " } ], "fileUrlPath": "temp/types/request/request.model.d.ts", "releaseTag": "Public", "name": "TrackableRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!TrackableRequest#origin:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "origin?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "origin", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!TrackableShowResponse:interface", "docComment": "/**\n * Response to be implemented by all responses that contain a part to track the show event.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TrackableShowResponse " } ], "fileUrlPath": "temp/types/response/response.model.d.ts", "releaseTag": "Public", "name": "TrackableShowResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!TrackableShowResponse#showTagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "showTagging: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showTagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!UserInfo:interface", "docComment": "/**\n * The representation of the user.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface UserInfo " } ], "fileUrlPath": "temp/types/user-info.model.d.ts", "releaseTag": "Public", "name": "UserInfo", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!UserInfo#session:member", "docComment": "/**\n * A unique token that represents a search session.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "session: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!UserInfo#user:member", "docComment": "/**\n * A unique token that represents the user over a long period of time.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "user: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "user", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!UserInfo#userType:member", "docComment": "/**\n * Whether the user is new or recurrent.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "userType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "userType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!XComponentsAdapter:interface", "docComment": "/**\n * XComponentsAdapter.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface XComponentsAdapter " } ], "fileUrlPath": "temp/types/x-components-adapter.model.d.ts", "releaseTag": "Public", "name": "XComponentsAdapter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiQuestions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "aiQuestions: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AiQuestionsRequest", "canonicalReference": "@empathyco/x-types!AiQuestionsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "AiQuestionsResponse", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "aiQuestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiSuggestions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "aiSuggestions: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AiSuggestionsRequest", "canonicalReference": "@empathyco/x-types!AiSuggestionsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Response", "canonicalReference": "!Response:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "aiSuggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiSuggestionsSearch:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "aiSuggestionsSearch: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AiSuggestionsSearchRequest", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "AiSuggestionsSearchResponse", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "aiSuggestionsSearch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiSummarize:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "aiSummarize: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AiSuggestionsRequest", "canonicalReference": "@empathyco/x-types!AiSuggestionsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Response", "canonicalReference": "!Response:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "aiSummarize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#aiTasks:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "aiTasks: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AiTasksRequest", "canonicalReference": "@empathyco/x-types!AiTasksRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "AiTasksResponse", "canonicalReference": "@empathyco/x-types!AiTasksResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "aiTasks", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#experienceControls:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "experienceControls: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ExperienceControlsRequest", "canonicalReference": "@empathyco/x-types!ExperienceControlsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ExperienceControlsResponse", "canonicalReference": "@empathyco/x-types!ExperienceControlsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "experienceControls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#facets:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "facets: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FacetsRequest", "canonicalReference": "@empathyco/x-types!FacetsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FacetsResponse", "canonicalReference": "@empathyco/x-types!FacetsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "facets", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#identifierResults:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "identifierResults: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IdentifierResultsRequest", "canonicalReference": "@empathyco/x-types!IdentifierResultsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "IdentifierResultsResponse", "canonicalReference": "@empathyco/x-types!IdentifierResultsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "identifierResults", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#nextQueries:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "nextQueries: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NextQueriesRequest", "canonicalReference": "@empathyco/x-types!NextQueriesRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NextQueriesResponse", "canonicalReference": "@empathyco/x-types!NextQueriesResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "nextQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#popularSearches:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "popularSearches: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PopularSearchesRequest", "canonicalReference": "@empathyco/x-types!PopularSearchesRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PopularSearchesResponse", "canonicalReference": "@empathyco/x-types!PopularSearchesResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "popularSearches", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#querySuggestions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "querySuggestions: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "QuerySuggestionsRequest", "canonicalReference": "@empathyco/x-types!QuerySuggestionsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "QuerySuggestionsResponse", "canonicalReference": "@empathyco/x-types!QuerySuggestionsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "querySuggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#recommendations:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "recommendations: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RecommendationsRequest", "canonicalReference": "@empathyco/x-types!RecommendationsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RecommendationsResponse", "canonicalReference": "@empathyco/x-types!RecommendationsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "recommendations", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#relatedPrompts:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "relatedPrompts: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RelatedPromptsRequest", "canonicalReference": "@empathyco/x-types!RelatedPromptsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RelatedPromptsResponse", "canonicalReference": "@empathyco/x-types!RelatedPromptsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "relatedPrompts", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#relatedTags:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "relatedTags: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RelatedTagsRequest", "canonicalReference": "@empathyco/x-types!RelatedTagsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RelatedTagsResponse", "canonicalReference": "@empathyco/x-types!RelatedTagsResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "relatedTags", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#search:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "search: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SearchRequest", "canonicalReference": "@empathyco/x-types!SearchRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "SearchResponse", "canonicalReference": "@empathyco/x-types!SearchResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "search", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#semanticQueries:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "semanticQueries: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SemanticQueriesRequest", "canonicalReference": "@empathyco/x-types!SemanticQueriesRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "SemanticQueriesResponse", "canonicalReference": "@empathyco/x-types!SemanticQueriesResponse:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "semanticQueries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!XComponentsAdapter#tagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tagging: " }, { "kind": "Reference", "text": "EndpointAdapter", "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ", void>" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [] } ] } ] }