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

egain_api_python/models/getpopulararticlesop.py

@@ -0,0 +1,133 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .articleresultadditionalattributes import ArticleResultAdditionalAttributes
+from .languagequeryparameter import LanguageQueryParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetpopulararticlesRequestTypedDict(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."""
+    dollar_filter_topic_id: NotRequired[str]
+    r"""The ID of the topic. It is used to restrict to a specific topic."""
+    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>"""
+    dollar_filter_tags: NotRequired[str]
+    r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
+    pagenum: NotRequired[int]
+    r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
+    pagesize: NotRequired[int]
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum."""
+    article_result_additional_attributes: NotRequired[
+        List[ArticleResultAdditionalAttributes]
+    ]
+    r"""The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
+
+    #### Default Attributes
+    These Article attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Article.
+    | name  | The name of the Article.
+    | articleType | The Article Type and its attributes.
+    | createdBy | The ID, first name, middle name and last name of the user that created the Article.
+    | createdDate | The date that the Article was created.
+    | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments.
+    | languageCode | The language code of the Article language.
+    | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.
+    | modifiedDate | The date that the Article was last modified on.
+    | link | The link object, used to retrieve the details of the Article.
+    | versionId | The ID of the Article version that is returned.
+
+    """
+
+
+class GetpopulararticlesRequest(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."""
+
+    dollar_filter_topic_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="$filter[topicId]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The ID of the topic. It is used to restrict to a specific topic."""
+
+    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>"""
+
+    dollar_filter_tags: Annotated[
+        Optional[str],
+        pydantic.Field(alias="$filter[tags]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
+
+    pagenum: Annotated[
+        Optional[int],
+        pydantic.Field(alias="$pagenum"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 1
+    r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
+
+    pagesize: Annotated[
+        Optional[int],
+        pydantic.Field(alias="$pagesize"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum."""
+
+    article_result_additional_attributes: Annotated[
+        Optional[List[ArticleResultAdditionalAttributes]],
+        pydantic.Field(alias="articleResultAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
+
+    #### Default Attributes
+    These Article attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Article.
+    | name  | The name of the Article.
+    | articleType | The Article Type and its attributes.
+    | createdBy | The ID, first name, middle name and last name of the user that created the Article.
+    | createdDate | The date that the Article was created.
+    | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments.
+    | languageCode | The language code of the Article language.
+    | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.
+    | modifiedDate | The date that the Article was last modified on.
+    | link | The link object, used to retrieve the details of the Article.
+    | versionId | The ID of the Article version that is returned.
+
+    """

egain_api_python/models/getportaldetailsbyidop.py

@@ -0,0 +1,47 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .languagequeryparameter import LanguageQueryParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetPortalDetailsByIDRequestTypedDict(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."""
+    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 GetPortalDetailsByIDRequest(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."""
+
+    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/getrelatedarticlesforsuggestionop.py

@@ -0,0 +1,96 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .articleresultadditionalattributes import ArticleResultAdditionalAttributes
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetRelatedArticlesForSuggestionRequestTypedDict(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."""
+    suggestion_id: str
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    article_result_additional_attributes: NotRequired[
+        List[ArticleResultAdditionalAttributes]
+    ]
+    r"""The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
+
+    #### Default Attributes
+    These Article attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Article.
+    | name  | The name of the Article.
+    | articleType | The Article Type and its attributes.
+    | createdBy | The ID, first name, middle name and last name of the user that created the Article.
+    | createdDate | The date that the Article was created.
+    | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments.
+    | languageCode | The language code of the Article language.
+    | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.
+    | modifiedDate | The date that the Article was last modified on.
+    | link | The link object, used to retrieve the details of the Article.
+    | versionId | The ID of the Article version that is returned.
+
+    """
+
+
+class GetRelatedArticlesForSuggestionRequest(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."""
+
+    suggestion_id: Annotated[
+        str,
+        pydantic.Field(alias="suggestionID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    article_result_additional_attributes: Annotated[
+        Optional[List[ArticleResultAdditionalAttributes]],
+        pydantic.Field(alias="articleResultAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
+
+    #### Default Attributes
+    These Article attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Article.
+    | name  | The name of the Article.
+    | articleType | The Article Type and its attributes.
+    | createdBy | The ID, first name, middle name and last name of the user that created the Article.
+    | createdDate | The date that the Article was created.
+    | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments.
+    | languageCode | The language code of the Article language.
+    | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.
+    | modifiedDate | The date that the Article was last modified on.
+    | link | The link object, used to retrieve the details of the Article.
+    | versionId | The ID of the Article version that is returned.
+
+    """

egain_api_python/models/getrelatedarticlesop.py

@@ -0,0 +1,143 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .articleresultadditionalattributes import ArticleResultAdditionalAttributes
+from .languagequeryparameter import LanguageQueryParameter
+from .workflowmilestone import WorkflowMilestone
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetRelatedArticlesRequestTypedDict(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."""
+    article_id: str
+    r"""The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits."""
+    dollar_filter_tags: NotRequired[str]
+    r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
+    article_result_additional_attributes: NotRequired[
+        List[ArticleResultAdditionalAttributes]
+    ]
+    r"""The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
+
+    #### Default Attributes
+    These Article attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Article.
+    | name  | The name of the Article.
+    | articleType | The Article Type and its attributes.
+    | createdBy | The ID, first name, middle name and last name of the user that created the Article.
+    | createdDate | The date that the Article was created.
+    | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments.
+    | languageCode | The language code of the Article language.
+    | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.
+    | modifiedDate | The date that the Article was last modified on.
+    | link | The link object, used to retrieve the details of the Article.
+    | versionId | The ID of the Article version that is returned.
+
+    """
+    workflow_milestone: NotRequired[WorkflowMilestone]
+    r"""For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>"""
+    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>"""
+    pagenum: NotRequired[int]
+    r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
+    pagesize: NotRequired[int]
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum."""
+
+
+class GetRelatedArticlesRequest(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."""
+
+    article_id: Annotated[
+        str,
+        pydantic.Field(alias="articleID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits."""
+
+    dollar_filter_tags: Annotated[
+        Optional[str],
+        pydantic.Field(alias="$filter[tags]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
+
+    article_result_additional_attributes: Annotated[
+        Optional[List[ArticleResultAdditionalAttributes]],
+        pydantic.Field(alias="articleResultAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
+
+    #### Default Attributes
+    These Article attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Article.
+    | name  | The name of the Article.
+    | articleType | The Article Type and its attributes.
+    | createdBy | The ID, first name, middle name and last name of the user that created the Article.
+    | createdDate | The date that the Article was created.
+    | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments.
+    | languageCode | The language code of the Article language.
+    | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.
+    | modifiedDate | The date that the Article was last modified on.
+    | link | The link object, used to retrieve the details of the Article.
+    | versionId | The ID of the Article version that is returned.
+
+    """
+
+    workflow_milestone: Annotated[
+        Optional[WorkflowMilestone],
+        pydantic.Field(alias="workflowMilestone"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>"""
+
+    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>"""
+
+    pagenum: Annotated[
+        Optional[int],
+        pydantic.Field(alias="$pagenum"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 1
+    r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
+
+    pagesize: Annotated[
+        Optional[int],
+        pydantic.Field(alias="$pagesize"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum."""

egain_api_python/models/getsuggestionattachmentbyidop.py

@@ -0,0 +1,76 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .attachmentadditionalattributes import AttachmentAdditionalAttributes
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetSuggestionAttachmentByIDRequestTypedDict(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."""
+    attachment_id: str
+    r"""The ID of the attachment.<br><br>An attachment ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    attachment_additional_attributes: NotRequired[List[AttachmentAdditionalAttributes]]
+    r"""The attributes of an attachment to be returned, along with the default attachment details.
+
+    | Attribute    | Description                        |
+    |--------------|------------------------------------|
+    | id         | Unique identifier for the attachment |
+    | fileName   | Name of the file                   |
+    | contentType| Content type of the file              |
+    | size       | Size of the file in bytes          |
+    | link       | Link to the attachment             |
+
+    """
+
+
+class GetSuggestionAttachmentByIDRequest(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."""
+
+    attachment_id: Annotated[
+        str,
+        pydantic.Field(alias="attachmentID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the attachment.<br><br>An attachment ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    attachment_additional_attributes: Annotated[
+        Optional[List[AttachmentAdditionalAttributes]],
+        pydantic.Field(alias="attachmentAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""The attributes of an attachment to be returned, along with the default attachment details.
+
+    | Attribute    | Description                        |
+    |--------------|------------------------------------|
+    | id         | Unique identifier for the attachment |
+    | fileName   | Name of the file                   |
+    | contentType| Content type of the file              |
+    | size       | Size of the file in bytes          |
+    | link       | Link to the attachment             |
+
+    """

egain_api_python/models/getsuggestionattachmentsop.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class GetSuggestionAttachmentsRequestTypedDict(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."""
+    suggestion_id: str
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+
+class GetSuggestionAttachmentsRequest(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."""
+
+    suggestion_id: Annotated[
+        str,
+        pydantic.Field(alias="suggestionID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""

egain_api_python/models/getsuggestioncommentsop.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class GetSuggestionCommentsRequestTypedDict(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."""
+    suggestion_id: str
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+
+class GetSuggestionCommentsRequest(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."""
+
+    suggestion_id: Annotated[
+        str,
+        pydantic.Field(alias="suggestionID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""