FastComments Nim SDK

This is the official Nim SDK for FastComments.

Manage comments, users, SSO, and moderation from your Nim applications.

Repository

Requirements

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installation

Using Nimble

nimble install fastcomments

Building from Source

nimble build

Library Contents

This library contains the generated API client and the SSO utilities to make working with the API easier.

API Client Library Docs

Public vs Secured APIs

For the API client, there are two API modules, api_default and api_public. The api_default contains methods that require your API key, and api_public contains api calls that can be made directly from a browser/mobile device/etc without authentication.

Quick Start

Using Authenticated APIs (DefaultAPI)

Important: Authenticated endpoints require your API key to be set as the x-api-key header.

import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

# Make authenticated API calls
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  page = 0,
  limit = 0,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "your-url-id",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.DESC
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

Using Public APIs (PublicAPI)

Public endpoints don't require authentication:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Make public API calls
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  page = 0,
  direction = SortDirections.DESC,
  sso = "",
  skip = 0,
  skipChildren = 0,
  limit = 0,
  limitChildren = 0,
  countChildren = false,
  fetchPageForCommentId = "",
  includeConfig = false,
  countAll = false,
  includei10n = false,
  locale = "",
  modules = "",
  isCrawler = false,
  includeNotificationCount = false,
  asTree = false,
  maxTreeDepth = 0,
  useFullTranslationIds = false,
  parentId = "",
  searchText = "",
  hashTags = @[],
  userId = "",
  customConfigStr = "",
  afterCommentId = "",
  beforeCommentId = ""
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

Common Issues

401 authentication error: Make sure you set the x-api-key header on your HttpClient before making DefaultAPI requests: client.headers["x-api-key"] = "your-api-key"
Wrong API class: Use api_default for server-side authenticated requests, api_public for client-side/public requests.

Making API Calls

All API methods in this SDK return tuples of (Option[ResponseType], Response). The first element contains the parsed response if successful, and the second element is the raw HTTP response.

Example: Fetching Comments

import httpclient
import options
import fastcomments
import fastcomments/apis/api_default

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  page = 0,
  limit = 0,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "your-url-id",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.DESC
)

if httpResponse.code == Http200:
  if response.isSome:
    let resp = response.get()
    if resp.comments.isSome:
      echo "Found ", resp.comments.get().len, " comments"

Notes

Broadcast Ids

You'll see you're supposed to pass a broadcastId in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client (which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.

SSO (Single Sign-On)

For SSO examples, see below.

SSO Usage

Simple SSO

import fastcomments/sso

let user = newSimpleSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()

echo "SSO Token: ", token

Secure SSO

import fastcomments/sso

let user = newSecureSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  username = "johndoe",
  avatar = "https://example.com/avatar.jpg"
)

let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()

echo "Secure SSO Token: ", token

Documentation for fastcomments

Documentation for API Endpoints

All URIs are relative to https://fastcomments.com

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

aggregate

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parameters

Name	Type	Required
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
parentTenantId	string	No
includeStats	bool	No

Response

Returns: Option[AggregationResponse]

Example

aggregate Example

Copy

let (response, httpResponse) = client.aggregate(
  tenantId = "my-tenant-123",
  aggregationRequest = AggregationRequest(
    groupBy = @["urlPath"],
    filters = @[],
    size = 50
  ),
  parentTenantId = "parent-tenant-456",
  includeStats = true
)
if response.isSome:
  let aggregation = response.get()
  echo "HTTP status: ", $httpResponse.status
  echo "Aggregation result: ", $aggregation

getAuditLogs

Parameters

Name	Type	Required
tenantId	string	Yes
limit	float64	No
skip	float64	No
order	SORTDIR	No
after	float64	No
before	float64	No

Response

Returns: Option[GetAuditLogs_200_response]

Example

getAuditLogs Example

Copy

let (response, httpResponse) = client.getAuditLogs(tenantId = "my-tenant-123", limit = 100.0, skip = 0.0, order = SORTDIR.DESC, after = 1622505600.0, before = 1625097600.0)
if response.isSome:
  let logs = response.get()
  echo logs

blockFromCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string	No

Response

Returns: Option[BlockFromCommentPublic_200_response]

Example

blockFromCommentPublic Example

Copy

let (response, httpResponse) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "news/article-2026-01-12-comment-789",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(
    reason = "harassment",
    durationMinutes = 1440,
    notifyUsers = false,
    tags = @["abuse","spam"]
  ),
  sso = ""
)
if response.isSome:
  let blockResult = response.get()
  discard blockResult

unBlockCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string	No

Response

Returns: Option[UnBlockCommentPublic_200_response]

Example

unBlockCommentPublic Example

Copy

let (response, httpResponse) = client.unBlockCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(reason = "", blockDurationMinutes = 0, notifyUser = false),
  sso = ""
)
if response.isSome:
  let result = response.get()
  discard result

checkedCommentsForBlocked

Parameters

Name	Type	Required
tenantId	string	Yes
commentIds	string	No
sso	string	No

Response

Returns: Option[CheckedCommentsForBlocked_200_response]

Example

checkedCommentsForBlocked Example

Copy

let (response, httpResponse) = client.checkedCommentsForBlocked(tenantId = "my-tenant-123", commentIds = "", sso = "")
if response.isSome:
  let checked = response.get()
  echo "Checked comments for blocked:", checked
else:
  echo "No response received, HTTP status:", httpResponse.status

blockUserFromComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Response

Returns: Option[BlockFromCommentPublic_200_response]

Example

blockUserFromComment Example

Copy

let (response, httpResponse) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "cmt-2026-0001",
  blockFromCommentParams = BlockFromCommentParams(),
  userId = "user-7421",
  anonUserId = "")
if response.isSome:
  let blocked = response.get()
  discard blocked

createCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
sessionId	string	No
sso	string	No

Response

Returns: Option[CreateCommentPublic_200_response]

Example

createCommentPublic Example

Copy

let (response, httpResponse) = client.createCommentPublic(
  tenantId = "my-tenant-123",
  urlId = "news/my-article-2026",
  broadcastId = "",
  commentData = CommentData(),
  sessionId = "",
  sso = ""
)
if response.isSome:
  let created = response.get()
  echo "Comment created: ", $created

deleteComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
contextUserId	string	No
isLive	bool	No

Response

Returns: Option[DeleteComment_200_response]

Example

deleteComment Example

Copy

let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "comment-9876", contextUserId = "user-42", isLive = true)
if response.isSome:
  let deletedComment = response.get()
  discard deletedComment
else:
  echo "Delete failed, status: ", httpResponse.status

deleteCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
editKey	string	No
sso	string	No

Response

Returns: Option[DeleteCommentPublic_200_response]

Example

deleteCommentPublic Example

Copy

let (response, httpResponse) = client.deleteCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let deleted = response.get()
  discard deleted

deleteCommentVote

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
editKey	string	No
sso	string	No

Response

Returns: Option[DeleteCommentVote_200_response]

Example

deleteCommentVote Example

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  voteId = "",
  urlId = "news/top-stories/my-article",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let deleted = response.get()
  echo "DeleteCommentVote succeeded for comment cmt-456"
  discard deleted

flagComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
userId	string	No
anonUserId	string	No

Response

Returns: Option[FlagComment_200_response]

Example

flagComment Example

Copy

let (response, httpResponse) = client.flagComment(tenantId = "my-tenant-123", id = "comment-9876", userId = "", anonUserId = "anon-4f2b9c")
if response.isSome:
  let flagResult = response.get()
  echo "Flag succeeded: ", $flagResult
else:
  echo "Flag failed, HTTP response status: ", $httpResponse.status

getComment

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetComment_200_response]

Example

getComment Example

Copy

let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-987654")
if response.isSome:
  let comment = response.get()
  echo "Comment received:", comment
else:
  echo "No comment found, HTTP status:", httpResponse.status.code

getComments

Parameters

Name	Type	Required
tenantId	string	Yes
page	int	No
limit	int	No
skip	int	No
asTree	bool	No
skipChildren	int	No
limitChildren	int	No
maxTreeDepth	int	No
urlId	string	Yes
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No

Response

Returns: Option[GetComments_200_response]

Example

getComments Example

Copy

let (response, httpResponse) = client.getComments(
  tenantId = "my-tenant-123",
  page = 1,
  limit = 25,
  skip = 0,
  asTree = true,
  skipChildren = 0,
  limitChildren = 5,
  maxTreeDepth = 3,
  urlId = "news/2026/01/important-announcement",
  userId = "user-789",
  anonUserId = "anon-456",
  contextUserId = "ctx-321",
  hashTag = "release",
  parentId = "",
  direction = SortDirections.Newest
)
if response.isSome:
  let comments = response.get()
  echo "Fetched comments for url:", " news/2026/01/important-announcement"

