"""API utilities."""

from oto import status
from oto.response import Response

from collaborator.constants import api as api_constants


def create_paginated_response(items, total_records, status=status.OK):
    """Create a response containing paginated item.

    Args:
        items (list): paginated list of objects.
        total_records (int): total items.
        status (int): HTTP response status code.

    Returns:
        Response: object containing the items and pagination info
    """
    message = {
        "items": items,
        "pagination": {
            "type": api_constants.PAGINATION_TYPE_STANDARD,
            "total_records": total_records,
        },
    }

    return Response(message=message, status=status)