FastComments SDK dla Nim

• Nim >= 1.6.0
• nimcrypto >= 0.5.4

Korzystanie z Nimble

nimble install fastcomments

Budowanie ze źródeł

nimble build

Zawartość biblioteki

Ta biblioteka zawiera wygenerowanego klienta API oraz narzędzia SSO, aby ułatwić pracę z API.

• Dokumentacja biblioteki klienta API

API publiczne vs zabezpieczone

W kliencie API znajdują się trzy moduły API: api_default, api_public oraz api_moderation. api_default zawiera metody, które wymagają Twojego klucza API, a api_public zawiera wywołania API, które można wykonywać bezpośrednio z przeglądarki/urządzenia mobilnego itp. bez uwierzytelniania. Moduł api_moderation zawiera metody dla panelu moderatora.

Metody api_moderation obejmują listowanie, zliczanie, wyszukiwanie i eksportowanie komentarzy oraz ich logów; akcje moderacyjne takie jak usuwanie/przywracanie komentarzy, zgłaszanie, ustawianie statusu do przeglądu/spamu/akceptacji, dostosowywanie głosów oraz ponowne otwieranie/zamykanie wątków; bany (zablokowanie użytkownika od komentowania, cofanie bana, podsumowania przed banem, status i preferencje bana oraz liczba zbanowanych użytkowników); oraz odznaki i zaufanie (przyznawanie/usuwanie odznaki, listowanie odznak ręcznych, pobieranie/ustawianie współczynnika zaufania użytkownika oraz pobieranie wewnętrznego profilu użytkownika). Każda metoda api_moderation przyjmuje parametr sso, dzięki czemu wywołanie jest uwierzytelnione jako moderator SSO.

Korzystanie z uwierzytelnionych API (DefaultAPI)

Ważne: Uwierzytelnione końcówki wymagają ustawienia Twojego klucza API w nagłówku 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"

# Wykonaj uwierzytelnione wywołania API
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"

Korzystanie z publicznych API (PublicAPI)

Publiczne końcówki nie wymagają uwierzytelnienia:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Wykonaj publiczne wywołania API
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"

Korzystanie z API moderacji (ModerationAPI)

Końcówki moderacyjne zasilają panel moderatora i są uwierzytelniane tokenem SSO dla działającego moderatora:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Wyświetl komentarze w panelu moderacji
let (response, httpResponse) = getApiComments(
  httpClient = client,
  page = 0,
  count = 30,
  textSearch = "",
  byIPFromComment = "",
  filters = "",
  searchFilters = "",
  sorts = "",
  demo = false,
  sso = "your-sso-token"
)

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

Częste problemy

1. 401 authentication error: Upewnij się, że ustawiłeś nagłówek x-api-key w swoim HttpClient przed wykonywaniem żądań DefaultAPI: client.headers["x-api-key"] = "your-api-key"
2. Wrong API class: Używaj api_default dla uwierzytelnionych żądań po stronie serwera, api_public dla żądań po stronie klienta/publicznych oraz api_moderation dla żądań panelu moderatora.

Wszystkie metody API w tym SDK zwracają krotki (Option[ResponseType], Response). Pierwszy element zawiera sparsowaną odpowiedź w przypadku powodzenia, a drugi element to surowa odpowiedź HTTP.

Przykład: Pobieranie komentarzy

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"

Identyfikatory Broadcast

Zauważysz, że w niektórych wywołaniach API należy przekazać broadcastId. Gdy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, aby zignorować zdarzenie, jeśli planujesz optymistycznie zastosować zmiany po stronie klienta (co prawdopodobnie zechcesz zrobić, ponieważ zapewnia to najlepsze wrażenia). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, by nie wystąpić dwukrotnie w sesji przeglądarki.

SSO (Logowanie jednokrotne)

Przykłady SSO znajdują się poniżej.

Proste 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

Bezpieczne 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

Agreguje dokumenty grupując je (jeśli podano groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itd.).

Parametry

Odpowiedź

Zwraca: Option[AggregateResponse]

Przykład

Przykład agregacji

Copy

1

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

3 tenantId = "my-tenant-123",

4 aggregationRequest = AggregationRequest(groupBy = @["articleId"], metrics = @["commentCount"], filters = @[], limit = 0),