getCommentsPublic

req tenantId urlId

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
page	int	No
direction	SortDirections	No
sso	string	No
skip	int	No
skipChildren	int	No
limit	int	No
limitChildren	int	No
countChildren	bool	No
fetchPageForCommentId	string	No
includeConfig	bool	No
countAll	bool	No
includei10n	bool	No
locale	string	No
modules	string	No
isCrawler	bool	No
includeNotificationCount	bool	No
asTree	bool	No
maxTreeDepth	int	No
useFullTranslationIds	bool	No
parentId	string	No
searchText	string	No
hashTags	seq[string]	No
userId	string	No
customConfigStr	string	No
afterCommentId	string	No
beforeCommentId	string	No

Response

Returns: Option[GetCommentsPublic_200_response]

Example

getCommentsPublic Example

Copy

let (response, httpResponse) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/latest-gear-review",
  page = 1,
  direction = SortDirections.Newest,
  sso = "",
  skip = 0,
  skipChildren = 0,
  limit = 20,
  limitChildren = 0,
  countChildren = false,
  fetchPageForCommentId = "",
  includeConfig = true,
  countAll = false,
  includei10n = false,
  locale = "en-US",
  modules = "reactions,moderation",
  isCrawler = false,
  includeNotificationCount = false,
  asTree = true,
  maxTreeDepth = 3,
  useFullTranslationIds = false,
  parentId = "",
  searchText = "",
  hashTags = @["tech", "review"],
  userId = "user-987",
  customConfigStr = "",
  afterCommentId = "",
  beforeCommentId = ""
)
if response.isSome:
  let comments = response.get()
  echo "Fetched comments:", comments

getCommentText

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
editKey	string	No
sso	string	No

Response

Returns: Option[GetCommentText_200_response]

Example

getCommentText Example

Copy

let (response, httpResponse) = client.getCommentText(tenantId = "my-tenant-123", commentId = "cmt-987654321", editKey = "", sso = "")
if response.isSome:
  let commentText = response.get()
  echo "Comment text: ", commentText
else:
  echo "No comment text returned. HTTP response: ", httpResponse

getCommentVoteUserNames

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
dir	int	No
sso	string	No

Response

Returns: Option[GetCommentVoteUserNames_200_response]

Example

getCommentVoteUserNames Example

Copy

let (response, httpResponse) = client.getCommentVoteUserNames(tenantId = "my-tenant-123", commentId = "cmt-987654", dir = 0, sso = "")
if response.isSome:
  let voteUsers = response.get()

lockComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string	No

Response

Returns: Option[LockComment_200_response]

Example

lockComment Example

Copy

let (response, httpResponse) = client.lockComment(tenantId = "my-tenant-123", commentId = "comment-98765", broadcastId = "", sso = "")
if response.isSome:
  let locked = response.get()
  discard locked
else:
  discard httpResponse

pinComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string	No

Response

Returns: Option[PinComment_200_response]

Example

pinComment Example

Copy

let (response, httpResponse) = client.pinComment(tenantId = "tenant-456", commentId = "cmt-7890", broadcastId = "broadcast-001", sso = "")
if response.isSome:
  let pinResult = response.get()
  discard pinResult

saveComment

Parameters

Name	Type	Required
tenantId	string	Yes
createCommentParams	CreateCommentParams	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool	No

Response

Returns: Option[SaveComment_200_response]

Example

saveComment Example

Copy

let createParams = CreateCommentParams(
  content = "Great article — helped me understand async patterns.",
  authorName = "Alex Morgan",
  authorEmail = "alex.morgan@example.com",
  url = "news/my-company-launches-new-api",
  parentId = "",
  tags = @["api", "launch"]
)
let (response, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = createParams,
  isLive = true,
  doSpamCheck = true,
  sendEmails = false,
  populateNotifications = true
)
if response.isSome:
  let saved = response.get()
  echo "Saved comment id: ", saved.id

saveCommentsBulk

Parameters

Name	Type	Required
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool): (Option[seq[SaveComment_200_response]]	No
id	string	No
fromName	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

saveCommentsBulk Example

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  isLive = false,
  doSpamCheck = false,
  sendEmails = false,
  populateNotifications = false,
  id = "",
  fromName = ""
)
if response.isSome:
  let flagResp = response.get()
  echo "Flag response received: ", $flagResp

setCommentText

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
editKey	string	No
sso	string	No

Response

Returns: Option[SetCommentText_200_response]

Example

setCommentText Example

Copy

let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  broadcastId = "bcast-2026-01",
  commentTextUpdateRequest = CommentTextUpdateRequest(text = "Updated comment text for clarity and formatting"),
  editKey = "",
  sso = ""
)
if response.isSome:
  let updated = response.get()
  echo "Comment updated:", updated
else:
  echo "Update failed, status:", httpResponse.status

unBlockUserFromComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Response

Returns: Option[UnBlockCommentPublic_200_response]

Example

unBlockUserFromComment Example

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "news-site-001",
  id = "cmt-8fj3k9",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-98765",
  anonUserId = ""
)
if response.isSome:
  let unblocked = response.get()
  discard unblocked

unFlagComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
userId	string	No
anonUserId	string	No

Response

Returns: Option[FlagComment_200_response]

Example

unFlagComment Example

Copy

let (response, httpResponse) = client.unFlagComment(
  tenantId = "my-tenant-123",
  id = "comment-9876",
  userId = "user-42",
  anonUserId = ""
)
if response.isSome:
  let flagResp = response.get()
  echo "Unflag succeeded:", flagResp
echo "HTTP response status:", httpResponse.status

unLockComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string	No

Response

Returns: Option[LockComment_200_response]

Example

unLockComment Example

Copy

let (response, httpResponse) = client.unLockComment(tenantId = "my-tenant-123", commentId = "cmt-456789", broadcastId = "", sso = "")
if response.isSome:
  let unlocked = response.get()
  discard unlocked
discard httpResponse

unPinComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string	No

Response

Returns: Option[PinComment_200_response]

Example

unPinComment Example

Copy

let (response, httpResponse) = client.unPinComment(tenantId = "my-tenant-123", commentId = "cmt-987654321", broadcastId = "", sso = "")
if response.isSome:
  let pinInfo = response.get()
  echo "Unpinned comment:", pinInfo
else:
  echo "Failed to unpin, HTTP status:", httpResponse.status

updateComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
contextUserId	string	No
doSpamCheck	bool	No
isLive	bool	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateComment Example

Copy

let (response, httpResponse) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "cmt-456",
  updatableCommentParams = UpdatableCommentParams(
    content: "Updated the comment to clarify the timeline",
    tags: @["clarification", "timeline"],
    isHidden: false
  ),
  contextUserId = "user-789",
  doSpamCheck = true,
  isLive = true
)
if response.isSome:
  let updatedComment = response.get()
  echo "Updated comment received, id: ", updatedComment.id

voteComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
sessionId	string	No
sso	string	No

Response

Returns: Option[VoteComment_200_response]

Example

voteComment Example

Copy

let voteBody = VoteBodyParams(vote = 1)
let (response, httpResponse) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  urlId = "news/article-2026-election",
  broadcastId = "",
  voteBodyParams = voteBody,
  sessionId = "",
  sso = ""
)
if response.isSome:
  let result = response.get()
  echo "Vote response:", $result

addDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

Response

Returns: Option[AddDomainConfig_200_response]

Example

addDomainConfig Example

Copy

let addParams = AddDomainConfigParams(
  domain = "news.example.com",
  enabled = true,
  allowSubdomains = false,
  paths = @["/articles", "/breaking"],
  priority = 10,
  description = "Primary domain for news site"
)
let (response, httpResponse) = client.addDomainConfig(tenantId = "my-tenant-123", addDomainConfigParams = addParams)
if response.isSome:
  let cfg = response.get()
  echo "Added domain config:", cfg

deleteDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
domain	string	No

Response

Returns: Option[DeleteDomainConfig_200_response]

Example

deleteDomainConfig Example

Copy

let (response, httpResponse) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let deletedConfig = response.get()
  echo deletedConfig
else:
  echo "No domain config returned"

getDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
domain	string	No

Response

Returns: Option[GetDomainConfig_200_response]

Example

getDomainConfig Example

Copy

let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let config = response.get()
  echo "Domain config received"
else:
  echo "No domain config available"

