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

egain_api_python/models/folderbreadcrumb.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .foldersummary import FolderSummary, FolderSummaryTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FolderBreadcrumbTypedDict(TypedDict):
+    r"""This schema contains one or more FolderSummary instances."""
+
+    folder_summary: NotRequired[List[FolderSummaryTypedDict]]
+    r"""An instance of FolderSummary."""
+
+
+class FolderBreadcrumb(BaseModel):
+    r"""This schema contains one or more FolderSummary instances."""
+
+    folder_summary: Annotated[
+        Optional[List[FolderSummary]], pydantic.Field(alias="folderSummary")
+    ] = None
+    r"""An instance of FolderSummary."""

egain_api_python/models/foldersummary.py

@@ -0,0 +1,29 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .schemas_link import SchemasLink, SchemasLinkTypedDict
+from egain_api_python.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FolderSummaryTypedDict(TypedDict):
+    r"""This schema contains the topic ID and name of the Folder. This is used by FolderBreadcrumb."""
+
+    id: NotRequired[int]
+    r"""ID of the folder."""
+    name: NotRequired[str]
+    r"""Name of the folder."""
+    link: NotRequired[SchemasLinkTypedDict]
+
+
+class FolderSummary(BaseModel):
+    r"""This schema contains the topic ID and name of the Folder. This is used by FolderBreadcrumb."""
+
+    id: Optional[int] = None
+    r"""ID of the folder."""
+
+    name: Optional[str] = None
+    r"""Name of the folder."""
+
+    link: Optional[SchemasLink] = None

egain_api_python/models/getacknowledgedcompliancearticlesop.py

@@ -0,0 +1,119 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .compliancearticleresultadditionalattributes import (
+    ComplianceArticleResultAdditionalAttributes,
+)
+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 GetAcknowledgedComplianceArticlesRequestTypedDict(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."""
+    compliance_article_result_additional_attributes: NotRequired[
+        List[ComplianceArticleResultAdditionalAttributes]
+    ]
+    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.
+    | updateSummary | Summary of the Article update.
+    | 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.
+
+    """
+    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 GetAcknowledgedComplianceArticlesRequest(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."""
+
+    compliance_article_result_additional_attributes: Annotated[
+        Optional[List[ComplianceArticleResultAdditionalAttributes]],
+        pydantic.Field(alias="complianceArticleResultAdditionalAttributes"),
+        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.
+    | updateSummary | Summary of the Article update.
+    | 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.
+
+    """
+
+    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/getallarticlelistsop.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 GetAllArticleListsRequestTypedDict(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 GetAllArticleListsRequest(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/getallcasebasesreleasesop.py

@@ -0,0 +1,65 @@
+"""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 GetAllCasebasesReleasesRequestTypedDict(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>"""
+    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 GetAllCasebasesReleasesRequest(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>"""
+
+    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/getallcasesop.py

@@ -0,0 +1,83 @@
+"""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 GetAllCasesRequestTypedDict(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."""
+    casebase_release_id: str
+    r"""The numerical ID of the Casebase Release for which details is to be fetched."""
+    cluster_id: str
+    r"""ID of Cluster."""
+    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 GetAllCasesRequest(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."""
+
+    casebase_release_id: Annotated[
+        str,
+        pydantic.Field(alias="casebaseReleaseID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The numerical ID of the Casebase Release for which details is to be fetched."""
+
+    cluster_id: Annotated[
+        str,
+        pydantic.Field(alias="clusterID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""ID of Cluster."""
+
+    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/getallportalsop.py

@@ -0,0 +1,60 @@
+"""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, QueryParamMetadata
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAllPortalsRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    department_id: NotRequired[str]
+    r"""The ID of the department."""
+    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 GetAllPortalsRequest(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)."""
+
+    department_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="departmentID"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The ID of the department."""
+
+    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/getallprofilesinportalop.py

@@ -0,0 +1,64 @@
+"""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,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAllProfilesInPortalRequestTypedDict(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."""
+    filter_casebase_release: NotRequired[str]
+    r"""Filter by Casebase Release"""
+    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 GetAllProfilesInPortalRequest(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."""
+
+    filter_casebase_release: Annotated[
+        Optional[str],
+        pydantic.Field(alias="filter[casebaseRelease]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter by Casebase Release"""
+
+    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/getallquickpicksop.py

@@ -0,0 +1,83 @@
+"""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 GetAllQuickPicksRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    casebase_release_id: str
+    r"""The numerical ID of the Casebase Release for which details is to be fetched."""
+    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>"""
+    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."""
+    get_last_saved_quick_pick_for_interaction: NotRequired[bool]
+    r"""To be passed retrieve quickpick associated with interaction."""
+
+
+class GetAllQuickPicksRequest(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)."""
+
+    casebase_release_id: Annotated[
+        str,
+        pydantic.Field(alias="casebaseReleaseID"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The numerical ID of the Casebase Release for which details is to be fetched."""
+
+    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>"""
+
+    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."""
+
+    get_last_saved_quick_pick_for_interaction: Annotated[
+        Optional[bool],
+        pydantic.Field(alias="getLastSavedQuickPickForInteraction"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""To be passed retrieve quickpick associated with interaction."""