Comments

class CommentsService(client: CommentsClient)

Service class for comments

Developers has option to use this service directly or use the Fider client.

create_comment(request: CreateCommentRequest) → FiderAPIResponse[CreateCommentResponse]

Create a new comment

Example:

>>> from fiderpy.v1.resources.comments import request
>>> from fiderpy.v1.resources.comments.service import CommentsService

>>> service = CommentsService(client=CommentsClient(http=http))
>>> request = CreateCommentRequest(number=1, content="This is a comment")
>>> response = service.create_comment(request=request)
>>> response
FiderAPIResponse(
    message="Successfully created comment!",
    data=CreateCommentResponse(
        id=1,
        content="This is a comment",
        created_at="2021-01-01T00:00:00Z"
    ),
    errors=None
)

Parameters:: request – fiderpy.v1.resources.comments.request.CreateCommentRequest
Returns:: fiderpy.v1.utils.domain.FiderAPIResponse

delete_comment(request: DeleteCommentRequest) → FiderAPIResponse[dict]

Delete a comment

Example:

>>> from fiderpy.v1.resources.comments import request
>>> from fiderpy.v1.resources.comments.service import CommentsService

>>> service = CommentsService(client=CommentsClient(http=http))
>>> request = DeleteCommentRequest(number=1, id=1)
>>> response = service.delete_comment(request=request)
>>> response
FiderAPIResponse(
    message="Successfully deleted comment!",
    data={},
    errors=None
)

Parameters:: request – fiderpy.v1.resources.comments.request.DeleteCommentRequest
Returns:: fiderpy.v1.utils.domain.FiderAPIResponse

edit_comment(request: EditCommentRequest) → FiderAPIResponse[dict]

Edit an existing comment

Example:

>>> from fiderpy.v1.resources.comments import request
>>> from fiderpy.v1.resources.comments.service import CommentsService

>>> service = CommentsService(client=CommentsClient(http=http))
>>> request = EditCommentRequest(number=1, id=1, content="Updated comment")
>>> response = service.edit_comment(request=request)
>>> response
FiderAPIResponse(
    message="Successfully updated comment!",
    data={},
    errors=None
)

Parameters:: request – fiderpy.v1.resources.comments.request.EditCommentRequest
Returns:: fiderpy.v1.utils.domain.FiderAPIResponse

get_comment(request: GetCommentRequest) → FiderAPIResponse[Comment]

Get a single comment

Example:

>>> from fiderpy.v1.resources.comments import request
>>> from fiderpy.v1.resources.comments.service import CommentsService

>>> service = CommentsService(client=CommentsClient(http=http))
>>> request = GetCommentRequest(number=1, id=1)
>>> response = service.get_comment(request=request)
>>> response
FiderAPIResponse(
    message="Successfully fetched data.",
    data=Comment(
        id=1,
        content="This is a comment",
        created_at="2021-01-01T00:00:00Z",
        user=User(
            id=1,
            name="John Doe",
            role="user"
        )
    ),
    errors=None
)

Parameters:: request – fiderpy.v1.resources.comments.request.GetCommentRequest
Returns:: fiderpy.v1.utils.domain.FiderAPIResponse

get_comments(request: GetCommentsRequest) → FiderAPIResponse[list[Comment]]

Get all comments for a post

Example:

>>> from fiderpy.v1.resources.comments import request
>>> from fiderpy.v1.resources.comments.service import CommentsService

>>> service = CommentsService(client=CommentsClient(http=http))
>>> request = GetCommentsRequest(number=1)
>>> response = service.get_comments(request=request)
>>> response
FiderAPIResponse(
    message="Successfully fetched data.",
    data=[
        Comment(
            id=1,
            content="This is a comment",
            created_at="2021-01-01T00:00:00Z",
            user=User(
                id=1,
                name="John Doe",
                role="user"
            )
        ),
    ],
    errors=None
)

Parameters:: request – fiderpy.v1.resources.comments.request.GetCommentsRequest
Returns:: fiderpy.v1.utils.domain.FiderAPIResponse