getDomainConfigs

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: Option[GetDomainConfigs_200_response]

Example

getDomainConfigs Example

Copy

let (response, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if response.isSome:
  let domainConfigs = response.get()
  echo "Received domain configs for tenant:", domainConfigs
else:
  echo "No domain configs returned, HTTP status:", httpResponse.status.code

patchDomainConfig

Parameters

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Response

Returns: Option[GetDomainConfig_200_response]

Example

patchDomainConfig Example

Copy

let patchParams = PatchDomainConfigParams(
  domainName: "comments.mynews.com",
  enableModeration: true,
  allowedOrigins: @["https://www.mynews.com", "https://editor.mynews.com"]
)
let (response, httpResponse) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news/article-title",
  patchDomainConfigParams = patchParams
)
if response.isSome:
  let updated = response.get()
  echo "Updated domain config for: ", updated.domainName

putDomainConfig

Parameters

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

Response

Returns: Option[GetDomainConfig_200_response]

Example

putDomainConfig Example

Copy

let (response, httpResponse) = client.putDomainConfig(tenantId = "my-tenant-123", domainToUpdate = "news.example.com", updateDomainConfigParams = default(UpdateDomainConfigParams))
if response.isSome:
  let updatedConfig = response.get()
  echo "Domain config updated for tenant my-tenant-123:", updatedConfig
else:
  echo "Failed to update domain config, HTTP status: ", httpResponse.status

createEmailTemplate

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

Response

Returns: Option[CreateEmailTemplate_200_response]

Example

createEmailTemplate Example

Copy

let (response, httpResponse) = client.createEmailTemplate(tenantId = "my-tenant-123", createEmailTemplateBody = CreateEmailTemplateBody(name = "Weekly Newsletter", subject = "Weekly updates from OurSite", fromName = "OurSite Team", fromEmail = "newsletter@oursite.com", bodyHtml = "<h1>Highlights</h1><p>Top stories this week...</p>", enabled = true, tags = @["newsletter", "weekly"]))
if response.isSome:
  let template = response.get()
  discard template

deleteEmailTemplate

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteEmailTemplate Example

Copy

let (response, httpResponse) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "tmpl-456")
if response.isSome:
  let deleted = response.get()
  echo deleted

deleteEmailTemplateRenderError

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
errorId	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteEmailTemplateRenderError Example

Copy

let (response, httpResponse) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email-template",
  errorId = "render-error-2026"
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

getEmailTemplate

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetEmailTemplate_200_response]

Example

getEmailTemplate Example

Copy

let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email-01")
if response.isSome:
  let template = response.get()
  echo "Template ID: ", template.id
  echo "Subject: ", template.subject
  echo "Body: ", template.body

getEmailTemplateDefinitions

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: Option[GetEmailTemplateDefinitions_200_response]

Example

getEmailTemplateDefinitions Example

Copy

let (response, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if response.isSome:
  let defs = response.get()
  echo "Received email template definitions for tenant my-tenant-123"
else:
  echo "No template definitions returned; HTTP status: ", httpResponse.status

getEmailTemplateRenderErrors

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
skip	float64	No

Response

Returns: Option[GetEmailTemplateRenderErrors_200_response]

Example

getEmailTemplateRenderErrors Example

Copy

let (response, httpResponse) = client.getEmailTemplateRenderErrors(tenantId = "my-tenant-123", id = "welcome-email-template-001", skip = 0.0)
if response.isSome:
  let result = response.get()
  echo "Render errors:", result
else:
  echo "No render errors or request failed. HTTP status:", httpResponse.status

getEmailTemplates

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Response

Returns: Option[GetEmailTemplates_200_response]

Example

getEmailTemplates Example

Copy

let (response, httpResponse) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let templates = response.get()
  echo templates
else:
  echo "No templates returned"

renderEmailTemplate

Parameters

Name	Type	Required
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string	No

Response

Returns: Option[RenderEmailTemplate_200_response]

Example

renderEmailTemplate Example

Copy

let renderBody = RenderEmailTemplateBody(templateId: "comment-notification", subject: "New comment on your article", variables: @["John Doe", "news/global-climate"])
let (response, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = renderBody, locale = "en-US")
if response.isSome:
  let rendered = response.get()
  echo rendered

updateEmailTemplate

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateEmailTemplate Example

Copy

let updateBody = UpdateEmailTemplateBody(
  name = "Welcome Email",
  subject = "Welcome to Example News",
  html = "<p>Hi {name}, welcome to Example News.</p>",
  isActive = true,
  tags = @["onboarding", "welcome"]
)
let (response, httpResponse) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-template-2026",
  updateEmailTemplateBody = updateBody
)
if response.isSome:
  let template = response.get()
  discard template

getEventLog

req tenantId urlId userIdWS

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Response

Returns: Option[GetEventLog_200_response]

Example

getEventLog Example

Copy

let (response, httpResponse) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64
)
if response.isSome:
  let eventLog = response.get()
  echo "Event log retrieved for news/article-title"
  discard eventLog
else:
  echo "Failed to retrieve event log, status: ", httpResponse.status

getGlobalEventLog

req tenantId urlId userIdWS

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Response

Returns: Option[GetEventLog_200_response]

Example

getGlobalEventLog Example

Copy

let (response, httpResponse) = client.getGlobalEventLog(tenantId = "my-tenant-123",
  urlId = "news/how-ai-is-changing",
  userIdWS = "",
  startTime = int64(0),
  endTime = int64(0))
if response.isSome:
  let eventLog = response.get()
  echo "Event log received:"
  echo eventLog
else:
  echo "No event log; http response:"
  echo httpResponse

createFeedPost

Parameters

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
isLive	bool	No
doSpamCheck	bool	No
skipDupCheck	bool	No

Response

Returns: Option[CreateFeedPost_200_response]

Example

createFeedPost Example

Copy

let (response, httpResponse) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(
    title = "Breaking: Major Storm Hits City",
    content = "A severe storm caused widespread outages and travel delays across the metro area.",
    authorId = "author-789",
    url = "news/major-storm",
    tags = @["weather", "breaking"],
    attachments = @[]
  ),
  broadcastId = "",
  isLive = false,
  doSpamCheck = false,
  skipDupCheck = false
)
if response.isSome:
  let created = response.get()
  echo "Feed post created:", created

createFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
sso	string	No

Response

Returns: Option[CreateFeedPostPublic_200_response]

Example

createFeedPostPublic Example

Copy

let params = CreateFeedPostParams(
  title: "Local Elections Update",
  content: "Final results will be posted after polls close at 8pm.",
  authorId: "reporter-789",
  tags: @["politics", "local"],
  isPublic: true
)
let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = params,
  broadcastId = "bcast-456",
  sso = "sso-token-abc"
)
if response.isSome:
  let created = response.get()
  echo "created post id: ", created.id
else:
  echo "request failed, status: ", httpResponse.status

deleteFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postId	string	No
broadcastId	string	No
sso	string	No

Response

Returns: Option[DeleteFeedPostPublic_200_response]

Example

deleteFeedPostPublic Example

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(tenantId = "my-tenant-123", postId = "", broadcastId = "", sso = "")
if response.isSome:
  let deleted = response.get()
  discard deleted
else:
  discard httpResponse

getFeedPosts

req tenantId afterId

Parameters

Name	Type	Required
tenantId	string	Yes
afterId	string	No
limit	int	No
tags	seq[string]	No

Response

Returns: Option[GetFeedPosts_200_response]

Example

getFeedPosts Example

Copy

let (response, httpResponse) = client.getFeedPosts(
  tenantId = "my-tenant-123",
  afterId = "",
  limit = 0,
  tags = @[]
)
if response.isSome:
  let feed = response.get()
  discard feed

getFeedPostsPublic

req tenantId afterId

Parameters

Name	Type	Required
tenantId	string	Yes
afterId	string	No
limit	int	No
tags	seq[string]	No
sso	string	No
isCrawler	bool	No
includeUserInfo	bool	No

Response

Returns: Option[GetFeedPostsPublic_200_response]

Example

getFeedPostsPublic Example

Copy

let (response, httpResponse) = client.getFeedPostsPublic(
  tenantId = "my-tenant-123",
  afterId = "",
  limit = 0,
  tags = @[],
  sso = "",
  isCrawler = false,
  includeUserInfo = false
)
if response.isSome:
  let feed = response.get()
  echo "Retrieved feed posts"
else:
  echo "No feed posts returned"

getFeedPostsStats

Parameters

Name	Type	Required
tenantId	string	Yes
postIds	seq[string]	No
sso	string	No

