Forem.init_api
— Methodinit_api(::Type{T})::T where {T <: OpenAPI.APIClientImpl}
Initialize the Forem API
Forem.APIClient.Article
— TypeArticle Representation of an Article to be created/updated
Article(;
article=nothing,
)
- article::ArticleArticle
Forem.APIClient.ArticleArticle
— TypeArticle_article
ArticleArticle(;
title=nothing,
body_markdown=nothing,
published=false,
series=nothing,
main_image=nothing,
canonical_url=nothing,
description=nothing,
tags=nothing,
organization_id=nothing,
)
- title::String
- body_markdown::String
- published::Bool
- series::String
- main_image::String
- canonical_url::String
- description::String
- tags::String
- organization_id::Int64
Forem.APIClient.ArticleFlareTag
— TypeArticleFlareTag Flare tag of the article
ArticleFlareTag(;
name=nothing,
bg_color_hex=nothing,
text_color_hex=nothing,
)
- name::String
- bg_color_hex::String : Background color (hexadecimal)
- text_color_hex::String : Text color (hexadecimal)
Forem.APIClient.ArticleIndex
— TypeArticleIndex Representation of an article or post returned in a list
ArticleIndex(;
type_of=nothing,
id=nothing,
title=nothing,
description=nothing,
cover_image=nothing,
readable_publish_date=nothing,
social_image=nothing,
tag_list=nothing,
tags=nothing,
slug=nothing,
path=nothing,
url=nothing,
canonical_url=nothing,
positive_reactions_count=nothing,
public_reactions_count=nothing,
created_at=nothing,
edited_at=nothing,
crossposted_at=nothing,
published_at=nothing,
last_comment_at=nothing,
published_timestamp=nothing,
reading_time_minutes=nothing,
user=nothing,
flare_tag=nothing,
organization=nothing,
)
- type_of::String
- id::Int64
- title::String
- description::String
- cover_image::String
- readable_publish_date::String
- social_image::String
- tag_list::Vector{String}
- tags::String
- slug::String
- path::String
- url::String
- canonical_url::String
- positive_reactions_count::Int64
- public_reactions_count::Int64
- created_at::ZonedDateTime
- edited_at::ZonedDateTime
- crossposted_at::ZonedDateTime
- published_at::ZonedDateTime
- last_comment_at::ZonedDateTime
- published_timestamp::ZonedDateTime : Crossposting or published date time
- reading_time_minutes::Int64 : Reading time, in minutes
- user::SharedUser
- flare_tag::ArticleFlareTag
- organization::SharedOrganization
Forem.APIClient.Comment
— TypeComment A Comment on an Article or Podcast Episode
Comment(;
type_of=nothing,
id_code=nothing,
created_at=nothing,
image_url=nothing,
)
- type_of::String
- id_code::String
- created_at::ZonedDateTime
- image_url::String : Podcast image url
Forem.APIClient.DisplayAd
— TypeDisplayAd A Display Ad, aka Billboard, aka Widget
DisplayAd(;
id=nothing,
name=nothing,
body_markdown=nothing,
approved=nothing,
published=nothing,
organization_id=nothing,
creator_id=nothing,
placement_area=nothing,
tag_list=nothing,
article_exclude_ids=nothing,
audience_segment_type=nothing,
display_to="all",
type_of="in_house",
)
- id::Int64 : The ID of the Display Ad
- name::String : For internal use, helps distinguish ads from one another
- body_markdown::String : The text (in markdown) of the ad (required)
- approved::Bool : Ad must be both published and approved to be in rotation
- published::Bool : Ad must be both published and approved to be in rotation
- organization_id::Int64 : Identifies the organization to which the ad belongs
- creator_id::Int64 : Identifies the user who created the ad.
- placement_area::String : Identifies which area of site layout the ad can appear in
- tag_list::String : Tags on which this ad can be displayed (blank is all/any tags)
- article_exclude_ids::String : Articles this ad should *not* appear on (blank means no articles are disallowed, and this ad can appear next to any/all articles). Comma-separated list of integer Article IDs
- audience_segment_type::String : Specifies an group of users to show this ad to (only works with logged-in users)
- display_to::String : Potentially limits visitors to whom the ad is visible
- type_of::String : Types of the billboards: in_house (created by admins), community (created by an entity, appears on entity's content), external ( created by an entity, or a non-entity, can appear everywhere)
Forem.APIClient.FollowedTag
— TypeFollowedTag Representation of a followed tag
FollowedTag(;
id=nothing,
name=nothing,
points=nothing,
)
- id::Int64 : Tag id
- name::String
- points::Float32
Forem.APIClient.GetFollowers200ResponseInner
— TypegetFollowers200response_inner A follower
GetFollowers200ResponseInner(;
type_of=nothing,
id=nothing,
user_id=nothing,
name=nothing,
path=nothing,
profile_image=nothing,
)
- type_of::String : user_follower by default
- id::Int64
- user_id::Int64 : The follower's user id
- name::String : The follower's name
- path::String : A path to the follower's profile
- profile_image::String : Profile image (640x640)
Forem.APIClient.Organization
— TypeOrganization Representation of an Organization
Organization(;
type_of=nothing,
username=nothing,
name=nothing,
summary=nothing,
twitter_username=nothing,
github_username=nothing,
url=nothing,
location=nothing,
joined_at=nothing,
tech_stack=nothing,
tag_line=nothing,
story=nothing,
)
- type_of::String
- username::String
- name::String
- summary::String
- twitter_username::String
- github_username::String
- url::String
- location::String
- joined_at::String
- tech_stack::String
- tag_line::String
- story::String
Forem.APIClient.Page
— TypePage Representation of a page object
Page(;
title=nothing,
slug=nothing,
description=nothing,
body_markdown=nothing,
body_json=nothing,
is_top_level_path=nothing,
social_image=nothing,
template="contained",
)
- title::String : Title of the page
- slug::String : Used to link to this page in URLs, must be unique and URL-safe
- description::String : For internal use, helps similar pages from one another
- body_markdown::String : The text (in markdown) of the ad (required)
- body_json::String : For JSON pages, the JSON body
- is_top_level_path::Bool : If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution
- social_image::Any
- template::String : Controls what kind of layout the page is rendered in
Forem.APIClient.PagesPostRequest
— Typepagespost_request
PagesPostRequest(;
title=nothing,
slug=nothing,
description=nothing,
body_markdown=nothing,
body_json=nothing,
is_top_level_path=nothing,
template="contained",
)
- title::String : Title of the page
- slug::String : Used to link to this page in URLs, must be unique and URL-safe
- description::String : For internal use, helps similar pages from one another
- body_markdown::String : The text (in markdown) of the ad (required)
- body_json::String : For JSON pages, the JSON body
- is_top_level_path::Bool : If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution
- template::String : Controls what kind of layout the page is rendered in
Forem.APIClient.PodcastEpisodeIndex
— TypePodcastEpisodeIndex Representation of a podcast episode returned in a list
PodcastEpisodeIndex(;
type_of=nothing,
id=nothing,
class_name=nothing,
path=nothing,
title=nothing,
image_url=nothing,
podcast=nothing,
)
- type_of::String
- id::Int64
- class_name::String
- path::String
- title::String
- image_url::String : Podcast episode image url or podcast image url
- podcast::SharedPodcast
Forem.APIClient.ProfileImage
— TypeProfileImage A profile image object
ProfileImage(;
type_of=nothing,
image_of=nothing,
profile_image=nothing,
profile_image_90=nothing,
)
- type_of::String : Return profile_image
- image_of::String : Determines the type of the profile image owner (user or organization)
- profile_image::String : Profile image (640x640)
- profile_image_90::String : Profile image (90x90)
Forem.APIClient.SharedOrganization
— TypeSharedOrganization The organization the resource belongs to
SharedOrganization(;
name=nothing,
username=nothing,
slug=nothing,
profile_image=nothing,
profile_image_90=nothing,
)
- name::String
- username::String
- slug::String
- profile_image::String : Profile image (640x640)
- profile_image_90::String : Profile image (90x90)
Forem.APIClient.SharedPodcast
— TypeSharedPodcast The podcast that the resource belongs to
SharedPodcast(;
title=nothing,
slug=nothing,
image_url=nothing,
)
- title::String
- slug::String
- image_url::String : Podcast image url
Forem.APIClient.SharedUser
— TypeSharedUser The resource creator
SharedUser(;
name=nothing,
username=nothing,
twitter_username=nothing,
github_username=nothing,
website_url=nothing,
profile_image=nothing,
profile_image_90=nothing,
)
- name::String
- username::String
- twitter_username::String
- github_username::String
- website_url::String
- profile_image::String : Profile image (640x640)
- profile_image_90::String : Profile image (90x90)
Forem.APIClient.Tag
— TypeTag Representation of a tag
Tag(;
id=nothing,
name=nothing,
bg_color_hex=nothing,
text_color_hex=nothing,
)
- id::Int64 : Tag id
- name::String
- bg_color_hex::String
- text_color_hex::String
Forem.APIClient.User
— TypeUser The representation of a user
User(;
type_of=nothing,
id=nothing,
username=nothing,
name=nothing,
summary=nothing,
twitter_username=nothing,
github_username=nothing,
website_url=nothing,
location=nothing,
joined_at=nothing,
profile_image=nothing,
)
- type_of::String
- id::Int64
- username::String
- name::String
- summary::String
- twitter_username::String
- github_username::String
- website_url::String
- location::String
- joined_at::String
- profile_image::String
Forem.APIClient.UserInviteParam
— TypeUserInviteParam User invite parameters
UserInviteParam(;
email=nothing,
name=nothing,
)
- email::String
- name::String
Forem.APIClient.VideoArticle
— TypeVideoArticle Representation of an Article with video
VideoArticle(;
type_of=nothing,
id=nothing,
path=nothing,
cloudinary_video_url=nothing,
title=nothing,
user_id=nothing,
video_duration_in_minutes=nothing,
video_source_url=nothing,
user=nothing,
)
- type_of::String
- id::Int64
- path::String
- cloudinary_video_url::String
- title::String
- user_id::Int64
- video_duration_in_minutes::String
- video_source_url::String
- user::VideoArticleUser
Forem.APIClient.VideoArticleUser
— TypeVideoArticle_user Author of the article
VideoArticleUser(;
name=nothing,
)
- name::String
Forem.APIClient.basepath
— MethodThe default API base path for APIs in ArticlesApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in CommentsApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in DisplayAdsApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in FollowedTagsApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in FollowersApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in OrganizationsApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in PagesApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in PodcastEpisodesApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in ProfileImagesApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in ReactionsApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in ReadinglistApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in TagsApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in UsersApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.basepath
— MethodThe default API base path for APIs in VideosApi
. This can be used to construct the OpenAPI.Clients.Client
instance.
Forem.APIClient.create_article
— MethodPublish article
This endpoint allows the client to create a new article. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.
Params:
- article::Article
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.display_ads_get
— Methoddisplay ads
This endpoint allows the client to retrieve a list of all display ads.
Params:
Return: Vector{DisplayAd}, OpenAPI.Clients.ApiResponse
Forem.APIClient.display_ads_id_get
— Methoddisplay ad
This endpoint allows the client to retrieve a single display ad, via its id.
Params:
- id::Int64 (required)
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.display_ads_id_put
— Methoddisplay ads
This endpoint allows the client to update the attributes of a single display ad, via its id.
Params:
- id::Int64 (required)
- display_ad::Vector{DisplayAd}
Return: Vector{DisplayAd}, OpenAPI.Clients.ApiResponse
Forem.APIClient.display_ads_id_unpublish_put
— Methodunpublish
This endpoint allows the client to remove a display ad from rotation by un-publishing it.
Params:
- id::Int64 (required)
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.display_ads_post
— Methoddisplay ads
This endpoint allows the client to create a new display ad.
Params:
- display_ad::Vector{DisplayAd}
Return: Vector{DisplayAd}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_article_by_id
— MethodPublished article by id
This endpoint allows the client to retrieve a single published article given its id
.
Params:
- id::Int64 (required)
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_article_by_path
— MethodPublished article by path
This endpoint allows the client to retrieve a single published article given its path
.
Params:
- username::String (required)
- slug::String (required)
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_articles
— MethodPublished articles
This endpoint allows the client to retrieve a list of articles. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. By default it will return featured, published articles ordered by descending popularity. It supports pagination, each page will contain 30
articles by default.
Params:
- page::Int64
- per_page::Int64
- tag::String
- tags::String
- tags_exclude::String
- username::String
- state::String
- top::Int64
- collection_id::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_comment_by_id
— MethodComment by id
This endpoint allows the client to retrieve a comment as well as his descendants comments. It will return the required comment (the root) with its nested descendants as a thread. See the format specification for further details.
Params:
- id::Int64 (required)
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_comments_by_article_id
— MethodComments
This endpoint allows the client to retrieve all comments belonging to an article or podcast episode as threaded conversations. It will return the all top level comments with their nested comments as threads. See the format specification for further details.
Params:
- a_id::String
- p_id::String
Return: Vector{Comment}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_followed_tags
— MethodFollowed Tags
This endpoint allows the client to retrieve a list of the tags they follow.
Params:
Return: Vector{FollowedTag}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_followed_tags
— MethodFollowed Tags
This endpoint allows the client to retrieve a list of the tags they follow.
Params:
Return: Vector{FollowedTag}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_followers
— MethodFollowers
This endpoint allows the client to retrieve a list of the followers they have. "Followers" are users that are following other users on the website. It supports pagination, each page will contain 80 followers by default.
Params:
- page::Int64
- per_page::Int64
- sort::String
Return: Vector{GetFollowers200ResponseInner}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_latest_articles
— MethodPublished articles sorted by published date
This endpoint allows the client to retrieve a list of articles. ordered by descending publish date. It supports pagination, each page will contain 30 articles by default.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_org_articles
— MethodOrganization's Articles
This endpoint allows the client to retrieve a list of Articles belonging to the organization It supports pagination, each page will contain 30
users by default.
Params:
- username::String (required)
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_org_articles
— MethodOrganization's Articles
This endpoint allows the client to retrieve a list of Articles belonging to the organization It supports pagination, each page will contain 30
users by default.
Params:
- username::String (required)
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_org_users
— MethodOrganization's users
This endpoint allows the client to retrieve a list of users belonging to the organization It supports pagination, each page will contain 30
users by default.
Params:
- username::String (required)
- page::Int64
- per_page::Int64
Return: Vector{User}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_org_users
— MethodOrganization's users
This endpoint allows the client to retrieve a list of users belonging to the organization It supports pagination, each page will contain 30
users by default.
Params:
- username::String (required)
- page::Int64
- per_page::Int64
Return: Vector{User}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_organization
— MethodAn organization
This endpoint allows the client to retrieve a single organization by their username
Params:
- username::String (required)
Return: Vector{Organization}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_podcast_episodes
— MethodPodcast Episodes
This endpoint allows the client to retrieve a list of podcast episodes. "Podcast episodes" are episodes belonging to podcasts. It will only return active (reachable) podcast episodes that belong to published podcasts available on the platform, ordered by descending publication date. It supports pagination, each page will contain 30 articles by default.
Params:
- page::Int64
- per_page::Int64
- username::String
Return: Vector{PodcastEpisodeIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_profile_image
— MethodA Users or organizations profile image
This endpoint allows the client to retrieve a user or organization profile image information by its corresponding username.
Params:
- username::String (required)
Return: Vector{ProfileImage}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_readinglist
— MethodReadinglist
This endpoint allows the client to retrieve a list of articles that were saved to a Users readinglist. It supports pagination, each page will contain 30
articles by default
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_tags
— MethodTags
This endpoint allows the client to retrieve a list of tags that can be used to tag articles. It will return tags ordered by popularity. It supports pagination, each page will contain 10 tags by default.
Params:
- page::Int64
- per_page::Int64
Return: Vector{Tag}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user
— MethodA User
This endpoint allows the client to retrieve a single user, either by id or by the user's username. For complete documentation, see the v0 API docs: https://developers.forem.com/api/v0#tag/users/operation/getUser
Params:
- id::String (required)
Return: Vector{User}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_all_articles
— MethodUser's all articles
This endpoint allows the client to retrieve a list of all articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. It will return both published and unpublished articles with pagination. Unpublished articles will be at the top of the list in reverse chronological creation order. Published articles will follow in reverse chronological publication order. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_all_articles
— MethodUser's all articles
This endpoint allows the client to retrieve a list of all articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. It will return both published and unpublished articles with pagination. Unpublished articles will be at the top of the list in reverse chronological creation order. Published articles will follow in reverse chronological publication order. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_articles
— MethodUser's articles
This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_articles
— MethodUser's articles
This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_me
— MethodThe authenticated user
This endpoint allows the client to retrieve information about the authenticated user
Params:
Return: Vector{User}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_published_articles
— MethodUser's published articles
This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_published_articles
— MethodUser's published articles
This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Published articles will be in reverse chronological publication order. It will return published articles with pagination. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_unpublished_articles
— MethodUser's unpublished articles
This endpoint allows the client to retrieve a list of unpublished articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Unpublished articles will be in reverse chronological creation order. It will return unpublished articles with pagination. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.get_user_unpublished_articles
— MethodUser's unpublished articles
This endpoint allows the client to retrieve a list of unpublished articles on behalf of an authenticated user. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. Unpublished articles will be in reverse chronological creation order. It will return unpublished articles with pagination. By default a page will contain 30 articles.
Params:
- page::Int64
- per_page::Int64
Return: Vector{ArticleIndex}, OpenAPI.Clients.ApiResponse
Forem.APIClient.pages_get
— Methodshow details for all pages
This endpoint allows the client to retrieve details for all Page objects.
Params:
Return: Vector{Page}, OpenAPI.Clients.ApiResponse
Forem.APIClient.pages_id_delete
— Methodremove a page
This endpoint allows the client to delete a single Page object, specified by ID.
Params:
- id::Int64 (required)
Return: Page, OpenAPI.Clients.ApiResponse
Forem.APIClient.pages_id_get
— Methodshow details for a page
This endpoint allows the client to retrieve details for a single Page object, specified by ID.
Params:
- id::Int64 (required)
Return: Page, OpenAPI.Clients.ApiResponse
Forem.APIClient.pages_id_put
— Methodupdate details for a page
This endpoint allows the client to retrieve details for a single Page object, specified by ID.
Params:
- id::Int64 (required)
- page::Page
Return: Page, OpenAPI.Clients.ApiResponse
Forem.APIClient.pages_post
— Methodpages
This endpoint allows the client to create a new page.
Params:
- pagespostrequest::PagesPostRequest
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.post_admin_users_create
— MethodInvite a User
This endpoint allows the client to trigger an invitation to the provided email address. It requires a token from a user with super_admin
privileges.
Params:
- userinviteparam::UserInviteParam
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.reactions_post
— Methodcreate reaction
This endpoint allows the client to create a reaction to a specified reactable (eg, Article, Comment, or User). For examples: * "Like"ing an Article will create a new "like" Reaction from the user for that Articles * "Like"ing that Article a second time will return the previous "like"
Params:
- category::String (required)
- reactable_id::Int64 (required)
- reactable_type::String (required)
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.reactions_toggle_post
— Methodtoggle reaction
This endpoint allows the client to toggle the user's reaction to a specified reactable (eg, Article, Comment, or User). For examples: * "Like"ing an Article will create a new "like" Reaction from the user for that Articles * "Like"ing that Article a second time will remove the "like" from the user
Params:
- category::String (required)
- reactable_id::Int64 (required)
- reactable_type::String (required)
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.suspend_user
— MethodSuspend a User
This endpoint allows the client to suspend a user. The user associated with the API key must have any 'admin' or 'moderator' role. This specified user will be assigned the 'suspended' role. Suspending a user will stop the user from posting new posts and comments. It doesn't delete any of the user's content, just prevents them from creating new content while suspended. Users are not notified of their suspension in the UI, so if you want them to know about this, you must notify them.
Params:
- id::Int64 (required)
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.unpublish_article
— MethodUnpublish an article
This endpoint allows the client to unpublish an article. The user associated with the API key must have any 'admin' or 'moderator' role. The article will be unpublished and will no longer be visible to the public. It will remain in the database and will set back to draft status on the author's posts dashboard. Any notifications associated with the article will be deleted. Any comments on the article will remain.
Params:
- id::Int64 (required)
- note::String
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.unpublish_user
— MethodUnpublish a User's Articles and Comments
This endpoint allows the client to unpublish all of the articles and comments created by a user. The user associated with the API key must have any 'admin' or 'moderator' role. This specified user's articles and comments will be unpublished and will no longer be visible to the public. They will remain in the database and will set back to draft status on the specified user's dashboard. Any notifications associated with the specified user's articles and comments will be deleted. Note this endpoint unpublishes articles and comments asychronously: it will return a 204 NO CONTENT status code immediately, but the articles and comments will not be unpublished until the request is completed on the server.
Params:
- id::Int64 (required)
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.update_article
— MethodUpdate an article by id
This endpoint allows the client to update an existing article. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.
Params:
- id::Int64 (required)
- article::Article
Return: Nothing, OpenAPI.Clients.ApiResponse
Forem.APIClient.videos
— MethodArticles with a video
This endpoint allows the client to retrieve a list of articles that are uploaded with a video. It will only return published video articles ordered by descending popularity. It supports pagination, each page will contain 24 articles by default.
Params:
- page::Int64
- per_page::Int64
Return: Vector{VideoArticle}, OpenAPI.Clients.ApiResponse
Forem.APIClient.videos
— MethodArticles with a video
This endpoint allows the client to retrieve a list of articles that are uploaded with a video. It will only return published video articles ordered by descending popularity. It supports pagination, each page will contain 24 articles by default.
Params:
- page::Int64
- per_page::Int64
Return: Vector{VideoArticle}, OpenAPI.Clients.ApiResponse