5 parentTenantId = "",

6 includeStats = false

7)

8

9if response.isSome:

10 let agg = response.get()

11 discard agg

12

Parametry

Odpowiedź

Zwraca: Option[GetAuditLogsResponse]

Przykład

Przykład getAuditLogs

Copy

1

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

3 tenantId = "my-tenant-123",

4 limit = 50.0,

5 skip = 0.0,

6 order = SORTDIR.DESC,

7 after = 1622505600.0,

8 before = 1625097600.0

9)

10

11if response.isSome:

12 let logs = response.get()

13 echo logs

14else:

15 echo "No audit logs returned"

16

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład logoutPublic

Copy

1

2let (response, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", sessionId = "sess-9a8b7c6d", userId = "editor-87", revokeAll = false, ipAddress = "")

3if response.isSome:

4 let emptyResp = response.get()

5 echo "Logout successful for user: ", "editor-87"

6else:

7 echo "Logout failed"

8

Parametry

Odpowiedź

Zwraca: Option[BlockSuccess]

Przykład

Przykład blockFromCommentPublic

Copy

1

2let publicParams = PublicBlockFromCommentParams(

3 reason = "Repeated spam links",

4 durationMinutes = 1440,

5 blockAll = true,

6 notifyUser = false,

7 tags = @["spam", "auto-block"]

8)

9

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

11 tenantId = "my-tenant-123",

12 commentId = "comment-98765",

13 publicBlockFromCommentParams = publicParams,

14 sso = ""

15)

16

17if response.isSome:

18 let blockResult = response.get()

19 echo "Block succeeded: ", $blockResult

20else:

21 echo "Block failed, HTTP status: ", $httpResponse.status

22

Parametry

Response

Zwraca: Option[UnblockSuccess]

Przykład

Przykład unBlockCommentPublic

Copy

1

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

3if response.isSome:

4 let unblockResult = response.get()

5 discard unblockResult

6else:

7 discard httpResponse

8

Parametry

Odpowiedź

Zwraca: Option[CheckBlockedCommentsResponse]

Przykład

Przykład checkedCommentsForBlocked

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentIds = "",

5 sso = ""

6)

7if response.isSome:

8 let blockedResp = response.get()

9 echo "Received blocked comments response: ", blockedResp

10else:

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

12

Parametry

Odpowiedź

Zwraca: Option[BlockSuccess]

Przykład

Przykład blockUserFromComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 id = "cmt-7890",

5 blockFromCommentParams = BlockFromCommentParams(

6 reason = "Repeated abusive language",

7 durationMinutes = 1440,

8 notifyUser = true,

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

10 ),

11 userId = "user-456",

12 anonUserId = ""

13)

14

15if response.isSome:

16 let result = response.get()

17 discard result

18else:

19 discard httpResponse

20

Parametry

Odpowiedź

Zwraca: Option[SaveCommentsResponseWithPresence]

Przykład

Przykład createCommentPublic

Copy

1

2let commentPayload = CommentData(

3 text = "Great write-up on serverless architectures.",

4 authorName = "Jane Doe",

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

6 isPublic = true,

7 tags = @["tech", "serverless"]

8)

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

10 tenantId = "my-tenant-123",

11 urlId = "news/2026/06/fastcomments-sdk-update",

12 broadcastId = "broadcast-2026-06-19",

13 commentData = commentPayload,

14 sessionId = "sess-8a7b6c",

15 sso = "sso-jwt-abc123"

16)

17if response.isSome:

18 let saved = response.get()

19 discard saved

20

Parameters

Odpowiedź

Zwraca: Option[DeleteCommentResult]

Przykład

Przykład deleteComment

Copy

1

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

3if response.isSome:

4 let result = response.get()

5 echo "DeleteCommentResult received"

6else:

7 echo "No result, HTTP status: ", httpResponse.status

8

Parametry

Odpowiedź

Zwraca: Option[PublicAPIDeleteCommentResponse]

Przykład

Przykład deleteCommentPublic

Copy

1

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

3if response.isSome:

4 let deleted = response.get()

5 echo "Delete acknowledged, HTTP status: ", httpResponse.status

6

Parametry

Odpowiedź

Zwraca: Option[VoteDeleteResponse]

Przykład