Response

Returns: Option[GetFeedPostsStats_200_response]

Example

getFeedPostsStats Example

Copy

let (response, httpResponse) = client.getFeedPostsStats(tenantId = "my-tenant-123", postIds = @["news/article-456", "blog/post-789"], sso = "user-abc-sso-token")
if response.isSome:
  let stats = response.get()
  echo "Received feed posts stats: ", stats
else:
  echo "No feed posts stats returned"

getUserReactsPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postIds	seq[string]	No
sso	string	No

Response

Returns: Option[GetUserReactsPublic_200_response]

Example

getUserReactsPublic Example

Copy

let (response, httpResponse) = client.getUserReactsPublic(tenantId = "my-tenant-123", postIds = @["post-987", "post-654"], sso = "sso-token-abc123")
if response.isSome:
  let reacts = response.get()
  echo "Received reacts:", repr(reacts)
else:
  echo "No reacts returned, HTTP status:", $httpResponse.status

reactFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
isUndo	bool	No
broadcastId	string	No
sso	string	No

Response

Returns: Option[ReactFeedPostPublic_200_response]

Example

reactFeedPostPublic Example

Copy

let (response, httpResponse) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/international-earthquake-2026",
  reactBodyParams = default(ReactBodyParams),
  isUndo = false,
  broadcastId = "broadcast-789",
  sso = ""
)
if response.isSome:
  let reactResult = response.get()
  discard reactResult

updateFeedPost

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateFeedPost Example

Copy

let (response, httpResponse) = client.updateFeedPost(
  tenantId = "my-tenant-123",
  id = "post-456",
  feedPost = FeedPost(
    id = "post-456",
    title = "Breaking News: Market Rally",
    content = "Stocks surged 5% after the Fed announcement; analysts cite renewed investor confidence.",
    published = true,
    tags = @["finance", "markets"]
  )
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

updateFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
broadcastId	string	No
sso	string	No

Response

Returns: Option[CreateFeedPostPublic_200_response]

Example

updateFeedPostPublic Example

Copy

let updateParams = UpdateFeedPostParams(
  title = "Launch: FastComments v2.0",
  content = "Announcing the v2.0 release with performance and moderation improvements.",
  visible = true,
  tags = @["release", "announcement"],
  priority = 1
)
let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/launch-fastcomments-v2",
  updateFeedPostParams = updateParams,
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let updated = response.get()
  echo "Feed post updated successfully"

flagCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
isFlagged	bool	No
sso	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

flagCommentPublic Example

Copy

let (response, httpResponse) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  isFlagged = false,
  sso = ""
)
if response.isSome:
  let flagged = response.get()
  discard flagged

addHashTag

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

Response

Returns: Option[AddHashTag_200_response]

Example

addHashTag Example

Copy

let createBody = CreateHashTagBody(
  name = "sports",
  description = "Articles and discussions about sports",
  aliases = @["sport", "athletics"],
  isActive = true
)
let (response, httpResponse) = client.addHashTag(tenantId = "my-tenant-123", createHashTagBody = createBody)
if response.isSome:
  let added = response.get()
  echo "HashTag added successfully"
else:
  echo "Failed to add HashTag"

addHashTagsBulk

Parameters

Name	Type	Required	Description
tenantId	string	Yes
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Response

Returns: Option[AddHashTagsBulk_200_response]

Example

addHashTagsBulk Example

Copy

let bulkBody = BulkCreateHashTagsBody(
  tags = @["breaking", "world-news", "economy"],
  createdBy = "editor@dailynews.com",
  replaceExisting = false
)
let (response, httpResponse) = client.addHashTagsBulk(tenantId = "newsroom-tenant-42", bulkCreateHashTagsBody = bulkBody)
if response.isSome:
  let created = response.get()
  echo created
else:
  echo "AddHashTagsBulk failed:", httpResponse

deleteHashTag

Parameters

Name	Type	Required
tag	string	No
tenantId	string	Yes
deleteHashTagRequest	DeleteHashTagRequest	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteHashTag Example

Copy

let (response, httpResponse) = client.deleteHashTag(tag = "breaking-news", tenantId = "my-tenant-123", deleteHashTagRequest = DeleteHashTagRequest())
if response.isSome:
  let result = response.get()
  discard result

getHashTags

Parameters

Name	Type	Required	Description
tenantId	string	Yes
page	float64	No

Response

Returns: Option[GetHashTags_200_response]

Example

getHashTags Example

Copy

let (response, httpResponse) = client.getHashTags(tenantId = "my-tenant-123", page = 1.0)
if response.isSome:
  let tags = response.get()
  for t in tags:
    echo t
else:
  echo "no hashtags found"

patchHashTag

Parameters

Name	Type	Required
tag	string	No
tenantId	string	Yes
updateHashTagBody	UpdateHashTagBody	No

Response

Returns: Option[PatchHashTag_200_response]

Example

patchHashTag Example

Copy

let (response, httpResponse) = client.patchHashTag(tag = "politics", tenantId = "my-tenant-123", updateHashTagBody = UpdateHashTagBody())
if response.isSome:
  let updated = response.get()
  echo "Hashtag updated successfully"
else:
  echo "Failed to update hashtag, status:", httpResponse.status

createModerator

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	No

Response

Returns: Option[CreateModerator_200_response]

Example

createModerator Example

Copy

let createBody = CreateModeratorBody(
  email = "moderator@news-site.com",
  displayName = "News Moderator",
  permissions = @["approve_comments", "delete_comments"],
  isSuperAdmin = false
)
let (response, httpResponse) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = createBody)
if response.isSome:
  let moderator = response.get()
  echo "Created moderator: ", $moderator

deleteModerator

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
sendEmail	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteModerator Example

Copy

let (response, httpResponse) = client.deleteModerator(tenantId = "my-tenant-123", id = "moderator-456", sendEmail = "false")
if response.isSome:
  let flagResp = response.get()
  echo "Moderator deletion response: ", $flagResp
else:
  echo "No response body; HTTP status: ", $httpResponse.status

getModerator

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetModerator_200_response]

Example

getModerator Example

Copy

let (response, httpResponse) = client.getModerator(tenantId = "my-tenant-123", id = "mod-98765")
if response.isSome:
  let moderator = response.get()
  discard moderator

getModerators

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Response

Returns: Option[GetModerators_200_response]

Example

getModerators Example

Copy

let (response, httpResponse) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let moderators = response.get()
  echo "Moderators fetched successfully"
  echo moderators

updateModerator

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateModerator Example

Copy

let updateBody = UpdateModeratorBody(
  name: "Alicia Gomez",
  email: "alicia.gomez@dailynews.com",
  active: true,
  roles: @["moderator"]
)
let (response, httpResponse) = client.updateModerator(tenantId = "my-tenant-123", id = "moderator-789", updateModeratorBody = updateBody)
if response.isSome:
  let updated = response.get()
  echo "Moderator updated:", updated

deleteNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteNotificationCount Example

Copy

let (response, httpResponse) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if response.isSome:
  let deleted = response.get()
  echo "Deleted notification count:", deleted
else:
  echo "No response body; HTTP response:", httpResponse

getCachedNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetCachedNotificationCount_200_response]

Example

getCachedNotificationCount Example

Copy

let (response, httpResponse) = client.getCachedNotificationCount(tenantId = "my-tenant-123", id = "notif-thread-2026")
if response.isSome:
  let cached = response.get()
  echo "Cached notification count: ", $cached

getNotificationCount

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
urlId	string	Yes
fromCommentId	string	No
viewed	bool	No

Response

Returns: Option[GetNotificationCount_200_response]

Example

getNotificationCount Example

Copy

let (response, httpResponse) = client.getNotificationCount(
  tenantId = "acme-corp-tenant-12",
  userId = "user-84",
  urlId = "news/2026/market-update",
  fromCommentId = "cmt-20251234",
  viewed = false
)
if response.isSome:
  let notificationData = response.get()
  echo "Received notification data"
else:
  echo "No notification data"

getNotifications

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
urlId	string	Yes
fromCommentId	string	No
viewed	bool	No
skip	float64	No

Response

Returns: Option[GetNotifications_200_response]

Example

getNotifications Example

Copy

let (response, httpResponse) = client.getNotifications(
  tenantId = "fastcomments-tenant-42",
  userId = "",
  urlId = "news/latest-tech-innovations",
  fromCommentId = "",
  viewed = false,
  skip = 0.0
)
if response.isSome:
  let notifications = response.get()
  echo "Received notifications: ", notifications
else:
  echo "No notifications, response: ", httpResponse

