FastComments Nim SDK

• Nim >= 1.6.0
• nimcrypto >= 0.5.4

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.

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

1. 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"
2. Wrong API class: Use api_default for server-side authenticated requests, api_public for client-side/public requests.

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"

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.

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

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

Parameters

Response

Returns: Option[AggregationResponse]

Example

aggregate Example

Copy

1

2let (response, httpResponse) = client.aggregate(

3 tenantId = "my-tenant-123",

4 aggregationRequest = AggregationRequest(

5 groupBy = @["urlPath"],

6 filters = @[],

7 size = 50

8 ),

9 parentTenantId = "parent-tenant-456",

10 includeStats = true

11)

12

13if response.isSome:

14 let aggregation = response.get()

15 echo "HTTP status: ", $httpResponse.status

16 echo "Aggregation result: ", $aggregation

17

Parameters

Response

Returns: Option[GetAuditLogs_200_response]

Example

getAuditLogs Example

Copy

1

2let (response, httpResponse) = client.getAuditLogs(tenantId = "my-tenant-123", limit = 100.0, skip = 0.0, order = SORTDIR.DESC, after = 1622505600.0, before = 1625097600.0)

3if response.isSome:

4 let logs = response.get()

5 echo logs

6

Parameters

Response

Returns: Option[BlockFromCommentPublic_200_response]

Example

blockFromCommentPublic Example

Copy

1

2let (response, httpResponse) = client.blockFromCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "news/article-2026-01-12-comment-789",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams(

6 reason = "harassment",

7 durationMinutes = 1440,

8 notifyUsers = false,

9 tags = @["abuse","spam"]

10 ),

11 sso = ""

12)

13if response.isSome:

14 let blockResult = response.get()

15 discard blockResult

16

Parameters

Response

Returns: Option[UnBlockCommentPublic_200_response]

Example

unBlockCommentPublic Example

Copy

1

2let (response, httpResponse) = client.unBlockCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-987654",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams(reason = "", blockDurationMinutes = 0, notifyUser = false),

6 sso = ""

7)

8if response.isSome:

9 let result = response.get()

10 discard result

11

Parameters

Response

Returns: Option[CheckedCommentsForBlocked_200_response]

Example

checkedCommentsForBlocked Example

Copy

1

2let (response, httpResponse) = client.checkedCommentsForBlocked(tenantId = "my-tenant-123", commentIds = "", sso = "")

3if response.isSome:

4 let checked = response.get()

5 echo "Checked comments for blocked:", checked

6else:

7 echo "No response received, HTTP status:", httpResponse.status

8

Parameters

Response

Returns: Option[BlockFromCommentPublic_200_response]

Example

blockUserFromComment Example

Copy

1

2let (response, httpResponse) = client.blockUserFromComment(

3 tenantId = "my-tenant-123",

4 id = "cmt-2026-0001",

5 blockFromCommentParams = BlockFromCommentParams(),

6 userId = "user-7421",

7 anonUserId = "")

8if response.isSome:

9 let blocked = response.get()

10 discard blocked

11

Parameters

Response

Returns: Option[CreateCommentPublic_200_response]

Example

createCommentPublic Example

Copy

1

2let (response, httpResponse) = client.createCommentPublic(

3 tenantId = "my-tenant-123",

4 urlId = "news/my-article-2026",

5 broadcastId = "",

6 commentData = CommentData(),

7 sessionId = "",

8 sso = ""

9)

10

11if response.isSome:

12 let created = response.get()

13 echo "Comment created: ", $created

14

Parameters

Response

Returns: Option[DeleteComment_200_response]

Example

deleteComment Example

Copy

1

2let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "comment-9876", contextUserId = "user-42", isLive = true)

3if response.isSome:

4 let deletedComment = response.get()

5 discard deletedComment

6else:

7 echo "Delete failed, status: ", httpResponse.status

8

Parameters

Response

Returns: Option[DeleteCommentPublic_200_response]

Example

deleteCommentPublic Example

Copy

1

2let (response, httpResponse) = client.deleteCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "",

6 editKey = "",

7 sso = ""

8)

9

10if response.isSome:

11 let deleted = response.get()

12 discard deleted

13

Parameters

Response

Returns: Option[DeleteCommentVote_200_response]

Example

deleteCommentVote Example

Copy

1

2let (response, httpResponse) = client.deleteCommentVote(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456",

5 voteId = "",

6 urlId = "news/top-stories/my-article",

7 broadcastId = "",

8 editKey = "",

9 sso = ""

10)