Przykład deleteCommentVote

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "comment-456",

5 voteId = "vote-789",

6 urlId = "news/article-title",

7 broadcastId = "",

8 editKey = "",

9 sso = ""

10)

11if response.isSome:

12 let voteResp = response.get()

13 echo "Vote delete response:", voteResp

14else:

15 echo "No response body, HTTP response:", httpResponse

16

Parametry

Odpowiedź

Zwraca: Option[FlagCommentResponse]

Przykład

Przykład flagComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 id = "cmt-98765",

5 userId = "user-12345",

6 anonUserId = ""

7)

8

9if response.isSome:

10 let flagResp = response.get()

11 echo "Flag response received"

12else:

13 echo "No flag response returned"

14

Parametry

Odpowiedź

Zwraca: Option[APIGetCommentResponse]

Przykład

Przykład getComment

Copy

1

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

3if response.isSome:

4 let comment = response.get()

5 discard comment

6else:

7 echo "Comment not found"

8

Parametry

Odpowiedź

Zwraca: Option[APIGetCommentsResponse]

Przykład

Przykład użycia getComments

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-global-economy",

12 userId = "user-789",

13 anonUserId = "",

14 contextUserId = "",

15 hashTag = "economy",

16 parentId = "",

17 direction = SortDirections.Desc,

18 fromDate = 1710000000000'i64,

19 toDate = 1710100000000'i64

20)

21if response.isSome:

22 let commentsResp = response.get()

23 discard commentsResp

24

req tenantId urlId

Parametry

Odpowiedź

Zwraca: Option[GetCommentsResponseWithPresencePublicComment]

Przykład

Przykład getCommentsPublic

Copy

1

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

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 page = 2,

6 direction = SortDirections.Descending,

7 sso = "",

8 skip = 0,

9 skipChildren = 0,

10 limit = 25,

11 limitChildren = 5,

12 countChildren = false,

13 fetchPageForCommentId = "",

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 = "",

25 searchText = "climate change",

26 hashTags = @["climate", "research"],

27 userId = "user-789",

28 customConfigStr = "",

29 afterCommentId = "",

30 beforeCommentId = ""

31)

32

33if response.isSome:

34 let commentsResp = response.get()

35 echo "Received comments response:"

36 echo commentsResp

37else:

38 echo "No comments returned. HTTP status:", httpResponse.status

39

Parametry

Odpowiedź

Zwraca: Option[PublicAPIGetCommentTextResponse]

Przykład

Przykład użycia getCommentText

Copy

1

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

3

4if response.isSome:

5 let commentTextResp = response.get()

6 echo commentTextResp

7else:

8 echo "No comment text returned"

9

Parametry

Odpowiedź

Zwraca: Option[GetCommentVoteUserNamesSuccessResponse]

Przykład

Przykład getCommentVoteUserNames

Copy

1

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

3if response.isSome:

4 let success: GetCommentVoteUserNamesSuccessResponse = response.get()

5 discard success

6

Parametry

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład lockComment

Copy

1

2let (response, httpResponse) = client.lockComment(tenantId = "news-tenant-42", commentId = "cmt-8f3a2b9d", broadcastId = "", sso = "")

3if response.isSome:

4 let apiResp = response.get()

5 echo "Locked comment successfully for tenant news-tenant-42"

6else:

7 echo "Failed to lock comment, HTTP status: ", $httpResponse.status

8

Parametry

Odpowiedź

Zwraca: Option[ChangeCommentPinStatusResponse]

Przykład

Przykład użycia pinComment

Copy

1

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

3if response.isSome:

4 let pinnedResp = response.get()

5 echo "Pin status updated for comment cmt-98765"

6else:

7 echo "No response received"

8

Parametry

Odpowiedź

Zwraca: Option[APISaveCommentResponse]

Przykład

Przykład użycia saveComment

Copy

1

2let createCommentParams = CreateCommentParams(

3 urlId = "news/2026/major-policy-change",

4 content = "This is a thoughtful comment on the policy change and its potential impacts.",

5 authorName = "Morgan Lee",

6 authorEmail = "morgan.lee@example.org",

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

8 extraData = @[])

9

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

11 tenantId = "my-tenant-123",

12 createCommentParams = createCommentParams,

13 isLive = true,

14 doSpamCheck = true,