updateNotification

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateNotification Example

Copy

let (response, httpResponse) = client.updateNotification(tenantId = "my-tenant-123",
  id = "notif-456",
  updateNotificationBody = UpdateNotificationBody(),
  userId = "user-789")
if response.isSome:
  let updated = response.get()
  echo "Updated notification id: ", $updated

addPage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

Response

Returns: Option[AddPageAPIResponse]

Example

addPage Example

Copy

let createData = CreateAPIPageData(path = "news/2026/market-update", title = "Market Update — Jan 2026", tags = @["finance", "markets"], isPublished = true)
let (response, httpResponse) = client.addPage(tenantId = "my-tenant-123", createAPIPageData = createData)
if response.isSome:
  let page = response.get()
  discard page

deletePage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[DeletePageAPIResponse]

Example

deletePage Example

Copy

let (response, httpResponse) = client.deletePage(tenantId = "my-tenant-123", id = "news/article-title")
if response.isSome:
  let deleted = response.get()
  echo deleted
else:
  echo "Deletion failed or no response body"

getPageByURLId

Parameters

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Response

Returns: Option[GetPageByURLIdAPIResponse]

Example

getPageByURLId Example

Copy

let (response, httpResponse) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title-2026")
if response.isSome:
  let page = response.get()
  echo "Page retrieved: ", $page
else:
  echo "Page not found, HTTP status: ", $httpResponse.status

getPages

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: Option[GetPagesAPIResponse]

Example

getPages Example

Copy

let (response, httpResponse) = client.getPages(tenantId = "my-tenant-123")
if response.isSome:
  let pages = response.get()
  echo "Pages received for tenant my-tenant-123"
  echo pages
else:
  echo "No pages found, HTTP status: ", $httpResponse.status

patchPage

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Response

Returns: Option[PatchPageAPIResponse]

Example

patchPage Example

Copy

let updateData = UpdateAPIPageData(
  title = "Main St Reopens After Repairs",
  path = "news/main-st-reopens",
  description = "Main Street reopened to traffic following overnight repairs",
  isEnabled = true,
  tags = @["local", "infrastructure"]
)
let (response, httpResponse) = client.patchPage(tenantId = "my-tenant-123", id = "page-456", updateAPIPageData = updateData)
if response.isSome:
  let page = response.get()
  echo "Patched page:", $page
else:
  echo "Patch failed, HTTP status: ", httpResponse.status

deletePendingWebhookEvent

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deletePendingWebhookEvent Example

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "wh_evt_6f1e3b2a")
if response.isSome:
  let flagResp = response.get()
  discard flagResp

getPendingWebhookEventCount

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No

Response

Returns: Option[GetPendingWebhookEventCount_200_response]

Example

getPendingWebhookEventCount Example

Copy

let (response, httpResponse) = client.getPendingWebhookEventCount(
  tenantId = "my-tenant-123",
  commentId = "cmt-4567",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0
)
if response.isSome:
  let pending = response.get()
  echo "Received pending webhook event count response: ", $pending
else:
  echo "No pending webhook event count returned, HTTP response: ", $httpResponse

getPendingWebhookEvents

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No
skip	float64	No

Response

Returns: Option[GetPendingWebhookEvents_200_response]

Example

getPendingWebhookEvents Example

Copy

let (response, httpResponse) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0,
  skip = 0.0
)
if response.isSome:
  let pending = response.get()
  discard pending
  echo "Received pending webhook events"
else:
  echo "No pending webhook events"

createQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	No

Response

Returns: Option[CreateQuestionConfig_200_response]

Example

createQuestionConfig Example

Copy

let body = CreateQuestionConfigBody(
  key = "recommendation",
  question = "Would you recommend this article to a friend?",
  required = false,
  inputType = "radio",
  options = @["Yes", "No", "Maybe"]
)
let (response, httpResponse) = client.createQuestionConfig(tenantId = "my-tenant-123", createQuestionConfigBody = body)
if response.isSome:
  let config = response.get()
  discard config

deleteQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteQuestionConfig Example

Copy

let (response, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-456")
if response.isSome:
  let respVal = response.get()
  echo "Delete succeeded for tenant my-tenant-123"
else:
  echo "Delete returned no data (status: ", $httpResponse.status, ")"

getQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetQuestionConfig_200_response]

Example

getQuestionConfig Example

Copy

let (response, httpResponse) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-98765")
if response.isSome:
  let config = response.get()
  echo "Received question config for tenant:", " my-tenant-123"

getQuestionConfigs

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Response

Returns: Option[GetQuestionConfigs_200_response]

Example

getQuestionConfigs Example

Copy

let (response, httpResponse) = client.getQuestionConfigs(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let configs = response.get()
  discard configs

updateQuestionConfig

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateQuestionConfig Example

Copy

let (response, httpResponse) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "q-config-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if response.isSome:
  let updated = response.get()
  discard updated
  echo "Question config updated"
else:
  echo "Update did not return a result"

createQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	No

Response

Returns: Option[CreateQuestionResult_200_response]

Example

createQuestionResult Example

Copy

let (response, httpResponse) = client.createQuestionResult(tenantId = "my-tenant-123",
  createQuestionResultBody = CreateQuestionResultBody(questionId: "q-456",
    userId: "user-789",
    correct: true,
    score: 9,
    answers: @["B", "D"]))
if response.isSome:
  let result = response.get()
  echo result

deleteQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteQuestionResult Example

Copy

let (response, httpResponse) = client.deleteQuestionResult(tenantId = "my-tenant-123", id = "question-result-789")
if response.isSome:
  let result = response.get()
  echo "Deleted question result:", result
else:
  echo "No result returned, HTTP status:", $httpResponse.status

getQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetQuestionResult_200_response]

Example

getQuestionResult Example

Copy

let (response, httpResponse) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if response.isSome:
  let result = response.get()
  echo "Received question result:"
  echo result
else:
  echo "No question result returned"

getQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	float64	No

Response

Returns: Option[GetQuestionResults_200_response]

Example

getQuestionResults Example

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userId = "user-9876",
  startDate = "2024-01-01T00:00:00Z",
  questionId = "q-user-satisfaction",
  questionIds = "q-user-satisfaction,q-engagement",
  skip = 0.0
)
if response.isSome:
  let results = response.get()
  echo "Got question results: ", $results
else:
  echo "No results, HTTP status: ", httpResponse.status

updateQuestionResult

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateQuestionResult Example

Copy

let (response, httpResponse) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody(
    result = "approved",
    reviewerId = "moderator-42",
    notes = "Valid question, no action required",
    isSpam = false
  )
)
if response.isSome:
  let flagResponse = response.get()
  discard flagResponse

aggregateQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
questionId	string	No
questionIds	seq[string]	No
urlId	string	Yes
timeBucket	AggregateTimeBucket	No
startDate	string	No
forceRecalculate	bool	No

Response

Returns: Option[AggregateQuestionResults_200_response]

Example

aggregateQuestionResults Example

Copy

let (response, httpResponse) = client.aggregateQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "q-42",
  questionIds = @["q-42", "q-43"],
  urlId = "news/article-latest-updates",
  timeBucket = AggregateTimeBucket.daily,
  startDate = "2025-01-01T00:00:00Z",
  forceRecalculate = false
)
if response.isSome:
  let aggregated = response.get()
  discard aggregated

bulkAggregateQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Response

Returns: Option[BulkAggregateQuestionResults_200_response]

Example

bulkAggregateQuestionResults Example

Copy

let request = BulkAggregateQuestionResultsRequest(questionIds = @["question-123", "question-456"], startDate = "2025-01-01", endDate = "2025-01-31")
let (response, httpResponse) = client.bulkAggregateQuestionResults(tenantId = "my-tenant-123", bulkAggregateQuestionResultsRequest = request, forceRecalculate = false)
if response.isSome:
  let results = response.get()
  discard results

combineCommentsWithQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
questionId	string	No
questionIds	seq[string]	No
urlId	string	Yes
startDate	string	No
forceRecalculate	bool	No
minValue	float64	No
maxValue	float64	No
limit	float64	No

Response

Returns: Option[CombineCommentsWithQuestionResults_200_response]

Example

combineCommentsWithQuestionResults Example

Copy

let (response, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "",
  questionIds = @[],
  urlId = "news/earthquake-2026-10-05",
  startDate = "",
  forceRecalculate = false,
  minValue = 0.0,
  maxValue = 0.0,
  limit = 0.0
)
if response.isSome:
  let result = response.get()
  discard result

addSSOUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	No

Response

