pypresscart.resources.articles

Articles resource: /articles/{id} endpoints.

Classes

ArticlesResource(client)

Endpoints for articles produced by campaigns.
class pypresscart.resources.articles.ArticlesResource(client)[source]

Bases: ResourceBase

Endpoints for articles produced by campaigns.

Parameters:

client (PresscartClient)

get(article_id, *, as_json=None)[source]

Get an article by id. Required scope: campaigns.read.

Parameters:

  • article_id (str)

  • as_json (bool | None)

Return type:

Article | dict[str, Any]

update(article_id, body, *, as_json=None)[source]

Update an article. Required scope: campaigns.update.

Parameters:
Return type:

Article | dict[str, Any]

approve_brief(article_id, *, as_json=None)[source]

Approve the brief for an article. Required scope: campaigns.update.

Parameters:

  • article_id (str)

  • as_json (bool | None)

Return type:

Article | dict[str, Any]

approve_draft(article_id, body=None, *, as_json=None)[source]

Approve the draft for an article. Required scope: campaigns.update.

Parameters:
Return type:

Article | dict[str, Any]

list_comments(article_id, *, as_json=None)[source]

List an article’s comments, grouped by root comment with one level of replies. Required scopes: articles.read, articles.lists.

Parameters:

  • article_id (str)

  • as_json (bool | None)

Return type:

CommentList | dict[str, Any]

create_comment(article_id, body, *, as_json=None)[source]

Create a comment on an article. Pass parent_comment_id to post a reply. Required scope: articles.create.

Parameters:
Return type:

Comment | dict[str, Any]

update_comment(article_id, comment_reference, body, *, as_json=None)[source]

Replace the content of a comment your token created. Required scope: articles.update.

Parameters:
Return type:

Comment | dict[str, Any]

archive_comment(article_id, comment_reference, *, as_json=None)[source]

Soft-delete (archive) a comment your token created. Required scope: articles.delete.

Parameters:

  • article_id (str)

  • comment_reference (str)

  • as_json (bool | None)

Return type:

CommentArchiveResponse | dict[str, Any]