15 sendEmails = false,

16 populateNotifications = true)

17

18if response.isSome:

19 let saved = response.get()

20 discard saved

21

Parametry

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład saveCommentsBulk

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)

12

13if response.isSome:

14 let apiResp = response.get()

15 echo "Bulk save succeeded, tenant:", " my-tenant-123"

16else:

17 echo "Bulk save returned no API response"

18

Parametry

Odpowiedź

Zwraca: Option[PublicAPISetCommentTextResponse]

Przykład

Przykład użycia setCommentText

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "",

6 commentTextUpdateRequest = CommentTextUpdateRequest(text: "Updated comment text to fix a typo and clarify meaning."),

7 editKey = "",

8 sso = ""

9)

10if response.isSome:

11 let result = response.get()

12 discard result

13

Parametry

Odpowiedź

Zwraca: Option[UnblockSuccess]

Przykład

Przykład unBlockUserFromComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 id = "comment-9f3b2a",

5 unBlockFromCommentParams = UnBlockFromCommentParams(),

6 userId = "user-1024",

7 anonUserId = "anon-77b"

8)

9

10if response.isSome:

11 let unblockResult = response.get()

12 echo unblockResult

13else:

14 echo "Unblock failed"

15

Parametry

Odpowiedź

Zwraca: Option[FlagCommentResponse]

Przykład

Przykład unFlagComment

Copy

1

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

3 id = "comment-98765",

4 userId = "user-12345",

5 anonUserId = "")

6

7if response.isSome:

8 let flagResp = response.get()

9 echo "Unflagged comment response:", flagResp

10else:

11 echo "Unflag failed, HTTP status:", httpResponse.status

12

Parametry

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład unLockComment

Copy

1

2let tenantId = "my-tenant-123"

3let commentId = "cmt-987654321"

4let (response, httpResponse) = client.unLockComment(

5 tenantId = tenantId,

6 commentId = commentId,

7 broadcastId = "",

8 sso = ""

9)

10if response.isSome:

11 let apiResp = response.get()

12 echo "Unlocked comment ", commentId, " for tenant ", tenantId

13else:

14 echo "Unlock failed, HTTP status: ", $httpResponse.status

15

Parametry

Odpowiedź

Zwraca: Option[ChangeCommentPinStatusResponse]

Przykład

Przykład unPinComment

Copy

1

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

3if response.isSome:

4 let result = response.get()

5 echo "Unpinned comment:", $result

6else:

7 echo "Unpin failed, HTTP status:", $httpResponse.status

8

Parametry

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład updateComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 id = "cmt-987654",

5 updatableCommentParams = UpdatableCommentParams(

6 text = "Updated comment: corrected facts and clarified wording.",

7 isApproved = true,

8 tags = @["news", "update"]

9 ),

10 contextUserId = "user-456",

11 doSpamCheck = true,

12 isLive = true

13)

14

15if response.isSome:

16 let apiResp = response.get()

17 discard apiResp

18

Parametry

Odpowiedź

Zwraca: Option[VoteResponse]

Przykład

Przykład voteComment

Copy

1

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

3 tenantId = "my-tenant-123",

4 commentId = "cmt-987654321",

5 urlId = "news/article-2026-inflation",

6 broadcastId = "",

7 voteBodyParams = VoteBodyParams(),

8 sessionId = "",

9 sso = ""

10)

11

12if response.isSome:

13 let voteResp = response.get()

14 discard voteResp

15else:

16 discard httpResponse

17

Parametry

Odpowiedź

Zwraca: Option[GetCommentsForUserResponse]

Przykład

Przykład getCommentsForUser

Copy

1

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

3 userId = "user-8421",

4 direction = SortDirections.Newest,

5 repliesToUserId = "",

6 page = 1.0,

7 includei10n = true,

8 locale = "en-US",

9 isCrawler = false

10)

11

12if response.isSome:

13 let comments = response.get()

14 discard comments

15

Parametry

Odpowiedź

Zwraca: Option[AddDomainConfigResponse]

Przykład

Przykład addDomainConfig

Copy

1

2let config = AddDomainConfigParams(

3 domain: "comments.example-news.com",

4 enabled: true,

5 allowedOrigins: @["https://www.example-news.com", "https://m.example-news.com"],

6 commentsPath: "/news/world/election-coverage",

7 priority: 5

8)

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