Returns: Option[AddSSOUserAPIResponse]

Example

addSSOUser Example

Copy

let createData = CreateAPISSOUserData(
  id = "user-789",
  email = "jane.doe@example.com",
  username = "jane.doe",
  displayName = "Jane Doe",
  roles = @["author", "editor"],
  avatarUrl = "https://cdn.example.com/avatars/jane.jpg",
  metadata = @[],
  isActive = true
)
let (response, httpResponse) = client.addSSOUser(tenantId = "my-tenant-123", createAPISSOUserData = createData)
if response.isSome:
  let result = response.get()
  echo "SSO user added: ", result.id
else:
  echo "Failed to add SSO user, HTTP status: ", httpResponse.status.code

deleteSSOUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
deleteComments	bool	No
commentDeleteMode	string	No

Response

Returns: Option[DeleteSSOUserAPIResponse]

Example

deleteSSOUser Example

Copy

let (response, httpResponse) = client.deleteSSOUser(
  tenantId = "my-tenant-123",
  id = "user-7f3b9c",
  deleteComments = true,
  commentDeleteMode = "soft"
)
if response.isSome:
  let apiResult = response.get()
  echo "SSO user deleted successfully"
  discard apiResult

getSSOUserByEmail

Parameters

Name	Type	Required	Description
tenantId	string	Yes
email	string	No

Response

Returns: Option[GetSSOUserByEmailAPIResponse]

Example

getSSOUserByEmail Example

Copy

let (response, httpResponse) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "jane.doe@newsorg.com")
if response.isSome:
  let ssoUser = response.get()
  echo "SSO user retrieved for tenant my-tenant-123"
else:
  echo "SSO user not found"

getSSOUserById

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetSSOUserByIdAPIResponse]

Example

getSSOUserById Example

Copy

let (response, httpResponse) = client.getSSOUserById(tenantId = "my-tenant-123", id = "sso-user-456")
if response.isSome:
  let user = response.get()
  echo "Fetched SSO user:"
  echo user

getSSOUsers

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	int	No

Response

Returns: Option[GetSSOUsers_200_response]

Example

getSSOUsers Example

Copy

let (response, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if response.isSome:
  let ssoUsers = response.get()
  echo ssoUsers

patchSSOUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Response

Returns: Option[PatchSSOUserAPIResponse]

Example

patchSSOUser Example

Copy

let updateData: UpdateAPISSOUserData = UpdateAPISSOUserData(
  name = "Alice Johnson",
  email = "alice.johnson@newsorg.com",
  externalId = "user-789",
  roles = @["subscriber"],
  avatarUrl = "https://cdn.newsorg.com/avatars/user-789.png"
)
let (response, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = updateData,
  updateComments = true
)
if response.isSome:
  let patched = response.get()
  echo patched, " ", httpResponse.statusCode

putSSOUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Response

Returns: Option[PutSSOUserAPIResponse]

Example

putSSOUser Example

Copy

let updateData = UpdateAPISSOUserData(
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: @["editor"],
  avatarUrl: "https://cdn.example.com/avatars/jane.jpg"
)
let (response, httpResponse) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = updateData,
  updateComments = true
)
if response.isSome:
  let updatedUser = response.get()
  discard updatedUser

createSubscription

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Response

Returns: Option[CreateSubscriptionAPIResponse]

Example

createSubscription Example

Copy

let (response, httpResponse) = client.createSubscription(tenantId = "my-tenant-123", createAPIUserSubscriptionData = CreateAPIUserSubscriptionData(userId = "user-789", email = "jane.doe@example.com", subscriptionType = "thread", topics = @["news", "world"], active = true))
if response.isSome:
  let created = response.get()
  echo "Subscription created for user: ", created.userId

deleteSubscription

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
userId	string	No

Response

Returns: Option[DeleteSubscriptionAPIResponse]

Example

deleteSubscription Example

Copy

let (response, httpResponse) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-98765",
  userId = ""
)
if response.isSome:
  let deleted = response.get()
  echo "Deleted subscription:", $deleted
else:
  echo "Failed to delete subscription, HTTP status:", httpResponse.status

getSubscriptions

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	No

Response

Returns: Option[GetSubscriptionsAPIResponse]

Example

getSubscriptions Example

Copy

let (response, httpResponse) = client.getSubscriptions(tenantId = "my-tenant-123", userId = "")
if response.isSome:
  let subscriptions = response.get()
  discard subscriptions

updateSubscription

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string	No

Response

Returns: Option[UpdateSubscriptionAPIResponse]

Example

updateSubscription Example

Copy

let (response, httpResponse) = client.updateSubscription(
  tenantId = "my-tenant-123",
  id = "sub-456",
  updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(
    subscribed = true,
    channels = @["email", "push"]
  ),
  userId = "user-789"
)
if response.isSome:
  let updated = response.get()
  echo "Subscription updated:", updated
else:
  echo "Update failed, HTTP response:", httpResponse

getTenantDailyUsages

Parameters

Name	Type	Required
tenantId	string	Yes
yearNumber	float64	No
monthNumber	float64	No
dayNumber	float64	No
skip	float64	No

Response

Returns: Option[GetTenantDailyUsages_200_response]

Example

getTenantDailyUsages Example

Copy

let (response, httpResponse) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  yearNumber = 2025.0,
  monthNumber = 6.0,
  dayNumber = 15.0,
  skip = 0.0
)
if response.isSome:
  let usages = response.get()
  echo usages
else:
  echo "No daily usages returned"

createTenantPackage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	No

Response

Returns: Option[CreateTenantPackage_200_response]

Example

createTenantPackage Example

Copy

let packageBody = CreateTenantPackageBody(
  packageName = "premium-comments",
  description = "Premium moderation package for news site",
  planId = "plan-pro-2024",
  seats = 100,
  enabled = true,
  features = @["moderation", "analytics", "sentiment"]
)
let (response, httpResponse) = client.createTenantPackage(tenantId = "my-tenant-123", createTenantPackageBody = packageBody)
if response.isSome:
  let pkg = response.get()
  echo "Created package ID: ", pkg.packageId
  echo "Package name: ", pkg.packageName
else:
  echo "Failed to create package, HTTP status: ", httpResponse.status.code

deleteTenantPackage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteTenantPackage Example

Copy

let (response, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-789")
if response.isSome:
  let deleted = response.get()
  echo "Successfully deleted tenant package"

getTenantPackage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetTenantPackage_200_response]

Example

getTenantPackage Example

Copy

let (response, httpResponse) = client.getTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium-001")
if response.isSome:
  let pkg = response.get()
  echo pkg
else:
  echo "No package found for tenant"

getTenantPackages

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Response

Returns: Option[GetTenantPackages_200_response]

Example

getTenantPackages Example

Copy

let (response, httpResponse) = client.getTenantPackages(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let packages = response.get()
  echo "Received packages for tenant:", " my-tenant-123"
  echo packages
else:
  echo "No packages found, status:", httpResponse.status

replaceTenantPackage

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

replaceTenantPackage Example

Copy

let replaceBody = ReplaceTenantPackageBody(
  packageName = "Community Pro",
  seats = 500,
  enableModeration = true,
  features = @["moderation", "analytics", "single-sign-on"]
)
let (response, httpResponse) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "community-pro",
  replaceTenantPackageBody = replaceBody
)
if response.isSome:
  let flagResp = response.get()
  echo "Package replaced for tenant: ", "my-tenant-123"
  discard flagResp

updateTenantPackage

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateTenantPackage Example

Copy

let (response, httpResponse) = client.updateTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium", updateTenantPackageBody = UpdateTenantPackageBody())
if response.isSome:
  let updated = response.get()
  echo "Updated package received:", updated
else:
  echo "Update failed, HTTP status: ", httpResponse.status

createTenantUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

Response

Returns: Option[CreateTenantUser_200_response]

Example

createTenantUser Example

Copy

let createBody = CreateTenantUserBody(
  email = "jane.doe@acmepub.com",
  displayName = "Jane Doe",
  password = "S3cur3P@ssw0rd",
  roles = @["moderator", "editor"],
  disabled = false
)
let (response, httpResponse) = client.createTenantUser(tenantId = "my-tenant-123", createTenantUserBody = createBody)
if response.isSome:
  let createdUser = response.get()
  echo createdUser

deleteTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
deleteComments	string	No
commentDeleteMode	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteTenantUser Example

Copy

let (response, httpResponse) = client.deleteTenantUser(tenantId = "my-tenant-123", id = "user-456", deleteComments = "", commentDeleteMode = "")
if response.isSome:
  let flagResp = response.get()
  echo flagResp

getTenantUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetTenantUser_200_response]

Example

getTenantUser Example

Copy

let (response, httpResponse) = client.getTenantUser(tenantId = "my-tenant-123", id = "user-456")
if response.isSome:
  let tenantUser = response.get()
  discard tenantUser
else:
  discard httpResponse

getTenantUsers

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Response

Returns: Option[GetTenantUsers_200_response]

Example

getTenantUsers Example

Copy

let (response, httpResponse) = client.getTenantUsers(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let tenantUsers = response.get()
  echo "Fetched tenant users for my-tenant-123"
  discard tenantUsers
else:
  echo "No users returned"
  discard httpResponse

replaceTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

replaceTenantUser Example

Copy

let replaceBody = ReplaceTenantUserBody(name: "Jane Doe", email: "jane.doe@example.com", roles: @["moderator", "contributor"], banned: false)
let (response, httpResponse) = client.replaceTenantUser(tenantId = "my-tenant-123", id = "user-789", replaceTenantUserBody = replaceBody, updateComments = "true")
if response.isSome:
  let updated = response.get()
  echo updated
else:
  echo "No response returned"

sendLoginLink

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
redirectURL	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

sendLoginLink Example

Copy

let (response, httpResponse) = client.sendLoginLink(tenantId = "fastcomments-tenant-42", id = "user-9876", redirectURL = "https://news.example.com/articles/2026/fastcomments-login")
if response.isSome:
  let loginResp = response.get()
  echo "Login link sent successfully"
else:
  echo "Failed to send login link"

updateTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateTenantUser Example

Copy

var body: UpdateTenantUserBody
body.email = "jane.doe@example.com"
body.displayName = "Jane Doe"
body.roles = @["moderator", "editor"]
body.isActive = true
let (response, httpResponse) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateTenantUserBody = body,
  updateComments = "Promoted user to moderator and editor roles"
)
if response.isSome:
  let flagResp = response.get()
  echo flagResp
else:
  echo "Update failed, status: ", httpResponse.status

createTenant

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantBody	CreateTenantBody	No

Response

Returns: Option[CreateTenant_200_response]

Example

createTenant Example

Copy

let (response, httpResponse) = client.createTenant(tenantId = "my-tenant-123", createTenantBody = CreateTenantBody(
  name: "My Tenant 123",
  domain: "mytenant.example.com",
  plan: "pro",
  isActive: true,
  allowedOrigins: @["https://www.example.com", "https://admin.example.com"]
))
if response.isSome:
  let tenantInfo = response.get()
  discard tenantInfo

deleteTenant

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
sure	string	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteTenant Example

Copy

let (response, httpResponse) = client.deleteTenant(tenantId = "my-tenant-123", id = "", sure = "")
if response.isSome:
  let flagResp = response.get()
  echo "Tenant deletion response received for tenant: ", "my-tenant-123"
  discard flagResp
else:
  echo "No response body returned for tenant deletion"

getTenant

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetTenant_200_response]

Example

getTenant Example

Copy

let (response, httpResponse) = client.getTenant(tenantId = "my-tenant-123", id = "")
if response.isSome:
  let tenant = response.get()
  echo "Tenant retrieved"
  discard tenant
else:
  echo "No tenant found"
  echo "HTTP status:", httpResponse.status

getTenants

Parameters

Name	Type	Required
tenantId	string	Yes
meta	string	No
skip	float64	No

Response

Returns: Option[GetTenants_200_response]

Example

getTenants Example

Copy

let (response, httpResponse) = client.getTenants(tenantId = "my-tenant-123", meta = "include=details", skip = 0.0)
if response.isSome:
  let tenants = response.get()
  echo "Received tenants: ", repr(tenants)
else:
  echo "Failed to retrieve tenants"

updateTenant

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateTenantBody	UpdateTenantBody	No

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateTenant Example

Copy

let (response, httpResponse) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "tenant-456",
  updateTenantBody = UpdateTenantBody()
)
if response.isSome:
  let flagResponse = response.get()
  echo flagResponse
else:
  echo "No body returned; HTTP status: ", httpResponse.status

changeTicketState

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

Response

Returns: Option[ChangeTicketState_200_response]

Example

changeTicketState Example

Copy

let (response, httpResponse) = client.changeTicketState(
  tenantId = "my-tenant-123",
  userId = "user-456",
  id = "ticket-789",
  changeTicketStateBody = ChangeTicketStateBody(
    state = "closed",
    message = "Issue resolved by support",
    notify = true,
    tags = @["support", "resolved"]
  )
)
if response.isSome:
  let result = response.get()
  echo "Changed ticket:", result.state, " (id: ", result.id, ")"

createTicket

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
createTicketBody	CreateTicketBody	No

Response

Returns: Option[CreateTicket_200_response]

Example

createTicket Example

Copy

let createBody = CreateTicketBody(
  title = "Unable to post comment",
  description = "HTTP 500 when submitting comment on article 'world/my-latest-report'",
  contactEmail = "jane.doe@example.com",
  tags = @["comments", "backend"],
  urgent = false
)
let (response, httpResponse) = client.createTicket(tenantId = "my-tenant-123", userId = "user-9876", createTicketBody = createBody)
if response.isSome:
  let ticket = response.get()
  echo "Created ticket ID: ", $ticket

getTicket

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
userId	string	No

Response

Returns: Option[GetTicket_200_response]

Example

getTicket Example

Copy

let (response, httpResponse) = client.getTicket(tenantId = "my-tenant-123", id = "", userId = "")
if response.isSome:
  let ticket = response.get()
  discard ticket

getTickets

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
state	float64	No
skip	float64	No
limit	float64	No

Response

Returns: Option[GetTickets_200_response]

Example

getTickets Example

Copy

let (response, httpResponse) = client.getTickets(tenantId = "my-tenant-123", userId = "user-456", state = 1.0, skip = 0.0, limit = 50.0)
if response.isSome:
  let tickets = response.get()
  echo tickets
else:
  echo "No tickets returned"

uploadImage

Upload and resize an image

Parameters

Name	Type	Required
tenantId	string	Yes
file	string	No
sizePreset	SizePreset	No
urlId	string	Yes

Response

Returns: Option[UploadImageResponse]

Example

uploadImage Example

Copy

let (response, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "/var/www/uploads/headline-image.jpg",
  sizePreset = SizePreset.Medium,
  urlId = "news/article-title"
)
if response.isSome:
  let upload = response.get()
  echo "Upload response received"
else:
  echo "No upload response received"

getUserBadgeProgressById

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetUserBadgeProgressById_200_response]

Example

getUserBadgeProgressById Example

Copy

let (response, httpResponse) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "badge-activity-456")
if response.isSome:
  let progress = response.get()
  echo "Retrieved badge progress for tenant my-tenant-123"
  discard progress
else:
  echo "No badge progress found, HTTP status: ", $httpResponse.status

getUserBadgeProgressByUserId

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	No

Response

Returns: Option[GetUserBadgeProgressById_200_response]

Example

getUserBadgeProgressByUserId Example

Copy

let (response, httpResponse) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-78")
if response.isSome:
  let progress = response.get()
  echo "Badge progress received for user-78"
else:
  echo "No badge progress for user-78 (HTTP " & $(httpResponse.status) & ")"

getUserBadgeProgressList

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
limit	float64	No
skip	float64	No

Response

Returns: Option[GetUserBadgeProgressList_200_response]

Example

getUserBadgeProgressList Example

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(tenantId = "my-tenant-123", userId = "user-456", limit = 25.0, skip = 0.0)
if response.isSome:
  let badgeProgress = response.get()
  echo "Retrieved badge progress for user-456"
else:
  echo "No badge progress returned"

createUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	No

Response

Returns: Option[CreateUserBadge_200_response]

Example

createUserBadge Example

Copy

let params = CreateUserBadgeParams(
  userId = "user-789",
  badgeId = "top-contributor",
  awardedBy = "moderator@news-site.com",
  reason = "Helpful and respectful contributions",
  hidden = false,
  ttlDays = 0,
  tags = @["community", "trusted"]
)
let (response, httpResponse) = client.createUserBadge(tenantId = "my-tenant-123", createUserBadgeParams = params)
if response.isSome:
  let badge = response.get()
  discard badge

deleteUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[UpdateUserBadge_200_response]

Example

deleteUserBadge Example

Copy

let (response, httpResponse) = client.deleteUserBadge(tenantId = "my-tenant-123", id = "badge-456")
if response.isSome:
  let badge = response.get()
  echo badge

getUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetUserBadge_200_response]

