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

egain_api_python/models/getclusterbycasebasereleaseidop.py

@@ -0,0 +1,74 @@
+"""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 GetClusterByCasebaseReleaseIDRequestTypedDict(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."""
+    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 GetClusterByCasebaseReleaseIDRequest(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."""
+
+    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/gethealthop.py

@@ -0,0 +1,130 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from egain_api_python.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+GET_HEALTH_OP_SERVERS = [
+    # Production Server
+    "https://${API_DOMAIN}/knowledge/contentmgr/v4",
+]
+
+
+class GetHealthResponseTypedDict(TypedDict):
+    r"""## Service is Healthy
+
+    The Import Content service is operating normally with all components functioning as expected.
+
+    **Health Status Details:**
+    - **Overall Status**: Service is healthy and ready to process requests
+
+    **Response Information:**
+    - **Status**: Current health state (healthy, degraded, unhealthy)
+    - **Timestamp**: When health check was performed
+    - **Version**: Current API version
+
+    """
+
+    status: NotRequired[str]
+    r"""**Health Status**
+
+    The overall health status of the service. Possible values:
+    - **healthy**: Service is operating normally
+    - **degraded**: Service is functional but with performance issues
+    - **unhealthy**: Service is experiencing critical issues
+    - **maintenance**: Service is under planned maintenance
+
+    """
+    timestamp: NotRequired[datetime]
+    r"""**Health Check Timestamp**
+
+    The exact date and time when this health check was performed. This is useful for:
+    - Tracking health check frequency
+    - Correlating with other system events
+    - Monitoring health check response times
+    - Historical health trend analysis
+
+    """
+    version: NotRequired[str]
+    r"""**API Version**
+
+    The current version of the Import Content API. This helps with:
+    - Version compatibility checking
+    - Feature availability verification
+    - Upgrade planning and coordination
+    - Support and troubleshooting
+
+    """
+    uptime: NotRequired[str]
+    r"""**Service Uptime**
+
+    The total time the service has been running since the last restart. This metric is useful for:
+    - Service stability monitoring
+    - Maintenance scheduling
+    - Performance trend analysis
+    - Reliability assessment
+
+    """
+
+
+class GetHealthResponse(BaseModel):
+    r"""## Service is Healthy
+
+    The Import Content service is operating normally with all components functioning as expected.
+
+    **Health Status Details:**
+    - **Overall Status**: Service is healthy and ready to process requests
+
+    **Response Information:**
+    - **Status**: Current health state (healthy, degraded, unhealthy)
+    - **Timestamp**: When health check was performed
+    - **Version**: Current API version
+
+    """
+
+    status: Optional[str] = None
+    r"""**Health Status**
+
+    The overall health status of the service. Possible values:
+    - **healthy**: Service is operating normally
+    - **degraded**: Service is functional but with performance issues
+    - **unhealthy**: Service is experiencing critical issues
+    - **maintenance**: Service is under planned maintenance
+
+    """
+
+    timestamp: Optional[datetime] = None
+    r"""**Health Check Timestamp**
+
+    The exact date and time when this health check was performed. This is useful for:
+    - Tracking health check frequency
+    - Correlating with other system events
+    - Monitoring health check response times
+    - Historical health trend analysis
+
+    """
+
+    version: Optional[str] = None
+    r"""**API Version**
+
+    The current version of the Import Content API. This helps with:
+    - Version compatibility checking
+    - Feature availability verification
+    - Upgrade planning and coordination
+    - Support and troubleshooting
+
+    """
+
+    uptime: Optional[str] = None
+    r"""**Service Uptime**
+
+    The total time the service has been running since the last restart. This metric is useful for:
+    - Service stability monitoring
+    - Maintenance scheduling
+    - Performance trend analysis
+    - Reliability assessment
+
+    """

egain_api_python/models/getimportcontentop.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+GET_IMPORT_CONTENT_OP_SERVERS = [
+    # Production Server
+    "https://${API_DOMAIN}/knowledge/contentmgr/v4",
+]
+
+
+class GetImportContentRequestTypedDict(TypedDict):
+    job_id: str
+    r"""**Job ID Parameter**
+
+    The unique identifier for the import or validation job. This ID was returned when the job was created via the Import or Validate API.
+
+    **Format:** UUID v4 (e.g., 7A84B875-6F75-4C7B-B137-0632B62DB0BD)
+
+    **Example Usage:**
+    ```bash
+    GET /import/content/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
+    ```
+
+    """
+
+
+class GetImportContentRequest(BaseModel):
+    job_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""**Job ID Parameter**
+
+    The unique identifier for the import or validation job. This ID was returned when the job was created via the Import or Validate API.
+
+    **Format:** UUID v4 (e.g., 7A84B875-6F75-4C7B-B137-0632B62DB0BD)
+
+    **Example Usage:**
+    ```bash
+    GET /import/content/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
+    ```
+
+    """

egain_api_python/models/getmyportalsop.py

@@ -0,0 +1,97 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .mandatorylanguagequeryparameter import MandatoryLanguageQueryParameter
+from .order import Order
+from .sortidnamedepartment import SortIDNameDepartment
+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 GetMyPortalsRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    language: MandatoryLanguageQueryParameter
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""
+    department: NotRequired[str]
+    r"""The Name of the department for which portals are to be fetched"""
+    filter_text: NotRequired[str]
+    r"""Portal name starting with a specific character are considered to filter the result."""
+    short_url_template: NotRequired[str]
+    r"""The Name of the template used while creating Short URL."""
+    sort: NotRequired[SortIDNameDepartment]
+    r"""Objects returned in server response are sorted based on the attribute supplied under $sort. <br>_Default value_: name."""
+    order: NotRequired[Order]
+    r"""Common query parameter $order."""
+    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.<br>Valid range of 5-75<br>_Default value_: 25"""
+
+
+class GetMyPortalsRequest(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)."""
+
+    language: Annotated[
+        MandatoryLanguageQueryParameter,
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""
+
+    department: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The Name of the department for which portals are to be fetched"""
+
+    filter_text: Annotated[
+        Optional[str],
+        pydantic.Field(alias="filterText"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Portal name starting with a specific character are considered to filter the result."""
+
+    short_url_template: Annotated[
+        Optional[str],
+        pydantic.Field(alias="shortUrlTemplate"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The Name of the template used while creating Short URL."""
+
+    sort: Annotated[
+        Optional[SortIDNameDepartment],
+        pydantic.Field(alias="$sort"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Objects returned in server response are sorted based on the attribute supplied under $sort. <br>_Default value_: name."""
+
+    order: Annotated[
+        Optional[Order],
+        pydantic.Field(alias="$order"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Common query parameter $order."""
+
+    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)),
+    ] = 25
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.<br>Valid range of 5-75<br>_Default value_: 25"""

egain_api_python/models/getmysubscriptionop.py

@@ -0,0 +1,115 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .articleresultadditionalattributes import ArticleResultAdditionalAttributes
+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 GetMySubscriptionRequestTypedDict(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."""
+    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>"""
+    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 GetMySubscriptionRequest(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."""
+
+    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>"""
+
+    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/getpendingcompliancearticlesop.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 GetPendingComplianceArticlesRequestTypedDict(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 GetPendingComplianceArticlesRequest(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."""