10if response.isSome:

11 let created = response.get()

12 echo "Created domain config:", created

13else:

14 echo "Failed to create domain config, HTTP status:", httpResponse.status.code

15

Parametry

Odpowiedź

Zwraca: Option[DeleteDomainConfigResponse]

Przykład

Przykład użycia deleteDomainConfig

Copy

1

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

3if response.isSome:

4 let deleted = response.get()

5 echo "DeleteDomainConfig succeeded for tenant ", "my-tenant-123"

6else:

7 echo "DeleteDomainConfig failed. HTTP status: ", $httpResponse.status

8

Parametry

Odpowiedź

Zwraca: Option[GetDomainConfigResponse]

Przykład

Przykład getDomainConfig

Copy

1

2let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news/top-story-2026")

3if response.isSome:

4 let cfg = response.get()

5 discard cfg

6else:

7 discard httpResponse

8

Parametry

Odpowiedź

Zwraca: Option[GetDomainConfigsResponse]

Przykład

Przykład getDomainConfigs

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 my-tenant-123"

6 echo domainConfigs

7else:

8 echo "No domain configs returned"

9

Parametry

Odpowiedź

Zwraca: Option[PatchDomainConfigResponse]

Przykład

Przykład patchDomainConfig

Copy

1

2let patchParams: PatchDomainConfigParams = PatchDomainConfigParams(

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

4 enableComments = true,

5 moderationRequired = false,

6 maxCommentLength = 2000,

7 primaryDomain = "comments.news-site.com"

8)

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

10 tenantId = "my-tenant-123",

11 domainToUpdate = "comments.news-site.com",

12 patchDomainConfigParams = patchParams

13)

14if response.isSome:

15 let cfg = response.get()

16 echo "Patched domain config received:", cfg

17else:

18 echo "No response body, HTTP status:", httpResponse.statusCode

19

Parametry

Odpowiedź

Zwraca: Option[PutDomainConfigResponse]

Przykład

Przykład putDomainConfig

Copy

1

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

3 tenantId = "my-tenant-123",

4 domainToUpdate = "blog.example.com",

5 updateDomainConfigParams = UpdateDomainConfigParams(

6 allowAnonymous = false,

7 moderationEnabled = true,

8 maxCommentLength = 800,

9 allowedOrigins = @["https://blog.example.com", "https://cdn.blog.example.com"],

10 enableThreadedComments = true

11 )

12)

13

14if response.isSome:

15 let cfg = response.get()

16 echo cfg

17else:

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

19

Parametry

Odpowiedź

Zwraca: Option[CreateEmailTemplateResponse]

Przykład

Przykład createEmailTemplate

Copy

1

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

3 createEmailTemplateBody = CreateEmailTemplateBody(

4 name = "Weekly Newsletter",

5 subject = "This Week on NewsSite",

6 html = "<h1>Latest updates</h1><p>Read our latest article.</p>",

7 fromAddress = "no-reply@newssite.com",

8 isDefault = false,

9 tags = @["news", "weekly"]

10 )

11)

12

13if response.isSome:

14 let template = response.get()

15 echo "Created email template id: ", template.id

16

Parametry

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteEmailTemplate

Copy

1

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

3 tenantId = "my-tenant-123",

4 id = "welcome-email-template-001"

5)

6

7if response.isSome:

8 let apiEmpty = response.get()

9 discard apiEmpty

10 echo "Email template deleted successfully"

11else:

12 echo "No response body"

13

Parametry

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteEmailTemplateRenderError

Copy

1

2let (response, httpResponse) = client.deleteEmailTemplateRenderError(tenantId = "my-tenant-123", id = "welcome-email-template", errorId = "err-20250615-01")

3if response.isSome:

4 let emptyResp = response.get()

5 echo "Deleted render error, tenant:", "my-tenant-123"

6 echo "HTTP status:", httpResponse.status

7else:

8 echo "No body returned, HTTP status:", httpResponse.status

9

Parametry

Odpowiedź

Zwraca: Option[GetEmailTemplateResponse]

Przykład

Przykład 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 discard template

6

Parametry

Odpowiedź

Zwraca: Option[GetEmailTemplateDefinitionsResponse]