Example

getUserBadge Example

Copy

let (response, httpResponse) = client.getUserBadge(tenantId = "my-tenant-123", id = "")
if response.isSome:
  let badge = response.get()
  echo badge

getUserBadges

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
badgeId	string	No
displayedOnComments	bool	No
limit	float64	No
skip	float64	No

Response

Returns: Option[GetUserBadges_200_response]

Example

getUserBadges Example

Copy

let (response, httpResponse) = client.getUserBadges(
  tenantId = "my-tenant-123",
  userId = "user-456",
  badgeId = "contributor",
  displayedOnComments = true,
  limit = 25.0,
  skip = 0.0
)
if response.isSome:
  let badges = response.get()
  echo "User badges retrieved"
else:
  echo "No badges found; HTTP status: ", httpResponse.status

updateUserBadge

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Response

Returns: Option[UpdateUserBadge_200_response]

Example

updateUserBadge Example

Copy

let params = UpdateUserBadgeParams(badgeId: "badge-moderator", label: "Moderator", active: true)
let (response, httpResponse) = client.updateUserBadge(tenantId = "my-tenant-123", id = "user-456", updateUserBadgeParams = params)
if response.isSome:
  let badgeResp = response.get()
  discard badgeResp

getUserNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

Response

Returns: Option[GetUserNotificationCount_200_response]

Example

getUserNotificationCount Example

Copy

let (response, httpResponse) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if response.isSome:
  let data = response.get()
  echo "Unread notifications: ", $data.unreadCount
else:
  echo "No notification count available"

getUserNotifications

Parameters

Name	Type	Required
tenantId	string	Yes
pageSize	int	No
afterId	string	No
includeContext	bool	No
afterCreatedAt	int64	No
unreadOnly	bool	No
dmOnly	bool	No
noDm	bool	No
includeTranslations	bool	No
sso	string	No

Response

Returns: Option[GetUserNotifications_200_response]

Example

getUserNotifications Example

Copy

let (response, httpResponse) = client.getUserNotifications(
  tenantId = "my-tenant-123",
  pageSize = 0,
  afterId = "",
  includeContext = false,
  afterCreatedAt = int64(0),
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  includeTranslations = false,
  sso = ""
)
if response.isSome:
  let notifications = response.get()
  echo notifications

resetUserNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

Response

Returns: Option[ResetUserNotifications_200_response]

Example

resetUserNotificationCount Example

Copy

let (response, httpResponse) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if response.isSome:
  let resetResult = response.get()
  echo "Reset notifications response received"
else:
  echo "No response body; status:", httpResponse.status

resetUserNotifications

Parameters

Name	Type	Required
tenantId	string	Yes
afterId	string	No
afterCreatedAt	int64	No
unreadOnly	bool	No
dmOnly	bool	No
noDm	bool	No
sso	string	No

Response

Returns: Option[ResetUserNotifications_200_response]

Example

resetUserNotifications Example

Copy

let (response, httpResponse) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  afterId = "",
  afterCreatedAt = 0'i64,
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  sso = ""
)
if response.isSome:
  let resetResult = response.get()
  echo "ResetUserNotifications succeeded: ", resetResult
else:
  echo "ResetUserNotifications returned no body, status: ", httpResponse.status

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

Name	Type	Required
tenantId	string	Yes
notificationId	string	No
optedInOrOut	string	No
commentId	string	Yes
sso	string	No

Response

Returns: Option[UpdateUserNotificationStatus_200_response]

Example

updateUserNotificationCommentSubscriptionStatus Example

Copy

let (response, httpResponse) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "",
  optedInOrOut = "",
  commentId = "comment-789",
  sso = ""
)
if response.isSome:
  let updateResp = response.get()
  discard updateResp

updateUserNotificationPageSubscriptionStatus

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string	No

Response

Returns: Option[UpdateUserNotificationStatus_200_response]

Example

updateUserNotificationPageSubscriptionStatus Example

Copy

let (response, httpResponse) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-title-456",
  url = "",
  pageTitle = "",
  subscribedOrUnsubscribed = "",
  sso = ""
)
if response.isSome:
  let result = response.get()
  echo "Subscription update returned:", $result

updateUserNotificationStatus

Parameters

Name	Type	Required
tenantId	string	Yes
notificationId	string	No
newStatus	string	No
sso	string	No

Response

Returns: Option[UpdateUserNotificationStatus_200_response]

Example

updateUserNotificationStatus Example

Copy

let (response, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-98765",
  newStatus = "read",
  sso = "sso-session-776"
)
if response.isSome:
  let updated = response.get()
  echo "Updated notification:", $updated
else:
  echo "No update returned"

getUserPresenceStatuses

Parameters

Name	Type	Required
tenantId	string	Yes
urlIdWS	string	No
userIds	string	No

Response

Returns: Option[GetUserPresenceStatuses_200_response]

Example

getUserPresenceStatuses Example

Copy

let (response, httpResponse) = client.getUserPresenceStatuses(tenantId = "my-tenant-123", urlIdWS = "news/article-title", userIds = "user-987,user-654")
if response.isSome:
  let statuses = response.get()
  echo statuses
else:
  discard httpResponse

searchUsers

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	seq[string]	No
sso	string	No
searchSection	string	No

Response

Returns: Option[SearchUsers_200_response]

Example

searchUsers Example

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/2026/ai-product-launch",
  usernameStartsWith = "",
  mentionGroupIds = @[],
  sso = "",
  searchSection = ""
)
if response.isSome:
  let users = response.get()
  echo "Received users:", users.toString()

getUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Returns: Option[GetUser_200_response]

Example

getUser Example

Copy

let (response, httpResponse) = client.getUser(tenantId = "my-tenant-123", id = "user-9876")
if response.isSome:
  let user = response.get()
  echo "User:", user
else:
  echo "No user found. HTTP response:", httpResponse

createVote

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
direction	string	No
userId	string	No
anonUserId	string	No

Response

Returns: Option[VoteComment_200_response]

Example

createVote Example

Copy

let (response, httpResponse) = client.createVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  direction = "up",
  userId = "user-42",
  anonUserId = ""
)
if response.isSome:
  let vote = response.get()
  echo "Vote recorded: ", $vote
else:
  echo "Vote not created, HTTP response: ", $httpResponse

deleteVote

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
editKey	string	No

Response

Returns: Option[DeleteCommentVote_200_response]

Example

deleteVote Example

Copy

let (response, httpResponse) = client.deleteVote(tenantId = "my-tenant-123", id = "", editKey = "")
if response.isSome:
  let deleted = response.get()
  discard deleted

getVotes

Parameters

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Response

Returns: Option[GetVotes_200_response]

Example

getVotes Example

Copy

let (response, httpResponse) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/2026/major-update")
if response.isSome:
  let votes = response.get()
  discard votes
else:
  discard httpResponse

getVotesForUser

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userId	string	No
anonUserId	string	No

Response

Returns: Option[GetVotesForUser_200_response]

Example

getVotesForUser Example

Copy

let (response, httpResponse) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/economy-update-2026",
  userId = "user-789",
  anonUserId = ""
)
if response.isSome:
  let votes = response.get()
  discard votes

Need Help?

If you encounter any issues or have questions about the Nim SDK, please:

Contributing

Contributions are welcome! Please visit the GitHub repository for contribution guidelines.

Language 🇺🇸 English

Documentation

Getting Started

API Reference

Usage

Aggregate

Audit Logs

Block From Comment

Check Blocked Comments

Comments

Domain Configs

Email Templates

Event Log

Feed Posts

Flag Comment

Hash Tags

Moderators

Notification Count

Notifications

Pages

Pending Webhook Events

Question Configs

Question Results

Question Results Aggregation

SSO Users

Subscriptions

Tenant Daily Usage

Tenant Packages

Tenant Users

Tenants

Tickets

Upload Image

User Badge Progress

User Badges

User Notifications

User Presence Status

User Search

Users

Votes

FastComments Nim SDK

Repository

Requirements

Installation

Using Nimble

Building from Source

Library Contents

Public vs Secured APIs

Quick Start

Using Authenticated APIs (DefaultAPI)

Using Public APIs (PublicAPI)

Common Issues

Making API Calls

Example: Fetching Comments

Notes

Broadcast Ids

SSO (Single Sign-On)

SSO Usage

Simple SSO

Secure SSO

Documentation for fastcomments

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

aggregate

Parameters

Response

Example

getAuditLogs

Parameters

Response

Example

blockFromCommentPublic

Parameters

Response

Example

unBlockCommentPublic

Parameters

Response

Example