FastComments Nim SDK

• Nim >= 1.6.0
• nimcrypto >= 0.5.4

Utilizzo di Nimble

nimble install fastcomments

Compilazione dal Sorgente

nimble build

Contenuto della libreria

Questa libreria contiene il client API generato e le utilità SSO per facilitare l'interazione con l'API.

• API Client Library Docs

API pubbliche vs protette

Per il client API, ci sono due moduli API, api_default e api_public. api_default contiene metodi che richiedono la tua API key, e api_public contiene chiamate API che possono essere effettuate direttamente da un browser/dispositivo mobile/etc. senza autenticazione.

Utilizzo delle API Autenticate (DefaultAPI)

Importante: Gli endpoint autenticati richiedono che la tua chiave API sia impostata nell'intestazione x-api-key.

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"

# Effettua chiamate API autenticate
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"

Utilizzo delle API Pubbliche (PublicAPI)

Gli endpoint pubblici non richiedono autenticazione:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Effettua chiamate API pubbliche
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"

Problemi comuni

1. Errore di autenticazione 401: Assicurati di impostare l'intestazione x-api-key sul tuo HttpClient prima di effettuare richieste DefaultAPI: client.headers["x-api-key"] = "your-api-key"
2. Classe API errata: Usa api_default per richieste autenticate lato server, api_public per richieste lato client/pubbliche.

Tutti i metodi API in questo SDK restituiscono tuple di (Option[ResponseType], Response). Il primo elemento contiene la risposta analizzata se ha successo, e il secondo elemento è la risposta HTTP grezza.

Esempio: Recupero dei commenti

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"

ID di broadcast

Vedrai che dovrai passare un broadcastId in alcune chiamate API. Quando riceverai eventi, otterrai questo ID, così saprai di ignorare l'evento se prevedi di applicare le modifiche in modo ottimistico sul client (cosa che probabilmente vorrai fare poiché offre la migliore esperienza). Passa qui un UUID. L'ID dovrebbe essere abbastanza unico da non comparire due volte in una sessione del browser.

SSO (Single Sign-On)

Per esempi di SSO, vedi sotto.

SSO Semplice

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

SSO Sicuro

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

Parametri

Risposta

Restituisce: Option[AggregationResponse]

Esempio

Esempio di aggregate

Copy

1

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

3 tenantId = "my-tenant-123",

4 aggregationRequest = AggregationRequest(),

5 parentTenantId = "",

6 includeStats = false

7)

8if response.isSome:

9 let aggregation = response.get()

10 echo $aggregation

11

Parametri

Risposta

Restituisce: Option[GetAuditLogs_200_response]

Esempio

Esempio di getAuditLogs

Copy

1

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

3 tenantId = "my-tenant-123",

4 limit = 100.0,

5 skip = 0.0,

6 order = SORTDIR(0),

7 after = 0.0,

8 before = 0.0

9)

10if response.isSome:

11 let audit = response.get()

12 echo audit

13

Parametri

Risposta

Restituisce: Option[BlockFromCommentPublic_200_response]

Esempio

Esempio di blockFromCommentPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "comment-987654",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams(),

6 sso = "sso-token-7a9b3c"

7)

8if response.isSome:

9 let blockResult = response.get()

10 discard blockResult

11

Parametri

Risposta

Restituisce: Option[UnBlockCommentPublic_200_response]

Esempio

Esempio di unBlockCommentPublic

Copy

1

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

3 tenantId = "news-site-456",

4 commentId = "comment-abc123",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams{},

6 sso = ""

7)

8if response.isSome:

9 let unblocked = response.get()

10 discard unblocked

11else:

12 discard httpResponse

13

Parametri

Risposta

Restituisce: Option[CheckedCommentsForBlocked_200_response]

Esempio

Esempio di checkedCommentsForBlocked

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentIds = "",

5 sso = ""

6)

7if response.isSome:

8 let checked = response.get()

9 echo "Checked comments received for tenant my-tenant-123"

10 echo checked

11else:

12 echo "No checked comments (HTTP status: ", $httpResponse.statusCode, ")"

13

Parametri

Risposta

Restituisce: Option[BlockFromCommentPublic_200_response]

Esempio

Esempio di blockUserFromComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 id = "comment-98765",

5 blockFromCommentParams = BlockFromCommentParams(),

6 userId = "user-456",

7 anonUserId = ""

8)

9if response.isSome:

10 let blocked = response.get()

11 echo "Block confirmed for tenant:", " my-tenant-123"

12

Parametri

Risposta

Restituisce: Option[CreateCommentPublic_200_response]

Esempio