Przykład

Przykład getEmailTemplateDefinitions

Copy

1

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

3if response.isSome:

4 let definitions = response.get()

5 echo "Email template definitions for my-tenant-123: ", definitions

6else:

7 echo "Failed to retrieve templates, HTTP status: ", httpResponse.status

8

Parametry

Odpowiedź

Zwraca: Option[GetEmailTemplateRenderErrorsResponse]

Przykład

Przykład getEmailTemplateRenderErrors

Copy

1

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

3if response.isSome:

4 let templateErrors = response.get()

5 discard templateErrors

6else:

7 discard httpResponse

8

Parametry

Odpowiedź

Zwraca: Option[GetEmailTemplatesResponse]

Przykład

Przykład 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 email templates available"

8

Parametry

Odpowiedź

Zwraca: Option[RenderEmailTemplateResponse]

Przykład

Przykład renderEmailTemplate

Copy

1

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

3 tenantId = "my-tenant-123",

4 renderEmailTemplateBody = RenderEmailTemplateBody(),

5 locale = "en-US"

6)

7

8if response.isSome:

9 let rendered = response.get()

10 echo rendered

11

Parametry

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład updateEmailTemplate

Copy

1

2let updateBody = UpdateEmailTemplateBody(

3 subject = "Welcome to Newsly",

4 html = "<p>Thanks for joining Newsly! Visit https://newsly.example to get started.</p>",

5 fromAddress = "no-reply@newsly.example",

6 fromName = "Newsly Team",

7 enabled = true

8)

9let (response, httpResponse) = client.updateEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email", updateEmailTemplateBody = updateBody)

10if response.isSome:

11 let result = response.get()

12 discard result

13else:

14 discard httpResponse.statusCode

15

req tenantId urlId userIdWS

Parametry

Odpowiedź

Zwraca: Option[GetEventLogResponse]

Przykład

Przykład getEventLog

Copy

1

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

3 tenantId = "my-tenant-123",

4 urlId = "news/article-2026-solar-panels",

5 userIdWS = "user-456",

6 startTime = 1688000000'i64,

7 endTime = 1688086400'i64

8)

9if response.isSome:

10 let eventLog = response.get()

11 discard eventLog

12

req tenantId urlId userIdWS

Parametry

Odpowiedź

Zwraca: Option[GetEventLogResponse]

Przykład

Przykład getGlobalEventLog

Copy

1

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

3 tenantId = "my-tenant-123",

4 urlId = "news/article-2026-06-19",

5 userIdWS = "user-987",

6 startTime = int64(1622505600),

7 endTime = int64(1625097600)

8)

9if response.isSome:

10 let eventLog = response.get()

11 echo eventLog, httpResponse.statusCode

12

Parametry

Odpowiedź

Zwraca: Option[CreateFeedPostsResponse]

Przykład

Przykład createFeedPost

Copy

1

2let postParams = CreateFeedPostParams(

3 title = "Major Acquisition by TechCorp",

4 content = "TechCorp has acquired SoftWorks in a deal valued at $1.2B, creating a new market leader.",

5 url = "news/tech/major-acquisition",

6 tags = @["business", "technology"],

7 authorId = "journalist-321"

8)

9

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

11 tenantId = "my-tenant-123",

12 createFeedPostParams = postParams,

13 broadcastId = "",

14 isLive = false,

15 doSpamCheck = false,

16 skipDupCheck = false

17)

18

19if response.isSome:

20 let created = response.get()

21 discard created

22

Parametry

Odpowiedź

Zwraca: Option[CreateFeedPostResponse]

Przykład

Przykład createFeedPostPublic

Copy

1

2let params = CreateFeedPostParams(

3 title = "Breaking: Major Update on Product X",

4 content = "Today we released Product X v2.0 with performance improvements and bug fixes.",

5 author = "jane.doe",

6 tags = @["product", "release", "v2"],

7 isPinned = false

8)

9

10let (response, httpResponse) = client.createFeedPostPublic(tenantId = "my-tenant-123", createFeedPostParams = params, broadcastId = "", sso = "")

11

12if response.isSome:

13 let created = response.get()

14 echo "Created feed post:", created

15else:

16 echo "Failed to create feed post; HTTP status:", httpResponse.status

17