11

12if response.isSome:

13 let deleted = response.get()

14 echo "DeleteCommentVote succeeded for comment cmt-456"

15 discard deleted

16

Parameters

Response

Returns: Option[FlagComment_200_response]

Example

flagComment Example

Copy

1

2let (response, httpResponse) = client.flagComment(tenantId = "my-tenant-123", id = "comment-9876", userId = "", anonUserId = "anon-4f2b9c")

3

4if response.isSome:

5 let flagResult = response.get()

6 echo "Flag succeeded: ", $flagResult

7else:

8 echo "Flag failed, HTTP response status: ", $httpResponse.status

9

Parameters

Response

Returns: Option[GetComment_200_response]

Example

getComment Example

Copy

1

2let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-987654")

3if response.isSome:

4 let comment = response.get()

5 echo "Comment received:", comment

6else:

7 echo "No comment found, HTTP status:", httpResponse.status.code

8

Parameters

Response

Returns: Option[GetComments_200_response]

Example

getComments Example

Copy

1

2let (response, httpResponse) = client.getComments(

3 tenantId = "my-tenant-123",

4 page = 1,

5 limit = 25,

6 skip = 0,

7 asTree = true,

8 skipChildren = 0,

9 limitChildren = 5,

10 maxTreeDepth = 3,

11 urlId = "news/2026/01/important-announcement",

12 userId = "user-789",

13 anonUserId = "anon-456",

14 contextUserId = "ctx-321",

15 hashTag = "release",

16 parentId = "",

17 direction = SortDirections.Newest

18)

19

20if response.isSome:

21 let comments = response.get()

22 echo "Fetched comments for url:", " news/2026/01/important-announcement"

23

req tenantId urlId

Parameters

Response

Returns: Option[GetCommentsPublic_200_response]

Example

getCommentsPublic Example

Copy

1

2let (response, httpResponse) = client.getCommentsPublic(

3 tenantId = "my-tenant-123",

4 urlId = "news/latest-gear-review",

5 page = 1,

6 direction = SortDirections.Newest,

7 sso = "",

8 skip = 0,

9 skipChildren = 0,

10 limit = 20,

11 limitChildren = 0,

12 countChildren = false,

13 fetchPageForCommentId = "",

14 includeConfig = true,

15 countAll = false,

16 includei10n = false,

17 locale = "en-US",

18 modules = "reactions,moderation",

19 isCrawler = false,

20 includeNotificationCount = false,

21 asTree = true,

22 maxTreeDepth = 3,

23 useFullTranslationIds = false,

24 parentId = "",

25 searchText = "",

26 hashTags = @["tech", "review"],

27 userId = "user-987",

28 customConfigStr = "",

29 afterCommentId = "",

30 beforeCommentId = ""

31)

32if response.isSome:

33 let comments = response.get()

34 echo "Fetched comments:", comments

35

Parameters

Response

Returns: Option[GetCommentText_200_response]

Example

getCommentText Example

Copy

1

2let (response, httpResponse) = client.getCommentText(tenantId = "my-tenant-123", commentId = "cmt-987654321", editKey = "", sso = "")

3if response.isSome:

4 let commentText = response.get()

5 echo "Comment text: ", commentText

6else:

7 echo "No comment text returned. HTTP response: ", httpResponse

8

Parameters

Response

Returns: Option[GetCommentVoteUserNames_200_response]

Example

getCommentVoteUserNames Example

Copy

1

2let (response, httpResponse) = client.getCommentVoteUserNames(tenantId = "my-tenant-123", commentId = "cmt-987654", dir = 0, sso = "")

3if response.isSome:

4 let voteUsers = response.get()

5

Parameters

Response

Returns: Option[LockComment_200_response]

Example

lockComment Example

Copy

1

2let (response, httpResponse) = client.lockComment(tenantId = "my-tenant-123", commentId = "comment-98765", broadcastId = "", sso = "")

3if response.isSome:

4 let locked = response.get()

5 discard locked

6else:

7 discard httpResponse

8

Parameters

Response

Returns: Option[PinComment_200_response]

Example

pinComment Example

Copy

1

2let (response, httpResponse) = client.pinComment(tenantId = "tenant-456", commentId = "cmt-7890", broadcastId = "broadcast-001", sso = "")

3if response.isSome:

4 let pinResult = response.get()

