egain-api-python 0.1.1__py3-none-any.whl

egain_api_python/models/createdby.py

@@ -0,0 +1,37 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreatedByTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The ID of the user that created this resource."""
+    user_name: NotRequired[str]
+    r"""The resource creator's username."""
+    first_name: NotRequired[str]
+    r"""The resource creator's first name."""
+    middle_name: NotRequired[str]
+    r"""The resource creator's middle name."""
+    last_name: NotRequired[str]
+    r"""The resource creator's last name."""
+
+
+class CreatedBy(BaseModel):
+    id: Optional[str] = None
+    r"""The ID of the user that created this resource."""
+
+    user_name: Annotated[Optional[str], pydantic.Field(alias="userName")] = None
+    r"""The resource creator's username."""
+
+    first_name: Annotated[Optional[str], pydantic.Field(alias="firstName")] = None
+    r"""The resource creator's first name."""
+
+    middle_name: Annotated[Optional[str], pydantic.Field(alias="middleName")] = None
+    r"""The resource creator's middle name."""
+
+    last_name: Annotated[Optional[str], pydantic.Field(alias="lastName")] = None
+    r"""The resource creator's last name."""

egain_api_python/models/createfederatedsearchevent.py

@@ -0,0 +1,85 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .kblanguagecode import KbLanguageCode
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Literal
+from typing_extensions import Annotated, TypedDict
+
+
+ResultType = Literal[
+    "external",
+    "internal",
+]
+r"""Only \"external\" or \"internal\" allowed"""
+
+
+class CreateFederatedSearchEventTypedDict(TypedDict):
+    q: str
+    r"""The search string that was entered by the user"""
+    result_type: ResultType
+    r"""Only \"external\" or \"internal\" allowed"""
+    url: str
+    title: str
+    language_code: KbLanguageCode
+    r"""A short language code. A list of codes can be found below:
+
+    |Code|Description
+    |----|-----------
+    |en-US|English (United States)
+    |en-GB|English (United Kingdom)
+    |fr-FR|French (France)
+    |es-ES|Spanish (Spain)
+    |it-IT|Italian (Italy)
+    |de-DE|German (Germany)
+    |nl-NL|Dutch (Netherlands)
+    |pt-BR|Portuguese (Brazil)
+    |pt-PT|Portuguese (Portugal)
+    |da-DK|Danish (Denmark)
+    |sv-SE|Swedish (Sweden)
+    |ru-RU|Russian (Russia)
+    |fr-CA|French (Canada)
+    |zh-CN|Chinese (Simplified, China)
+    |ja-JP|Japanese (Japan)
+    |ko-KR|Korean (South Korea)
+    |nn-NO|Norwegian Nynorsk (Norway)
+
+    """
+
+
+class CreateFederatedSearchEvent(BaseModel):
+    q: str
+    r"""The search string that was entered by the user"""
+
+    result_type: Annotated[ResultType, pydantic.Field(alias="resultType")]
+    r"""Only \"external\" or \"internal\" allowed"""
+
+    url: str
+
+    title: str
+
+    language_code: Annotated[KbLanguageCode, pydantic.Field(alias="languageCode")]
+    r"""A short language code. A list of codes can be found below:
+
+    |Code|Description
+    |----|-----------
+    |en-US|English (United States)
+    |en-GB|English (United Kingdom)
+    |fr-FR|French (France)
+    |es-ES|Spanish (Spain)
+    |it-IT|Italian (Italy)
+    |de-DE|German (Germany)
+    |nl-NL|Dutch (Netherlands)
+    |pt-BR|Portuguese (Brazil)
+    |pt-PT|Portuguese (Portugal)
+    |da-DK|Danish (Denmark)
+    |sv-SE|Swedish (Sweden)
+    |ru-RU|Russian (Russia)
+    |fr-CA|French (Canada)
+    |zh-CN|Chinese (Simplified, China)
+    |ja-JP|Japanese (Japan)
+    |ko-KR|Korean (South Korea)
+    |nn-NO|Norwegian Nynorsk (Norway)
+
+    """

