Source code for kelvin.api.client.model.pagination

# generated by datamodel-codegen:
#   filename:  overriden.json

from __future__ import annotations

from typing import Optional

from pydantic import Field, StrictInt, StrictStr

from kelvin.api.base.data_model import DataModelBase




class PaginationCursor(DataModelBase):
    """PaginationCursor object.

    Args:
        next_page: Optional[StrictStr]
        previous_page: Optional[StrictStr]

    """

    next_page: Optional[StrictStr] = Field(
        default=None,
        description="Bookmark location for `starting_after` parameter in future API requests.",
        examples=["W3siS2V5IjoicmVzb3VyY2UiLCJWYWx1ZSI6ImtybjphZDpkZW1vLWNlbnRyaWZ1Z2FsLXB1bXAtMS9odW1pZGl0eSJ9XQ=="],
    )
    previous_page: Optional[StrictStr] = Field(
        default=None,
        description="Bookmark location for `ending_before` parameter in future API requests.",
        examples=["W3siS2V5IjoicmVzb3VyY2UiLCJWYWx1ZSI6ImtybjphZDpkZW1vLWNlbnRyaWZ1Z2FsLXB1bXAtMS9odW1pZGl0eSJ9XQ=="],
    )





class PaginationLimits(DataModelBase):
    """PaginationLimits object.

    Args:
        page_size: Optional[StrictInt]
        page: Optional[StrictInt]
        total_pages: Optional[StrictInt]
        total_items: Optional[StrictInt]

    """

    page_size: Optional[StrictInt] = Field(
        default=None,
        description="Number of objects returned in current page.",
        examples=[20],
    )
    page: Optional[StrictInt] = Field(
        default=None,
        description="Current page number of returned objects.",
        examples=[8],
    )
    total_pages: Optional[StrictInt] = Field(
        default=None,
        description="Total pages available based on current request parameters.",
        examples=[39],
    )
    total_items: Optional[StrictInt] = Field(
        default=None,
        description="Total number of objects based on current request parameters.",
        examples=[628],
    )