5 discard pinResult

6

Parameters

Response

Returns: Option[SaveComment_200_response]

Example

saveComment Example

Copy

1

2let createParams = CreateCommentParams(

3 content = "Great article — helped me understand async patterns.",

4 authorName = "Alex Morgan",

5 authorEmail = "alex.morgan@example.com",

6 url = "news/my-company-launches-new-api",

7 parentId = "",

8 tags = @["api", "launch"]

9)

10

11let (response, httpResponse) = client.saveComment(

12 tenantId = "my-tenant-123",

13 createCommentParams = createParams,

14 isLive = true,

15 doSpamCheck = true,

16 sendEmails = false,

17 populateNotifications = true

18)

19

20if response.isSome:

21 let saved = response.get()

22 echo "Saved comment id: ", saved.id

23

Parameters

Response

Returns: Option[FlagCommentPublic_200_response]

Example

saveCommentsBulk Example

Copy

1

2let (response, httpResponse) = client.saveCommentsBulk(

3 tenantId = "my-tenant-123",

4 createCommentParams = @[],

5 isLive = false,

6 doSpamCheck = false,

7 sendEmails = false,

8 populateNotifications = false,

9 id = "",

10 fromName = ""

11)

12if response.isSome:

13 let flagResp = response.get()

14 echo "Flag response received: ", $flagResp

15

Parameters

Response

Returns: Option[SetCommentText_200_response]

Example

setCommentText Example

Copy

1

2let (response, httpResponse) = client.setCommentText(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-987654",

5 broadcastId = "bcast-2026-01",

6 commentTextUpdateRequest = CommentTextUpdateRequest(text = "Updated comment text for clarity and formatting"),

7 editKey = "",

8 sso = ""

9)

10

11if response.isSome:

12 let updated = response.get()

13 echo "Comment updated:", updated

14else:

15 echo "Update failed, status:", httpResponse.status

16

Parameters

Response

Returns: Option[UnBlockCommentPublic_200_response]

Example

unBlockUserFromComment Example

Copy

1

2let (response, httpResponse) = client.unBlockUserFromComment(

3 tenantId = "news-site-001",

4 id = "cmt-8fj3k9",

5 unBlockFromCommentParams = UnBlockFromCommentParams(),

6 userId = "user-98765",

7 anonUserId = ""

8)

9

10if response.isSome:

11 let unblocked = response.get()

12 discard unblocked

13

Parameters

Response

Returns: Option[FlagComment_200_response]

Example

unFlagComment Example

Copy

1

2let (response, httpResponse) = client.unFlagComment(

3 tenantId = "my-tenant-123",

4 id = "comment-9876",

5 userId = "user-42",

6 anonUserId = ""

7)

8

9if response.isSome:

10 let flagResp = response.get()

11 echo "Unflag succeeded:", flagResp

12

13echo "HTTP response status:", httpResponse.status

14

Parameters

Response

Returns: Option[LockComment_200_response]

Example

unLockComment Example

Copy

1

2let (response, httpResponse) = client.unLockComment(tenantId = "my-tenant-123", commentId = "cmt-456789", broadcastId = "", sso = "")

3if response.isSome:

4 let unlocked = response.get()

5 discard unlocked

6discard httpResponse

7

Parameters

Response

Returns: Option[PinComment_200_response]

Example

unPinComment Example

Copy

1

2let (response, httpResponse) = client.unPinComment(tenantId = "my-tenant-123", commentId = "cmt-987654321", broadcastId = "", sso = "")

3

4if response.isSome:

5 let pinInfo = response.get()

6 echo "Unpinned comment:", pinInfo

7else:

8 echo "Failed to unpin, HTTP status:", httpResponse.status

9

Parameters

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateComment Example

Copy

1

2let (response, httpResponse) = client.updateComment(

3 tenantId = "my-tenant-123",

4 id = "cmt-456",

5 updatableCommentParams = UpdatableCommentParams(

6 content: "Updated the comment to clarify the timeline",

7 tags: @["clarification", "timeline"],

8 isHidden: false

9 ),

10 contextUserId = "user-789",

11 doSpamCheck = true,

12 isLive = true

13)

14

15if response.isSome:

16 let updatedComment = response.get()

17 echo "Updated comment received, id: ", updatedComment.id

18

Parameters

Response

Returns: Option[VoteComment_200_response]

Example

voteComment Example

Copy

1

2let voteBody = VoteBodyParams(vote = 1)