Esempio di createCommentPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 urlId = "news/breaking-elections-2025",

5 broadcastId = "broadcast-456",

6 commentData = CommentData(

7 content = "Great reporting — thanks for the clear analysis!",

8 authorName = "Jane Doe",

9 authorEmail = "jane.doe@example.com",

10 isVerified = false,

11 tags = @["politics", "analysis"]

12 ),

13 sessionId = "session-789",

14 sso = "sso-token-abc123"

15)

16

17if response.isSome:

18 let created = response.get()

19 echo "Created comment:", created

20else:

21 echo "No comment returned, HTTP status: ", httpResponse.status`

22

Parametri

Risposta

Restituisce: Option[DeleteComment_200_response]

Esempio

Esempio di deleteComment

Copy

1

2let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "cmt-456abc", contextUserId = "user-789", isLive = true)

3if response.isSome:

4 let deleted = response.get()

5 discard deleted

6 echo "Delete succeeded"

7else:

8 echo "No delete response"

9

Parametri

Risposta

Restituisce: Option[DeleteCommentPublic_200_response]

Esempio

Esempio di deleteCommentPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "cmt-987654",

5 broadcastId = "",

6 editKey = "",

7 sso = ""

8)

9if response.isSome:

10 let deleted = response.get()

11 echo "Delete succeeded"

12 echo "HTTP status: ", httpResponse.status

13else:

14 echo "Delete failed, HTTP status: ", httpResponse.status

15

Parametri

Risposta

Restituisce: Option[DeleteCommentVote_200_response]

Esempio

Esempio di deleteCommentVote

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "cmt-789",

5 voteId = "",

6 urlId = "news/breaking-story-2025",

7 broadcastId = "",

8 editKey = "",

9 sso = ""

10)

11if response.isSome:

12 let deleted = response.get()

13 discard deleted

14 echo "Vote removed for comment cmt-789"

15else:

16 echo "No response body returned"

17

Parametri

Risposta

Restituisce: Option[FlagComment_200_response]

Esempio

Esempio di flagComment

Copy

1

2let (response, httpResponse) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-98765", userId = "user-8342", anonUserId = "")

3if response.isSome:

4 let flagged = response.get()

5 echo "Flagged comment response: ", flagged

6else:

7 echo "Flag comment failed: ", httpResponse

8

Parametri

Risposta

Restituisce: Option[GetComment_200_response]

Esempio

Esempio di getComment

Copy

1

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

3if response.isSome:

4 let comment = response.get()

5 echo comment

6

Parametri

Risposta

Restituisce: Option[GetComments_200_response]

Esempio

Esempio di getComments

Copy

1

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

3 tenantId = "my-tenant-123",

4 page = 1,

5 limit = 20,

6 skip = 0,

7 asTree = false,

8 skipChildren = 0,

9 limitChildren = 0,

10 maxTreeDepth = 0,

11 urlId = "news/2025-election-night",

12 userId = "",

13 anonUserId = "",

14 contextUserId = "",

15 hashTag = "",

16 parentId = "",

17 direction = SortDirections.Desc

18)

19

20if response.isSome:

21 let comments = response.get()

22 echo "Status: ", httpResponse.status, " Comments: ", comments

23

Parametri

Risposta

Restituisce: Option[GetCommentsPublic_200_response]

Esempio

Esempio getCommentsPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 urlId = "news/world/article-2025",

5 page = 1,

6 direction = SortDirections(0),

7 sso = "sso_token_abc",

8 skip = 0,

9 skipChildren = 0,

10 limit = 20,

11 limitChildren = 5,

12 countChildren = false,

13 fetchPageForCommentId = "cmt_789",

14 includeConfig = true,

15 countAll = false,

16 includei10n = true,

17 locale = "en-US",

18 modules = "reactions,moderation",

19 isCrawler = false,

20 includeNotificationCount = true,

21 asTree = true,

22 maxTreeDepth = 3,

23 useFullTranslationIds = false,

24 parentId = "parent_123",

25 searchText = "openAI integration",

26 hashTags = @["ai", "technology"],

27 userId = "user_456",

28 customConfigStr = "{}",

29 afterCommentId = "cmt_100",

30 beforeCommentId = ""

31)

32

33if response.isSome:

34 let comments = response.get()

35 discard comments

36else:

37 discard httpResponse

38

Parametri

Risposta

Restituisce: Option[GetCommentText_200_response]

Esempio

Esempio di getCommentText

Copy

1

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

3

4if response.isSome:

5 let comment = response.get()

6 echo "Comment text: ", $comment

7else:

8 echo "No comment returned"

9

Parametri

Risposta

Restituisce: Option[GetCommentVoteUserNames_200_response]

Esempio

Esempio getCommentVoteUserNames

Copy

1

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

3if response.isSome:

4 let res = response.get()

5 for userName in res.userNames:

6 echo userName

7

Parametri

Risposta

Restituisce: Option[LockComment_200_response]

Esempio

Esempio di lockComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "cmt-98765",

5 broadcastId = "",

6 sso = ""

7)

8if response.isSome:

9 let lockResp = response.get()

10 discard lockResp

11

Parametri

Risposta

Restituisce: Option[PinComment_200_response]

Esempio

Esempio di pinComment

Copy

1

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

3if response.isSome:

4 let pinned = response.get()

5 echo "Pinned comment response received"

6else:

7 echo "No pin response"

8

Parametri

Risposta

Restituisce: Option[SaveComment_200_response]

Esempio

Esempio di saveComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 createCommentParams = CreateCommentParams(

5 content = "This article was really helpful, thanks!",

6 urlId = "news/2025-11/ai-regulations",

7 authorName = "Jane Doe",

8 authorEmail = "jane.doe@example.com",

9 tags = @["policy", "analysis"]

10 ),

11 isLive = true,

12 doSpamCheck = true,

13 sendEmails = true,

14 populateNotifications = false

15)

16

17if response.isSome:

18 let saved = response.get()

19 discard saved

20

Parametri

Risposta

Restituisce: Option[UnBlockCommentPublic_200_response]

Esempio

Esempio di saveCommentsBulk

Copy

1

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

3 tenantId = "my-tenant-123",

4 createCommentParams = @[],

5 isLive = true,

6 doSpamCheck = true,

7 sendEmails = false,

8 populateNotifications = true,

9 id = "batch-20251122",

10 unBlockFromCommentParams = UnBlockFromCommentParams(),

11 userId = "user-456",

12 anonUserId = "anon-789"

13)

14if response.isSome:

15 let unblocked = response.get()

16 echo "Unblocked response received: ", unblocked

17else:

18 echo "No unblocked response, httpResponse: ", $httpResponse

19

Parametri

Risposta

Restituisce: Option[SetCommentText_200_response]

Esempio

Esempio di setCommentText

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "cmt-7890",

5 broadcastId = "broadcast-456",

6 commentTextUpdateRequest = CommentTextUpdateRequest(text = "Updated comment text to fix typos and add clarity."),

7 editKey = "edit-key-abc123",

8 sso = "sso-token-xyz"

9)

10

11if response.isSome:

12 let updated = response.get()

13

Parametri

Risposta

Restituisce: Option[UnBlockCommentPublic_200_response]

Esempio

Esempio di unBlockUserFromComment

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

Parametri

Risposta

Restituisce: Option[FlagComment_200_response]

Esempio

Esempio di unFlagComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 id = "flag-789",

5 userId = "",

6 anonUserId = ""

7)

8

9if response.isSome:

10 let flagResponse = response.get()

11 echo "Comment unflagged successfully"

12

Parametri

Risposta

Restituisce: Option[LockComment_200_response]

Esempio

Esempio di unLockComment

Copy

1

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

3if response.isSome:

4 let lockResult = response.get()

5 echo "Unlock response: ", $lockResult

6else:

7 echo "Unlock failed, HTTP response: ", $httpResponse

8

Parametri

Risposta

Restituisce: Option[PinComment_200_response]

Esempio

Esempio di unPinComment

Copy

1

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

3if response.isSome:

4 let pinResp = response.get()

5 echo "Unpinned comment successfully"

6else:

7 echo "Failed to unpin comment; HTTP response: ", httpResponse

8

Parametri

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateComment

Copy

1

2let updatableCommentParams = UpdatableCommentParams(content: "Fixed a typo in the second paragraph", tags: @["article-edit", "typo"], isApproved: true)

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

4 tenantId = "my-tenant-123",

5 id = "comment-456",

6 updatableCommentParams = updatableCommentParams,

7 contextUserId = "user-789",

8 doSpamCheck = true,

9 isLive = true

10)

11if response.isSome:

12 let flagResp = response.get()

13 discard flagResp

14

Parametri

Risposta

Restituisce: Option[VoteComment_200_response]

Esempio

Esempio di voteComment

Copy

1

2let voteBody = VoteBodyParams()

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

4 tenantId = "my-tenant-123",

5 commentId = "cmt-456789",

6 urlId = "news/2025/fastcomments-integration",

7 broadcastId = "",

8 voteBodyParams = voteBody,

9 sessionId = "",

10 sso = ""

11)

12if response.isSome:

13 let voteResp = response.get()

14 echo "Vote recorded for comment cmt-456789"

15else:

16 echo "Failed to record vote"

17

Parametri

Risposta

Restituisce: Option[AddDomainConfig_200_response]

Esempio

Esempio di addDomainConfig

Copy

1

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

3if response.isSome:

4 let domainConfig = response.get()

5 discard domainConfig

6else:

7 discard httpResponse

8

Parametri

Risposta

Restituisce: Option[DeleteDomainConfig_200_response]

Esempio

Esempio di deleteDomainConfig

Copy

1

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

3if response.isSome:

4 let result = response.get()

5 echo "Deleted domain config result: ", result

6else:

7 echo "No response body, HTTP status: ", $httpResponse.status

8

Parametri

Risposta

Restituisce: Option[GetDomainConfig_200_response]

Esempio

Esempio di getDomainConfig

Copy

1

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

3if response.isSome:

4 let domainConfig = response.get()

5 echo "Loaded domain config for tenant my-tenant-123:", $domainConfig

6else:

7 echo "No domain config; HTTP status:", $httpResponse.status

8

Parametri

Risposta

Restituisce: Option[GetDomainConfigs_200_response]

Esempio

Esempio di getDomainConfigs

Copy

1

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

3if response.isSome:

4 let domainConfigs = response.get()

5 echo "Domain configs received:"

6 echo domainConfigs

7else:

8 echo "Failed to retrieve domain configs."

9 echo httpResponse

10

Parametri

Risposta

Restituisce: Option[GetDomainConfig_200_response]

Esempio

Esempio di patchDomainConfig

Copy

1

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

3 tenantId = "my-tenant-123",

4 domainToUpdate = "news/article-crowdsourcing",

5 patchDomainConfigParams = PatchDomainConfigParams(

6 allowedOrigins = @["https://www.news-site.com"],

7 moderated = true,

8 maxCommentLength = 1000

9 )

10)

11

12if response.isSome:

13 let domainConfig = response.get()

14 echo "Updated domain config received"

15else:

16 echo "No domain config returned"

17

Parametri

Risposta

Restituisce: Option[GetDomainConfig_200_response]

Esempio

Esempio di putDomainConfig

Copy

1

2let updateParams = UpdateDomainConfigParams(

3 allowAnonymous = false,

4 moderationEnabled = true,

5 allowedOrigins = @["https://news.example.com"],

6 maxCommentLength = 2000

7)

8

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

10 tenantId = "my-tenant-123",

11 domainToUpdate = "news/example-article",

12 updateDomainConfigParams = updateParams

13)

14

15if response.isSome:

16 let domainCfg = response.get()

17 discard domainCfg

18

Parametri

Risposta

Restituisce: Option[CreateEmailTemplate_200_response]

Esempio

Esempio di createEmailTemplate

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

Parametri

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteEmailTemplate

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

Parametri

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteEmailTemplateRenderError

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

Parametri

Risposta

Restituisce: Option[GetEmailTemplate_200_response]

Esempio

Esempio di getEmailTemplate

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

Parametri

Risposta

Restituisce: Option[GetEmailTemplateDefinitions_200_response]

Esempio

Esempio di getEmailTemplateDefinitions

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

Parametri

Risposta

Restituisce: Option[GetEmailTemplateRenderErrors_200_response]

Esempio

Esempio di getEmailTemplateRenderErrors

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

Parametri

Risposta

Restituisce: Option[GetEmailTemplates_200_response]

Esempio

Esempio di getEmailTemplates

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

Parametri

Risposta

Restituisce: Option[RenderEmailTemplate_200_response]

Esempio

Esempio di renderEmailTemplate

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

Parametri

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateEmailTemplate

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

Parametri

Risposta

Restituisce: Option[GetEventLog_200_response]

Esempio

Esempio di getEventLog

Copy

1

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

3 tenantId = "my-tenant-123",

4 urlId = "news/politics/election-2024",

5 userIdWS = "",

6 startTime = 0'i64,

7 endTime = 0'i64

8)

9if response.isSome:

10 let eventLog = response.get()

11 echo "Received event log for ", "my-tenant-123"

12else:

13 echo "No event log returned. HTTP status: ", $httpResponse.status

14

Parametri

Risposta

Restituisce: Option[GetEventLog_200_response]

Esempio

Esempio di getGlobalEventLog

Copy

1

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

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 userIdWS = "",

6 startTime = int64(0),

7 endTime = int64(0)

8)

9if response.isSome:

10 let eventLog = response.get()

11 echo eventLog

12else:

13 echo "No event log returned"

14

Parametri

Risposta

Restituisce: Option[CreateFeedPost_200_response]

Esempio

Esempio di createFeedPost

Copy

1

2let createParams = CreateFeedPostParams(

3 content = "We're rolling out realtime comments to all users!",

4 title = "Realtime Comments Rollout",

5 url = "news/realtime-comments-rollout-2025",

6 authorId = "prod-team",

7 tags = @["release", "comments"]

8)

9

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

11 tenantId = "my-tenant-123",

12 createFeedPostParams = createParams,

13 broadcastId = "broadcast-2025-11",

14 isLive = true,

15 doSpamCheck = true,

16 skipDupCheck = false

17)

18

19if response.isSome:

20 let created = response.get()

21 echo "Feed post created, id: ", $created.id

22else:

23 echo "Failed to create feed post, HTTP status: ", $httpResponse.statusCode

24

Parametri

Risposta

Restituisce: Option[CreateFeedPostPublic_200_response]

Esempio

Esempio di createFeedPostPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 createFeedPostParams = CreateFeedPostParams(

5 title = "Product Launch Announcement",

6 content = "We just launched a new commenting feature to improve engagement.",

7 authorId = "team-product",

8 url = "news/product-launch",

9 tags = @["launch", "comments"],

10 isFeatured = false

11 ),

12 broadcastId = "broadcast-009",

13 sso = ""

14)

15if response.isSome:

16 let created = response.get()

17 discard created

18

Parametri

Risposta

Restituisce: Option[DeleteFeedPostPublic_200_response]

Esempio

Esempio di deleteFeedPostPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 postId = "post-456",

5 broadcastId = "broadcast-789",

6 sso = ""

7)

8if response.isSome:

9 let result = response.get()

10

Parametri

Risposta

Restituisce: Option[GetFeedPosts_200_response]

Esempio

Esempio getFeedPosts

Copy

1

2let (response, httpResponse) = client.getFeedPosts(tenantId = "my-tenant-123", afterId = "post_abc123", limit = 20, tags = @["news", "sports"])

3if response.isSome:

4 let feed = response.get()

5 echo "Feed posts retrieved for tenant my-tenant-123"

6else:

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

8

Parametri

Risposta

Restituisce: Option[GetFeedPostsPublic_200_response]

Esempio

Esempio di getFeedPostsPublic

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 feed

15

Parametri

Risposta

Restituisce: Option[GetFeedPostsStats_200_response]

Esempio

Esempio di getFeedPostsStats

Copy

1

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

3 tenantId = "my-tenant-123",

4 postIds = @["news/article-2025-11-22", "opinion/market-trends-452"],

5 sso = ""

6)

7

8if response.isSome:

9 let stats = response.get()

10 discard stats

11

Parametri

Risposta

Restituisce: Option[GetUserReactsPublic_200_response]

Esempio

Esempio getUserReactsPublic

Copy

1

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

3if response.isSome:

4 let reacts = response.get()

5 discard reacts

6

Parametri

Risposta

Restituisce: Option[ReactFeedPostPublic_200_response]

Esempio

Esempio di reactFeedPostPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 postId = "news/article-title",

5 reactBodyParams = ReactBodyParams(),

6 isUndo = false,

7 broadcastId = "broadcast-456",

8 sso = ""

9)

10if response.isSome:

11 let result = response.get()

12 echo "Reaction result: ", result

13else:

14 echo "Reaction failed, HTTP response: ", httpResponse

15

Parametri

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateFeedPost

Copy

1

2let feedPost = FeedPost(

3 title: "Local Election Results",

4 content: "Updated vote counts across precincts",

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

6 authorId: "journalist-32",

7 isPublished: true,

8 views: 124

9)

10

11let (response, httpResponse) = client.updateFeedPost(tenantId = "my-tenant-123", id = "post-456", feedPost = feedPost)

12

13if response.isSome:

14 let flagResp = response.get()

15 discard flagResp

16

Parametri

Risposta

Restituisce: Option[CreateFeedPostPublic_200_response]

Esempio

Esempio di updateFeedPostPublic

Copy

1

2var updateParams: UpdateFeedPostParams = UpdateFeedPostParams(

3 title = "Breaking: Service Update",

4 content = "We improved feed performance and UX for all users.",

5 tags = @["performance", "release"],

6 isPublic = true

7)

8

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

10 tenantId = "my-tenant-123",

11 postId = "post-456",

12 updateFeedPostParams = updateParams,

13 broadcastId = "broadcast-789",

14 sso = "sso-token-abc123"

15)

16

17if response.isSome:

18 let post = response.get()

19 echo "Updated post title: ", post.title

20 echo "HTTP status: ", httpResponse.status

21