egain_api_python/models/createfederatedsearchresulteventop.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .createfederatedsearchevent import (
+    CreateFederatedSearchEvent,
+    CreateFederatedSearchEventTypedDict,
+)
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CreateFederatedSearchResultEventRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    portal_id: str
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    create_federated_search_event: CreateFederatedSearchEventTypedDict
+
+
+class CreateFederatedSearchResultEventRequest(BaseModel):
+    accept_language: Annotated[
+        AcceptLanguage,
+        pydantic.Field(alias="Accept-Language"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ]
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+
+    portal_id: Annotated[
+        str,
+        pydantic.Field(alias="portalID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    create_federated_search_event: Annotated[
+        CreateFederatedSearchEvent,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/createimportop.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing import Dict, List
+from typing_extensions import TypedDict
+
+
+CREATE_IMPORT_OP_SERVERS = [
+    # Production Server
+    "https://${API_DOMAIN}/knowledge/contentmgr/v4",
+]
+
+
+class CreateImportResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+
+
+class CreateImportResponse(BaseModel):
+    headers: Dict[str, List[str]]

egain_api_python/models/createimportvalidationop.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing import Dict, List
+from typing_extensions import TypedDict
+
+
+CREATE_IMPORT_VALIDATION_OP_SERVERS = [
+    # Production Server
+    "https://${API_DOMAIN}/knowledge/contentmgr/v4",
+]
+
+
+class CreateImportValidationResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+
+
+class CreateImportValidationResponse(BaseModel):
+    headers: Dict[str, List[str]]

egain_api_python/models/createquickpick.py

@@ -0,0 +1,34 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreateQuickpickTypedDict(TypedDict):
+    casebase_release_id: str
+    r"""The numerical ID of Live release of the Casebase."""
+    name: NotRequired[str]
+    r"""name of the quick pick"""
+    comment: NotRequired[str]
+    r"""comment about quick pick"""
+    link_to_activity: NotRequired[bool]
+    r"""indicates if quickpick is to be linked with activity"""
+
+
+class CreateQuickpick(BaseModel):
+    casebase_release_id: Annotated[str, pydantic.Field(alias="casebaseReleaseId")]
+    r"""The numerical ID of Live release of the Casebase."""
+
+    name: Optional[str] = None
+    r"""name of the quick pick"""
+
+    comment: Optional[str] = None
+    r"""comment about quick pick"""
+
+    link_to_activity: Annotated[
+        Optional[bool], pydantic.Field(alias="linkToActivity")
+    ] = None
+    r"""indicates if quickpick is to be linked with activity"""

egain_api_python/models/createquickpickop.py

@@ -0,0 +1,55 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .createquickpick import CreateQuickpick, CreateQuickpickTypedDict
+from .languagequeryparameter import LanguageQueryParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreateQuickpickRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    portal_id: str
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    create_quickpick: CreateQuickpickTypedDict
+    language: NotRequired[LanguageQueryParameter]
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>lang</code> is not passed, then the portal's default language is used.</li>"""
+
+
+class CreateQuickpickRequest(BaseModel):
+    accept_language: Annotated[
+        AcceptLanguage,
+        pydantic.Field(alias="Accept-Language"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ]
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+
+    portal_id: Annotated[
+        str,
+        pydantic.Field(alias="portalID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    create_quickpick: Annotated[
+        CreateQuickpick,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+
+    language: Annotated[
+        Optional[LanguageQueryParameter],
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>lang</code> is not passed, then the portal's default language is used.</li>"""

egain_api_python/models/createsearchresulteventforconnectors.py

@@ -0,0 +1,71 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .kblanguagecode import KbLanguageCode
+from egain_api_python.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CreateSearchResultEventForConnectorsTypedDict(TypedDict):
+    language_code: KbLanguageCode
+    r"""A short language code. A list of codes can be found below:
+
+    |Code|Description
+    |----|-----------
+    |en-US|English (United States)
+    |en-GB|English (United Kingdom)
+    |fr-FR|French (France)
+    |es-ES|Spanish (Spain)
+    |it-IT|Italian (Italy)
+    |de-DE|German (Germany)
+    |nl-NL|Dutch (Netherlands)
+    |pt-BR|Portuguese (Brazil)
+    |pt-PT|Portuguese (Portugal)
+    |da-DK|Danish (Denmark)
+    |sv-SE|Swedish (Sweden)
+    |ru-RU|Russian (Russia)
+    |fr-CA|French (Canada)
+    |zh-CN|Chinese (Simplified, China)
+    |ja-JP|Japanese (Japan)
+    |ko-KR|Korean (South Korea)
+    |nn-NO|Norwegian Nynorsk (Norway)
+
+    """
+    q: str
+    r"""The string to use for the search."""
+    number_of_search_results: int
+
+
+class CreateSearchResultEventForConnectors(BaseModel):
+    language_code: Annotated[KbLanguageCode, pydantic.Field(alias="languageCode")]
+    r"""A short language code. A list of codes can be found below:
+
+    |Code|Description
+    |----|-----------
+    |en-US|English (United States)
+    |en-GB|English (United Kingdom)
+    |fr-FR|French (France)
+    |es-ES|Spanish (Spain)
+    |it-IT|Italian (Italy)
+    |de-DE|German (Germany)
+    |nl-NL|Dutch (Netherlands)
+    |pt-BR|Portuguese (Brazil)
+    |pt-PT|Portuguese (Portugal)
+    |da-DK|Danish (Denmark)
+    |sv-SE|Swedish (Sweden)
+    |ru-RU|Russian (Russia)
+    |fr-CA|French (Canada)
+    |zh-CN|Chinese (Simplified, China)
+    |ja-JP|Japanese (Japan)
+    |ko-KR|Korean (South Korea)
+    |nn-NO|Norwegian Nynorsk (Norway)
+
+    """
+
+    q: str
+    r"""The string to use for the search."""
+
+    number_of_search_results: Annotated[
+        int, pydantic.Field(alias="numberOfSearchResults")
+    ]

egain_api_python/models/createsearchresulteventforconnectorsop.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .createsearchresulteventforconnectors import (
+    CreateSearchResultEventForConnectors,
+    CreateSearchResultEventForConnectorsTypedDict,
+)
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CreateSearchResultEventForConnectorsRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    portal_id: str
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    create_search_result_event_for_connectors: (
+        CreateSearchResultEventForConnectorsTypedDict
+    )
+
+
+class CreateSearchResultEventForConnectorsRequest(BaseModel):
+    accept_language: Annotated[
+        AcceptLanguage,
+        pydantic.Field(alias="Accept-Language"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ]
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+
+    portal_id: Annotated[
+        str,
+        pydantic.Field(alias="portalID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    create_search_result_event_for_connectors: Annotated[
+        CreateSearchResultEventForConnectors,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/createsignedurlop.py

@@ -0,0 +1,29 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .attachmentupload import AttachmentUpload, AttachmentUploadTypedDict
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import FieldMetadata, HeaderMetadata, RequestMetadata
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CreateSignedURLRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    attachment_upload: AttachmentUploadTypedDict
+
+
+class CreateSignedURLRequest(BaseModel):
+    accept_language: Annotated[
+        AcceptLanguage,
+        pydantic.Field(alias="Accept-Language"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ]
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+
+    attachment_upload: Annotated[
+        AttachmentUpload,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/createsuggestion.py

@@ -0,0 +1,126 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .attachmentforcreatesuggestion import (
+    AttachmentForCreateSuggestion,
+    AttachmentForCreateSuggestionTypedDict,
+)
+from .customattribute import CustomAttribute, CustomAttributeTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class RelatedArticleForCreateUpdateDeleteSuggestionTypedDict(TypedDict):
+    r"""The Article that the Suggestion was created for."""
+
+    id: NotRequired[str]
+    r"""The ID of a Related Article.<br><br>An Article ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+
+class RelatedArticleForCreateUpdateDeleteSuggestion(BaseModel):
+    r"""The Article that the Suggestion was created for."""
+
+    id: Optional[str] = None
+    r"""The ID of a Related Article.<br><br>An Article ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+
+class CreateSuggestionAttachmentsTypedDict(TypedDict):
+    r"""Details of Attachments for the Suggestion."""
+
+    attachment: NotRequired[List[AttachmentForCreateSuggestionTypedDict]]
+    r"""The list of Attachments."""
+
+
+class CreateSuggestionAttachments(BaseModel):
+    r"""Details of Attachments for the Suggestion."""
+
+    attachment: Optional[List[AttachmentForCreateSuggestion]] = None
+    r"""The list of Attachments."""
+
+
+CreateSuggestionCode = Literal[
+    "en-US",
+    "en-GB",
+    "fr-FR",
+    "es-ES",
+    "it-IT",
+    "de-DE",
+    "nl-NL",
+    "pt-BR",
+    "pt-PT",
+    "da-DK",
+    "sv-SE",
+    "ru-RU",
+    "fr-CA",
+    "zh-CN",
+    "ja-JP",
+    "ko-KR",
+]
+r"""The code of the language."""
+
+
+class CreateSuggestionLanguageTypedDict(TypedDict):
+    r"""The knowledge base language in which the Suggestion is created."""
+
+    code: CreateSuggestionCode
+    r"""The code of the language."""
+
+
+class CreateSuggestionLanguage(BaseModel):
+    r"""The knowledge base language in which the Suggestion is created."""
+
+    code: CreateSuggestionCode
+    r"""The code of the language."""
+
+
+class CreateSuggestionTypedDict(TypedDict):
+    r"""This schema contains information about a Suggestion."""
+
+    name: str
+    r"""The name of the Suggestion."""
+    content: str
+    r"""The content of the Suggestion."""
+    language: CreateSuggestionLanguageTypedDict
+    r"""The knowledge base language in which the Suggestion is created."""
+    description: NotRequired[str]
+    r"""The description of the Suggestion."""
+    feedback_article: NotRequired[
+        RelatedArticleForCreateUpdateDeleteSuggestionTypedDict
+    ]
+    r"""The Article that the Suggestion was created for."""
+    attachments: NotRequired[CreateSuggestionAttachmentsTypedDict]
+    r"""Details of Attachments for the Suggestion."""
+    custom_attributes: NotRequired[List[CustomAttributeTypedDict]]
+    r"""The Custom Attributes of the Suggestion."""
+
+
+class CreateSuggestion(BaseModel):
+    r"""This schema contains information about a Suggestion."""
+
+    name: str
+    r"""The name of the Suggestion."""
+
+    content: str
+    r"""The content of the Suggestion."""
+
+    language: CreateSuggestionLanguage
+    r"""The knowledge base language in which the Suggestion is created."""
+
+    description: Optional[str] = None
+    r"""The description of the Suggestion."""
+
+    feedback_article: Annotated[
+        Optional[RelatedArticleForCreateUpdateDeleteSuggestion],
+        pydantic.Field(alias="feedbackArticle"),
+    ] = None
+    r"""The Article that the Suggestion was created for."""
+
+    attachments: Optional[CreateSuggestionAttachments] = None
+    r"""Details of Attachments for the Suggestion."""
+
+    custom_attributes: Annotated[
+        Optional[List[CustomAttribute]], pydantic.Field(alias="customAttributes")
+    ] = None
+    r"""The Custom Attributes of the Suggestion."""

egain_api_python/models/createviewedsearchresulteventforconnectors.py

@@ -0,0 +1,76 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .kblanguagecode import KbLanguageCode
+from egain_api_python.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CreateViewedSearchResultEventForConnectorsTypedDict(TypedDict):
+    language_code: KbLanguageCode
+    r"""A short language code. A list of codes can be found below:
+
+    |Code|Description
+    |----|-----------
+    |en-US|English (United States)
+    |en-GB|English (United Kingdom)
+    |fr-FR|French (France)
+    |es-ES|Spanish (Spain)
+    |it-IT|Italian (Italy)
+    |de-DE|German (Germany)
+    |nl-NL|Dutch (Netherlands)
+    |pt-BR|Portuguese (Brazil)
+    |pt-PT|Portuguese (Portugal)
+    |da-DK|Danish (Denmark)
+    |sv-SE|Swedish (Sweden)
+    |ru-RU|Russian (Russia)
+    |fr-CA|French (Canada)
+    |zh-CN|Chinese (Simplified, China)
+    |ja-JP|Japanese (Japan)
+    |ko-KR|Korean (South Korea)
+    |nn-NO|Norwegian Nynorsk (Norway)
+
+    """
+    q: str
+    r"""The string to use for the search."""
+    url: str
+    r"""The URL of the search result."""
+    title: str
+    r"""The title of the search result."""
+
+
+class CreateViewedSearchResultEventForConnectors(BaseModel):
+    language_code: Annotated[KbLanguageCode, pydantic.Field(alias="languageCode")]
+    r"""A short language code. A list of codes can be found below:
+
+    |Code|Description
+    |----|-----------
+    |en-US|English (United States)
+    |en-GB|English (United Kingdom)
+    |fr-FR|French (France)
+    |es-ES|Spanish (Spain)
+    |it-IT|Italian (Italy)
+    |de-DE|German (Germany)
+    |nl-NL|Dutch (Netherlands)
+    |pt-BR|Portuguese (Brazil)
+    |pt-PT|Portuguese (Portugal)
+    |da-DK|Danish (Denmark)
+    |sv-SE|Swedish (Sweden)
+    |ru-RU|Russian (Russia)
+    |fr-CA|French (Canada)
+    |zh-CN|Chinese (Simplified, China)
+    |ja-JP|Japanese (Japan)
+    |ko-KR|Korean (South Korea)
+    |nn-NO|Norwegian Nynorsk (Norway)
+
+    """
+
+    q: str
+    r"""The string to use for the search."""
+
+    url: str
+    r"""The URL of the search result."""
+
+    title: str
+    r"""The title of the search result."""