3let (response, httpResponse) = client.voteComment(

4 tenantId = "my-tenant-123",

5 commentId = "cmt-456789",

6 urlId = "news/article-2026-election",

7 broadcastId = "",

8 voteBodyParams = voteBody,

9 sessionId = "",

10 sso = ""

11)

12if response.isSome:

13 let result = response.get()

14 echo "Vote response:", $result

15

Parameters

Response

Returns: Option[AddDomainConfig_200_response]

Example

addDomainConfig Example

Copy

1

2let addParams = AddDomainConfigParams(

3 domain = "news.example.com",

4 enabled = true,

5 allowSubdomains = false,

6 paths = @["/articles", "/breaking"],

7 priority = 10,

8 description = "Primary domain for news site"

9)

10let (response, httpResponse) = client.addDomainConfig(tenantId = "my-tenant-123", addDomainConfigParams = addParams)

11if response.isSome:

12 let cfg = response.get()

13 echo "Added domain config:", cfg

14

Parameters

Response

Returns: Option[DeleteDomainConfig_200_response]

Example

deleteDomainConfig Example

Copy

1

2let (response, httpResponse) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")

3if response.isSome:

4 let deletedConfig = response.get()

5 echo deletedConfig

6else:

7 echo "No domain config returned"

8

Parameters

Response

Returns: Option[GetDomainConfig_200_response]

Example

getDomainConfig Example

Copy

1

2let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")

3if response.isSome:

4 let config = response.get()

5 echo "Domain config received"

6else:

7 echo "No domain config available"

8

Parameters

Response

Returns: Option[GetDomainConfigs_200_response]

Example

getDomainConfigs Example

Copy

1

2let (response, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")

3if response.isSome:

4 let domainConfigs = response.get()

5 echo "Received domain configs for tenant:", domainConfigs

6else:

7 echo "No domain configs returned, HTTP status:", httpResponse.status.code

8

Parameters

Response

Returns: Option[GetDomainConfig_200_response]

Example

patchDomainConfig Example

Copy

1

2let patchParams = PatchDomainConfigParams(

3 domainName: "comments.mynews.com",

4 enableModeration: true,

5 allowedOrigins: @["https://www.mynews.com", "https://editor.mynews.com"]

6)

7

8let (response, httpResponse) = client.patchDomainConfig(

9 tenantId = "my-tenant-123",

10 domainToUpdate = "news/article-title",

11 patchDomainConfigParams = patchParams

12)

13

14if response.isSome:

15 let updated = response.get()

16 echo "Updated domain config for: ", updated.domainName

17

Parameters

Response

Returns: Option[GetDomainConfig_200_response]

Example

putDomainConfig Example

Copy

1

2let (response, httpResponse) = client.putDomainConfig(tenantId = "my-tenant-123", domainToUpdate = "news.example.com", updateDomainConfigParams = default(UpdateDomainConfigParams))

3if response.isSome:

4 let updatedConfig = response.get()

5 echo "Domain config updated for tenant my-tenant-123:", updatedConfig

6else:

7 echo "Failed to update domain config, HTTP status: ", httpResponse.status

8

Parameters

Response

Returns: Option[CreateEmailTemplate_200_response]

Example

createEmailTemplate Example

Copy

1

2let (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"]))

3if response.isSome:

4 let template = response.get()

5 discard template

6

Parameters

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteEmailTemplate Example

Copy

1

2let (response, httpResponse) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "tmpl-456")

3if response.isSome:

4 let deleted = response.get()

5 echo deleted

6

Parameters

Response

Returns: Option[FlagCommentPublic_200_response]

Example

deleteEmailTemplateRenderError Example

Copy

1

2let (response, httpResponse) = client.deleteEmailTemplateRenderError(

3 tenantId = "my-tenant-123",

4 id = "welcome-email-template",

5 errorId = "render-error-2026"

6)

7if response.isSome:

8 let flagResp = response.get()

9 discard flagResp

10

Parameters

Response

Returns: Option[GetEmailTemplate_200_response]

Example

getEmailTemplate Example

Copy

1

2let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email-01")

3if response.isSome:

4 let template = response.get()

5 echo "Template ID: ", template.id

6 echo "Subject: ", template.subject

7 echo "Body: ", template.body

8

Parameters

Response

Returns: Option[GetEmailTemplateDefinitions_200_response]

Example

getEmailTemplateDefinitions Example

Copy

1

2let (response, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")

3if response.isSome:

4 let defs = response.get()

5 echo "Received email template definitions for tenant my-tenant-123"

6else:

7 echo "No template definitions returned; HTTP status: ", httpResponse.status

8

Parameters

Response

Returns: Option[GetEmailTemplateRenderErrors_200_response]

Example

getEmailTemplateRenderErrors Example

Copy

1

2let (response, httpResponse) = client.getEmailTemplateRenderErrors(tenantId = "my-tenant-123", id = "welcome-email-template-001", skip = 0.0)

3if response.isSome:

4 let result = response.get()

5 echo "Render errors:", result

6else:

7 echo "No render errors or request failed. HTTP status:", httpResponse.status

8

Parameters

Response

Returns: Option[GetEmailTemplates_200_response]

Example

getEmailTemplates Example

Copy

1

2let (response, httpResponse) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)

3if response.isSome:

4 let templates = response.get()

5 echo templates

6else:

7 echo "No templates returned"

8

Parameters

Response

Returns: Option[RenderEmailTemplate_200_response]

Example

renderEmailTemplate Example

Copy

1

2let renderBody = RenderEmailTemplateBody(templateId: "comment-notification", subject: "New comment on your article", variables: @["John Doe", "news/global-climate"])

3let (response, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = renderBody, locale = "en-US")

4if response.isSome:

5 let rendered = response.get()

6 echo rendered

7

Parameters

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateEmailTemplate Example

Copy

1

2let updateBody = UpdateEmailTemplateBody(

3 name = "Welcome Email",

4 subject = "Welcome to Example News",

5 html = "<p>Hi {name}, welcome to Example News.</p>",

6 isActive = true,

7 tags = @["onboarding", "welcome"]

8)

9

10let (response, httpResponse) = client.updateEmailTemplate(

11 tenantId = "my-tenant-123",

12 id = "welcome-template-2026",

13 updateEmailTemplateBody = updateBody

14)

15

16if response.isSome:

17 let template = response.get()

18 discard template

19

req tenantId urlId userIdWS

Parameters

Response

Returns: Option[GetEventLog_200_response]

Example

getEventLog Example

Copy

1

2let (response, httpResponse) = client.getEventLog(

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 userIdWS = "",

6 startTime = 0'i64,

7 endTime = 0'i64

8)

9if response.isSome:

10 let eventLog = response.get()

11 echo "Event log retrieved for news/article-title"

12 discard eventLog

13else:

14 echo "Failed to retrieve event log, status: ", httpResponse.status

15

req tenantId urlId userIdWS

Parameters

Response

Returns: Option[GetEventLog_200_response]

Example

getGlobalEventLog Example

Copy

1

2let (response, httpResponse) = client.getGlobalEventLog(tenantId = "my-tenant-123",

3 urlId = "news/how-ai-is-changing",

4 userIdWS = "",

5 startTime = int64(0),

6 endTime = int64(0))

7

8if response.isSome:

9 let eventLog = response.get()

10 echo "Event log received:"

11 echo eventLog

12else:

13 echo "No event log; http response:"

14 echo httpResponse

15

Parameters

Response

Returns: Option[CreateFeedPost_200_response]

Example

createFeedPost Example

Copy

1

2let (response, httpResponse) = client.createFeedPost(

3 tenantId = "my-tenant-123",

4 createFeedPostParams = CreateFeedPostParams(

5 title = "Breaking: Major Storm Hits City",

6 content = "A severe storm caused widespread outages and travel delays across the metro area.",

7 authorId = "author-789",

8 url = "news/major-storm",

9 tags = @["weather", "breaking"],

10 attachments = @[]

11 ),

12 broadcastId = "",

13 isLive = false,

14 doSpamCheck = false,

15 skipDupCheck = false

16)

17

18if response.isSome:

19 let created = response.get()

20 echo "Feed post created:", created

21

Parameters

Response

Returns: Option[CreateFeedPostPublic_200_response]

Example

createFeedPostPublic Example

Copy

1

2let params = CreateFeedPostParams(

3 title: "Local Elections Update",

4 content: "Final results will be posted after polls close at 8pm.",

5 authorId: "reporter-789",

6 tags: @["politics", "local"],

7 isPublic: true

8)

9let (response, httpResponse) = client.createFeedPostPublic(

10 tenantId = "my-tenant-123",

11 createFeedPostParams = params,

12 broadcastId = "bcast-456",

13 sso = "sso-token-abc"

14)

15if response.isSome:

16 let created = response.get()

17 echo "created post id: ", created.id

18else:

19 echo "request failed, status: ", httpResponse.status

20

Parameters

Response

Returns: Option[DeleteFeedPostPublic_200_response]

Example

deleteFeedPostPublic Example

Copy

1

2let (response, httpResponse) = client.deleteFeedPostPublic(tenantId = "my-tenant-123", postId = "", broadcastId = "", sso = "")

3if response.isSome:

4 let deleted = response.get()

5 discard deleted

6else:

7 discard httpResponse

8

req tenantId afterId

Parameters

Response

Returns: Option[GetFeedPosts_200_response]

Example

getFeedPosts Example

Copy

1

2let (response, httpResponse) = client.getFeedPosts(

3 tenantId = "my-tenant-123",

4 afterId = "",

5 limit = 0,

6 tags = @[]

7)

8

9if response.isSome:

10 let feed = response.get()

11 discard feed

12

req tenantId afterId

Parameters

Response

Returns: Option[GetFeedPostsPublic_200_response]

Example

getFeedPostsPublic Example

Copy

1

2let (response, httpResponse) = client.getFeedPostsPublic(

3 tenantId = "my-tenant-123",

4 afterId = "",

5 limit = 0,

6 tags = @[],

7 sso = "",

8 isCrawler = false,

9 includeUserInfo = false

10)

11

12if response.isSome:

13 let feed = response.get()

14 echo "Retrieved feed posts"

15else:

16 echo "No feed posts returned"

17

Parameters

Response

Returns: Option[GetFeedPostsStats_200_response]

Example

getFeedPostsStats Example

Copy

1

2let (response, httpResponse) = client.getFeedPostsStats(tenantId = "my-tenant-123", postIds = @["news/article-456", "blog/post-789"], sso = "user-abc-sso-token")

3if response.isSome:

4 let stats = response.get()

5 echo "Received feed posts stats: ", stats

6else:

7 echo "No feed posts stats returned"

8

Parameters

Response

Returns: Option[GetUserReactsPublic_200_response]

Example

getUserReactsPublic Example

Copy

1

2let (response, httpResponse) = client.getUserReactsPublic(tenantId = "my-tenant-123", postIds = @["post-987", "post-654"], sso = "sso-token-abc123")

3if response.isSome:

4 let reacts = response.get()

5 echo "Received reacts:", repr(reacts)

6else:

7 echo "No reacts returned, HTTP status:", $httpResponse.status

8

Parameters

Response

Returns: Option[ReactFeedPostPublic_200_response]

Example

reactFeedPostPublic Example

Copy

1

2let (response, httpResponse) = client.reactFeedPostPublic(

3 tenantId = "my-tenant-123",

4 postId = "news/international-earthquake-2026",

5 reactBodyParams = default(ReactBodyParams),

6 isUndo = false,

7 broadcastId = "broadcast-789",

8 sso = ""

9)

10if response.isSome:

11 let reactResult = response.get()

12 discard reactResult

13

Parameters

Response

Returns: Option[FlagCommentPublic_200_response]

Example

updateFeedPost Example

Copy

1

2let (response, httpResponse) = client.updateFeedPost(

3 tenantId = "my-tenant-123",

4 id = "post-456",

5 feedPost = FeedPost(

6 id = "post-456",

7 title = "Breaking News: Market Rally",

8 content = "Stocks surged 5% after the Fed announcement; analysts cite renewed investor confidence.",

9 published = true,

10 tags = @["finance", "markets"]

11 )

12)

13if response.isSome:

14 let flagResp = response.get()

15 discard flagResp

16

Parameters

Response

Returns: Option[CreateFeedPostPublic_200_response]

Example

updateFeedPostPublic Example

Copy

1

2let updateParams = UpdateFeedPostParams(

3 title = "Launch: FastComments v2.0",

4 content = "Announcing the v2.0 release with performance and moderation improvements.",

5 visible = true,

6 tags = @["release", "announcement"],

7 priority = 1

8)

9

10let (response, httpResponse) = client.updateFeedPostPublic(

11 tenantId = "my-tenant-123",

12 postId = "news/launch-fastcomments-v2",

13 updateFeedPostParams = updateParams,

14 broadcastId = "",

15 sso = ""

16)

17

18if response.isSome:

19 let updated = response.get()

20 echo "Feed post updated successfully"

21