FastComments Nim SDK

To jest oficjalny SDK Nim dla FastComments.

Oficjalny SDK Nim dla API FastComments

Repozytorium

Wymagania

Nim >= 1.6.0
nimcrypto >= 0.5.4

Instalacja

Korzystanie z Nimble

nimble install fastcomments

Budowanie ze źródeł

nimble build

Zawartość biblioteki

Ta biblioteka zawiera wygenerowanego klienta API oraz narzędzia SSO, które ułatwiają pracę z API.

Dokumentacja biblioteki klienta API

Publiczne vs Zabezpieczone API

Dla klienta API istnieją dwa moduły API, `api_default` i `api_public`. `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.

Szybki start

Używanie uwierzytelnionych API (DefaultAPI)

Ważne: Uwierzytelnione endpointy wymagają ustawienia klucza API jako nagłówka 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"

Używanie publicznych API (PublicAPI)

Publiczne endpointy 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"

Typowe problemy

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

Wykonywanie wywołań API

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"

Uwagi

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.

Użycie SSO

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

Dokumentacja fastcomments

Dokumentacja punktów końcowych API

Wszystkie URI są względne względem https://fastcomments.com

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Agreguje dokumenty przez grupowanie ich (jeśli podano groupBy) i zastosowanie wielu operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itp.).
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	wymaga tenantId afterId
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsPublic	GET /comments/{tenantId}	wymaga tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	wymaga tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	wymaga tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	wymaga tenantId urlId userIdWS
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Włącz lub wyłącz powiadomienia dla konkretnego komentarza.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy są subskrybowani do strony, powiadomienia są tworzone dla nowych komentarzy głównych, a także
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Prześlij i zmień rozmiar obrazu
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Dokumentacja modeli

Dokumentacja autoryzacji

api_key

Type: Typ
API key parameter name: x-api-key
Location: Lokalizacja: nagłówek HTTP

aggregate

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
aggregationRequest	AggregationRequest	Nie
parentTenantId	string	Nie
includeStats	bool	Nie

Odpowiedź

Zwraca: Option[AggregationResponse]

Przykład

Przykład aggregate

Copy

let (response, httpResponse) = client.aggregate(
  tenantId = "my-tenant-123",
  aggregationRequest = AggregationRequest(),
  parentTenantId = "",
  includeStats = false
)
if response.isSome:
  let aggregation = response.get()
  echo $aggregation

getAuditLogs

Parametry

Name	Type	Wymagane
tenantId	string	Tak
limit	float64	Nie
skip	float64	Nie
order	SORTDIR	Nie
after	float64	Nie
before	float64	Nie

Odpowiedź

Zwraca: Option[GetAuditLogs_200_response]

Przykład

Przykład użycia getAuditLogs

Copy

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

blockFromCommentPublic

Parametry

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[BlockFromCommentPublic_200_response]

Przykład

Przykład blockFromCommentPublic

Copy

let (response, httpResponse) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = "sso-token-7a9b3c"
)
if response.isSome:
  let blockResult = response.get()
  discard blockResult

unBlockCommentPublic

Parametry

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[UnBlockCommentPublic_200_response]

Przykład

Przykład unBlockCommentPublic

Copy

let (response, httpResponse) = client.unBlockCommentPublic(
  tenantId = "news-site-456",
  commentId = "comment-abc123",
  publicBlockFromCommentParams = PublicBlockFromCommentParams{},
  sso = ""
)
if response.isSome:
  let unblocked = response.get()
  discard unblocked
else:
  discard httpResponse

checkedCommentsForBlocked

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentIds	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[CheckedCommentsForBlocked_200_response]

Przykład

Przykład checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
blockFromCommentParams	BlockFromCommentParams	Nie
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: Option[BlockFromCommentPublic_200_response]

Przykład

Przykład blockUserFromComment

Copy

let (response, httpResponse) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-98765",
  blockFromCommentParams = BlockFromCommentParams(),
  userId = "user-456",
  anonUserId = ""
)
if response.isSome:
  let blocked = response.get()
  echo "Block confirmed for tenant:", " my-tenant-123"

createCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
broadcastId	string	Nie
commentData	CommentData	Nie
sessionId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[CreateCommentPublic_200_response]

Przykład

Przykład createCommentPublic

Copy

let (response, httpResponse) = client.createCommentPublic(
  tenantId = "my-tenant-123",
  urlId = "news/breaking-elections-2025",
  broadcastId = "broadcast-456",
  commentData = CommentData(
    content = "Great reporting — thanks for the clear analysis!",
    authorName = "Jane Doe",
    authorEmail = "jane.doe@example.com",
    isVerified = false,
    tags = @["politics", "analysis"]
  ),
  sessionId = "session-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let created = response.get()
  echo "Created comment:", created
else:
  echo "No comment returned, HTTP status: ", httpResponse.status`

deleteComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
contextUserId	string	Nie
isLive	bool	Nie

Odpowiedź

Zwraca: Option[DeleteComment_200_response]

Przykład

Przykład deleteComment

Copy

let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "cmt-456abc", contextUserId = "user-789", isLive = true)
if response.isSome:
  let deleted = response.get()
  discard deleted
  echo "Delete succeeded"
else:
  echo "No delete response"

deleteCommentPublic

Parametry

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[DeleteCommentPublic_200_response]

Przykład

Przykład deleteCommentPublic

Copy

let (response, httpResponse) = client.deleteCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let deleted = response.get()
  echo "Delete succeeded"
  echo "HTTP status: ", httpResponse.status
else:
  echo "Delete failed, HTTP status: ", httpResponse.status

deleteCommentVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
voteId	string	Nie
urlId	string	Tak
broadcastId	string	Nie
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[DeleteCommentVote_200_response]

Przykład

Przykład deleteCommentVote

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-789",
  voteId = "",
  urlId = "news/breaking-story-2025",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let deleted = response.get()
  discard deleted
  echo "Vote removed for comment cmt-789"
else:
  echo "No response body returned"

flagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: Option[FlagComment_200_response]

Przykład

Przykład flagComment

Copy

let (response, httpResponse) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-98765", userId = "user-8342", anonUserId = "")
if response.isSome:
  let flagged = response.get()
  echo "Flagged comment response: ", flagged
else:
  echo "Flag comment failed: ", httpResponse

getComment

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetComment_200_response]

Przykład

Przykład getComment

Copy

let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-987654321")
if response.isSome:
  let comment = response.get()
  echo comment

getComments

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
page	int	Nie
limit	int	Nie
skip	int	Nie
asTree	bool	Nie
skipChildren	int	Nie
limitChildren	int	Nie
maxTreeDepth	int	Nie
urlId	string	Tak
userId	string	Nie
anonUserId	string	Nie
contextUserId	string	Nie
hashTag	string	Nie
parentId	string	Nie
direction	SortDirections	Nie

Odpowiedź

Zwraca: Option[GetComments_200_response]

Przykład

Przykład getComments

Copy

let (response, httpResponse) = client.getComments(
  tenantId = "my-tenant-123",
  page = 1,
  limit = 20,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "news/2025-election-night",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.Desc
)
if response.isSome:
  let comments = response.get()
  echo "Status: ", httpResponse.status, " Comments: ", comments

getCommentsPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
page	int	Nie
direction	SortDirections	Nie
sso	string	Nie
skip	int	Nie
skipChildren	int	Nie
limit	int	Nie
limitChildren	int	Nie
countChildren	bool	Nie
fetchPageForCommentId	string	Nie
includeConfig	bool	Nie
countAll	bool	Nie
includei10n	bool	Nie
locale	string	Nie
modules	string	Nie
isCrawler	bool	Nie
includeNotificationCount	bool	Nie
asTree	bool	Nie
maxTreeDepth	int	Nie
useFullTranslationIds	bool	Nie
parentId	string	Nie
searchText	string	Nie
hashTags	seq[string]	Nie
userId	string	Nie
customConfigStr	string	Nie
afterCommentId	string	Nie
beforeCommentId	string	Nie

Odpowiedź

Zwraca: Option[GetCommentsPublic_200_response]

Przykład

Przykład użycia getCommentsPublic

Copy

let (response, httpResponse) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/world/article-2025",
  page = 1,
  direction = SortDirections(0),
  sso = "sso_token_abc",
  skip = 0,
  skipChildren = 0,
  limit = 20,
  limitChildren = 5,
  countChildren = false,
  fetchPageForCommentId = "cmt_789",
  includeConfig = true,
  countAll = false,
  includei10n = true,
  locale = "en-US",
  modules = "reactions,moderation",
  isCrawler = false,
  includeNotificationCount = true,
  asTree = true,
  maxTreeDepth = 3,
  useFullTranslationIds = false,
  parentId = "parent_123",
  searchText = "openAI integration",
  hashTags = @["ai", "technology"],
  userId = "user_456",
  customConfigStr = "{}",
  afterCommentId = "cmt_100",
  beforeCommentId = ""
)
if response.isSome:
  let comments = response.get()
  discard comments
else:
  discard httpResponse

getCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[GetCommentText_200_response]

Przykład

Przykład użycia getCommentText

Copy

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

getCommentVoteUserNames

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
dir	int	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[GetCommentVoteUserNames_200_response]

Przykład

Przykład getCommentVoteUserNames

Copy

let (response, httpResponse) = client.getCommentVoteUserNames(tenantId = "my-tenant-123", commentId = "c_987654321", dir = 0, sso = "")
if response.isSome:
  let res = response.get()
  for userName in res.userNames:
    echo userName

lockComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[LockComment_200_response]

Przykład

Przykład lockComment

Copy

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

pinComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[PinComment_200_response]

Przykład

Przykład pinComment

Copy

let (response, httpResponse) = client.pinComment(tenantId = "my-tenant-123", commentId = "cmt-98765", broadcastId = "", sso = "")
if response.isSome:
  let pinned = response.get()
  echo "Pinned comment response received"
else:
  echo "No pin response"

saveComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createCommentParams	CreateCommentParams	Nie
isLive	bool	Nie
doSpamCheck	bool	Nie
sendEmails	bool	Nie
populateNotifications	bool	Nie

Odpowiedź

Zwraca: Option[SaveComment_200_response]

Przykład

Przykład saveComment

Copy

let (response, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = CreateCommentParams(
    content = "This article was really helpful, thanks!",
    urlId = "news/2025-11/ai-regulations",
    authorName = "Jane Doe",
    authorEmail = "jane.doe@example.com",
    tags = @["policy", "analysis"]
  ),
  isLive = true,
  doSpamCheck = true,
  sendEmails = true,
  populateNotifications = false
)
if response.isSome:
  let saved = response.get()
  discard saved

saveCommentsBulk

Parametry

Name	Type	Wymagane
tenantId	string	Tak
createCommentParams	seq[CreateCommentParams]	Nie
isLive	bool	Nie
doSpamCheck	bool	Nie
sendEmails	bool	Nie
populateNotifications	bool): (Option[seq[SaveComment_200_response]]	Nie
id	string	Nie
unBlockFromCommentParams	UnBlockFromCommentParams	Nie
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: Option[UnBlockCommentPublic_200_response]

Przykład

Przykład saveCommentsBulk

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  isLive = true,
  doSpamCheck = true,
  sendEmails = false,
  populateNotifications = true,
  id = "batch-20251122",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-456",
  anonUserId = "anon-789"
)
if response.isSome:
  let unblocked = response.get()
  echo "Unblocked response received: ", unblocked
else:
  echo "No unblocked response, httpResponse: ", $httpResponse

setCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
commentTextUpdateRequest	CommentTextUpdateRequest	Nie
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[SetCommentText_200_response]

Przykład

Przykład setCommentText

Copy

let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-7890",
  broadcastId = "broadcast-456",
  commentTextUpdateRequest = CommentTextUpdateRequest(text = "Updated comment text to fix typos and add clarity."),
  editKey = "edit-key-abc123",
  sso = "sso-token-xyz"
)
if response.isSome:
  let updated = response.get()

unBlockUserFromComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
unBlockFromCommentParams	UnBlockFromCommentParams	Nie
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: Option[UnBlockCommentPublic_200_response]

Przykład

unBlockUserFromComment Przykład

Copy

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

unFlagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: Option[FlagComment_200_response]

Przykład

Przykład użycia unFlagComment

Copy

let (response, httpResponse) = client.unFlagComment(
  tenantId = "my-tenant-123",
  id = "flag-789",
  userId = "",
  anonUserId = ""
)
if response.isSome:
  let flagResponse = response.get()
  echo "Comment unflagged successfully"

unLockComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[LockComment_200_response]

Przykład

Przykład unLockComment

Copy

let (response, httpResponse) = client.unLockComment(tenantId = "my-tenant-123", commentId = "cmt-7f9a3b2d", broadcastId = "", sso = "")
if response.isSome:
  let lockResult = response.get()
  echo "Unlock response: ", $lockResult
else:
  echo "Unlock failed, HTTP response: ", $httpResponse

unPinComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[PinComment_200_response]

Przykład

unPinComment Przykład

Copy

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

updateComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updatableCommentParams	UpdatableCommentParams	Nie
contextUserId	string	Nie
doSpamCheck	bool	Nie
isLive	bool	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład użycia updateComment

Copy

let updatableCommentParams = UpdatableCommentParams(content: "Fixed a typo in the second paragraph", tags: @["article-edit", "typo"], isApproved: true)
let (response, httpResponse) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  updatableCommentParams = updatableCommentParams,
  contextUserId = "user-789",
  doSpamCheck = true,
  isLive = true
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

voteComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
urlId	string	Tak
broadcastId	string	Nie
voteBodyParams	VoteBodyParams	Nie
sessionId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[VoteComment_200_response]

Przykład

Przykład voteComment

Copy

let voteBody = VoteBodyParams()
let (response, httpResponse) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  urlId = "news/2025/fastcomments-integration",
  broadcastId = "",
  voteBodyParams = voteBody,
  sessionId = "",
  sso = ""
)
if response.isSome:
  let voteResp = response.get()
  echo "Vote recorded for comment cmt-456789"
else:
  echo "Failed to record vote"

addDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
addDomainConfigParams	AddDomainConfigParams	Nie

Odpowiedź

Zwraca: Option[AddDomainConfig_200_response]

Przykład

Przykład addDomainConfig

Copy

let (response, httpResponse) = client.addDomainConfig(tenantId = "my-tenant-123", addDomainConfigParams = AddDomainConfigParams())
if response.isSome:
  let domainConfig = response.get()
  discard domainConfig
else:
  discard httpResponse

deleteDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
domain	string	Nie

Odpowiedź

Zwraca: Option[DeleteDomainConfig_200_response]

Przykład

Przykład deleteDomainConfig

Copy

let (response, httpResponse) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let result = response.get()
  echo "Deleted domain config result: ", result
else:
  echo "No response body, HTTP status: ", $httpResponse.status

getDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
domain	string	Nie

Odpowiedź

Zwraca: Option[GetDomainConfig_200_response]

Przykład

Przykład getDomainConfig

Copy

let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let domainConfig = response.get()
  echo "Loaded domain config for tenant my-tenant-123:", $domainConfig
else:
  echo "No domain config; HTTP status:", $httpResponse.status

getDomainConfigs

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: Option[GetDomainConfigs_200_response]

Przykład

Przykład getDomainConfigs

Copy

let (response, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if response.isSome:
  let domainConfigs = response.get()
  echo "Domain configs received:"
  echo domainConfigs
else:
  echo "Failed to retrieve domain configs."
  echo httpResponse

patchDomainConfig

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
domainToUpdate	string	Nie
patchDomainConfigParams	PatchDomainConfigParams	Nie

Odpowiedź

Zwraca: Option[GetDomainConfig_200_response]

Przykład

Przykład patchDomainConfig

Copy

let (response, httpResponse) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news/article-crowdsourcing",
  patchDomainConfigParams = PatchDomainConfigParams(
    allowedOrigins = @["https://www.news-site.com"],
    moderated = true,
    maxCommentLength = 1000
  )
)
if response.isSome:
  let domainConfig = response.get()
  echo "Updated domain config received"
else:
  echo "No domain config returned"

putDomainConfig

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
domainToUpdate	string	Nie
updateDomainConfigParams	UpdateDomainConfigParams	Nie

Odpowiedź

Zwraca: Option[GetDomainConfig_200_response]

Przykład

Przykład putDomainConfig

Copy

let updateParams = UpdateDomainConfigParams(
  allowAnonymous = false,
  moderationEnabled = true,
  allowedOrigins = @["https://news.example.com"],
  maxCommentLength = 2000
)
let (response, httpResponse) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news/example-article",
  updateDomainConfigParams = updateParams
)
if response.isSome:
  let domainCfg = response.get()
  discard domainCfg

createEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createEmailTemplateBody	CreateEmailTemplateBody	Nie

Odpowiedź

Zwraca: Option[CreateEmailTemplate_200_response]

Przykład

Przykład createEmailTemplate

Copy

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

deleteEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

deleteEmailTemplate Przykład

Copy

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

deleteEmailTemplateRenderError

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
errorId	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetEmailTemplate_200_response]

Przykład

Przykład getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: Option[GetEmailTemplateDefinitions_200_response]

Przykład

Przykład getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetEmailTemplateRenderErrors_200_response]

Przykład

Przykład użycia getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetEmailTemplates_200_response]

Przykład

Przykład getEmailTemplates

Copy

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

renderEmailTemplate

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
renderEmailTemplateBody	RenderEmailTemplateBody	Nie
locale	string	Nie

Odpowiedź

Zwraca: Option[RenderEmailTemplate_200_response]

Przykład

Przykład renderEmailTemplate

Copy

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

updateEmailTemplate

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateEmailTemplateBody	UpdateEmailTemplateBody	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateEmailTemplate

Copy

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

getEventLog

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
userIdWS	string	Nie
startTime	int64	Nie
endTime	int64	Nie

Odpowiedź

Zwraca: Option[GetEventLog_200_response]

Przykład

Przykład getEventLog

Copy

let (response, httpResponse) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64
)
if response.isSome:
  let eventLog = response.get()
  echo "Received event log for ", "my-tenant-123"
else:
  echo "No event log returned. HTTP status: ", $httpResponse.status

getGlobalEventLog

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
userIdWS	string	Nie
startTime	int64	Nie
endTime	int64	Nie

Odpowiedź

Zwraca: Option[GetEventLog_200_response]

Przykład

Przykład getGlobalEventLog

Copy

let (response, httpResponse) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = int64(0),
  endTime = int64(0)
)
if response.isSome:
  let eventLog = response.get()
  echo eventLog
else:
  echo "No event log returned"

createFeedPost

Parametry

Name	Type	Wymagane
tenantId	string	Tak
createFeedPostParams	CreateFeedPostParams	Nie
broadcastId	string	Nie
isLive	bool	Nie
doSpamCheck	bool	Nie
skipDupCheck	bool	Nie

Odpowiedź

Zwraca: Option[CreateFeedPost_200_response]

Przykład

Przykład createFeedPost

Copy

let createParams = CreateFeedPostParams(
  content = "We're rolling out realtime comments to all users!",
  title = "Realtime Comments Rollout",
  url = "news/realtime-comments-rollout-2025",
  authorId = "prod-team",
  tags = @["release", "comments"]
)
let (response, httpResponse) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = createParams,
  broadcastId = "broadcast-2025-11",
  isLive = true,
  doSpamCheck = true,
  skipDupCheck = false
)
if response.isSome:
  let created = response.get()
  echo "Feed post created, id: ", $created.id
else:
  echo "Failed to create feed post, HTTP status: ", $httpResponse.statusCode

createFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createFeedPostParams	CreateFeedPostParams	Nie
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[CreateFeedPostPublic_200_response]

Przykład

Przykład createFeedPostPublic

Copy

let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(
    title = "Product Launch Announcement",
    content = "We just launched a new commenting feature to improve engagement.",
    authorId = "team-product",
    url = "news/product-launch",
    tags = @["launch", "comments"],
    isFeatured = false
  ),
  broadcastId = "broadcast-009",
  sso = ""
)
if response.isSome:
  let created = response.get()
  discard created

deleteFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postId	string	Nie
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[DeleteFeedPostPublic_200_response]

Przykład

Przykład deleteFeedPostPublic

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  broadcastId = "broadcast-789",
  sso = ""
)
if response.isSome:
  let result = response.get()

getFeedPosts

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
afterId	string	Nie
limit	int	Nie
tags	seq[string]	Nie

Odpowiedź

Zwraca: Option[GetFeedPosts_200_response]

Przykład

Przykład użycia getFeedPosts

Copy

let (response, httpResponse) = client.getFeedPosts(tenantId = "my-tenant-123", afterId = "post_abc123", limit = 20, tags = @["news", "sports"])
if response.isSome:
  let feed = response.get()
  echo "Feed posts retrieved for tenant my-tenant-123"
else:
  echo "No feed posts returned, HTTP status: ", $httpResponse.status

getFeedPostsPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
afterId	string	Nie
limit	int	Nie
tags	seq[string]	Nie
sso	string	Nie
isCrawler	bool	Nie
includeUserInfo	bool	Nie

Odpowiedź

Zwraca: Option[GetFeedPostsPublic_200_response]

Przykład

Przykład getFeedPostsPublic

Copy

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

getFeedPostsStats

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postIds	seq[string]	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[GetFeedPostsStats_200_response]

Przykład

Przykład getFeedPostsStats

Copy

let (response, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["news/article-2025-11-22", "opinion/market-trends-452"],
  sso = ""
)
if response.isSome:
  let stats = response.get()
  discard stats

getUserReactsPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postIds	seq[string]	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[GetUserReactsPublic_200_response]

Przykład

Przykład getUserReactsPublic

Copy

let (response, httpResponse) = client.getUserReactsPublic(tenantId = "my-tenant-123", postIds = @[], sso = "")
if response.isSome:
  let reacts = response.get()
  discard reacts

reactFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postId	string	Nie
reactBodyParams	ReactBodyParams	Nie
isUndo	bool	Nie
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[ReactFeedPostPublic_200_response]

Przykład

Przykład reactFeedPostPublic

Copy

let (response, httpResponse) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-title",
  reactBodyParams = ReactBodyParams(),
  isUndo = false,
  broadcastId = "broadcast-456",
  sso = ""
)
if response.isSome:
  let result = response.get()
  echo "Reaction result: ", result
else:
  echo "Reaction failed, HTTP response: ", httpResponse

updateFeedPost

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
feedPost	FeedPost	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateFeedPost

Copy

let feedPost = FeedPost(
  title: "Local Election Results",
  content: "Updated vote counts across precincts",
  tags: @["politics", "local"],
  authorId: "journalist-32",
  isPublished: true,
  views: 124
)
let (response, httpResponse) = client.updateFeedPost(tenantId = "my-tenant-123", id = "post-456", feedPost = feedPost)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

updateFeedPostPublic

Parametry

Name	Type	Required
tenantId	string	Tak
postId	string	Nie
updateFeedPostParams	UpdateFeedPostParams	Nie
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[CreateFeedPostPublic_200_response]

Przykład

Przykład updateFeedPostPublic

Copy

var updateParams: UpdateFeedPostParams = UpdateFeedPostParams(
  title = "Breaking: Service Update",
  content = "We improved feed performance and UX for all users.",
  tags = @["performance", "release"],
  isPublic = true
)
let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  updateFeedPostParams = updateParams,
  broadcastId = "broadcast-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let post = response.get()
  echo "Updated post title: ", post.title
  echo "HTTP status: ", httpResponse.status

flagCommentPublic

Parametry

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
isFlagged	bool	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład flagCommentPublic

Copy

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

addHashTag

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createHashTagBody	CreateHashTagBody	Nie

Odpowiedź

Zwraca: Option[AddHashTag_200_response]

Przykład

Przykład addHashTag

Copy

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

addHashTagsBulk

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nie

Odpowiedź

Zwraca: Option[AddHashTagsBulk_200_response]

Przykład

Przykład addHashTagsBulk

Copy

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

deleteHashTag

Parametry

Nazwa	Typ	Wymagane
tag	string	Nie
tenantId	string	Tak
deleteHashTagRequest	DeleteHashTagRequest	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład deleteHashTag

Copy

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

getHashTags

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
page	float64	Nie

Odpowiedź

Zwraca: Option[GetHashTags_200_response]

Przykład

Przykład getHashTags

Copy

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

patchHashTag

Parametry

Nazwa	Typ	Wymagane
tag	string	Nie
tenantId	string	Tak
updateHashTagBody	UpdateHashTagBody	Nie

Odpowiedź

Zwraca: Option[PatchHashTag_200_response]

Przykład

Przykład patchHashTag

Copy

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

createModerator

Parameters

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createModeratorBody	CreateModeratorBody	Nie

Odpowiedź

Zwraca: Option[CreateModerator_200_response]

Przykład

Przykład createModerator

Copy

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

deleteModerator

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
sendEmail	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład użycia deleteModerator

Copy

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

getModerator

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetModerator_200_response]

Przykład

Przykład getModerator

Copy

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

getModerators

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetModerators_200_response]

Przykład

Przykład getModerators

Copy

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

updateModerator

Parametry

Name	Type	Wymagane
tenantId	string	Tak
id	string	Nie
updateModeratorBody	UpdateModeratorBody	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateModerator

Copy

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

deleteNotificationCount

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład deleteNotificationCount

Copy

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

getCachedNotificationCount

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetCachedNotificationCount_200_response]

Przykład

Przykład getCachedNotificationCount

Copy

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

getNotificationCount

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
urlId	string	Tak
fromCommentId	string	Nie
viewed	bool	Nie

Odpowiedź

Zwraca: Option[GetNotificationCount_200_response]

Przykład

Przykład getNotificationCount

Copy

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

getNotifications

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
urlId	string	Tak
fromCommentId	string	Nie
viewed	bool	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetNotifications_200_response]

Przykład

Przykład getNotifications

Copy

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

updateNotification

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateNotificationBody	UpdateNotificationBody	Nie
userId	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateNotification

Copy

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

addPage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPIPageData	CreateAPIPageData	Nie

Odpowiedź

Zwraca: Option[AddPageAPIResponse]

Przykład

Przykład addPage

Copy

var createData: CreateAPIPageData
createData.url = "news/nim-4-release"
createData.title = "Nim 4 Release Coverage"
createData.path = "/news/nim-4-release"
createData.isEnabled = true
createData.tags = @["nim", "release"]
createData.description = "Coverage of Nim 4 release"
let (response, httpResponse) = client.addPage(tenantId = "my-tenant-123", createAPIPageData = createData)
if response.isSome:
  let pageResp = response.get()
  echo pageResp

deletePage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[DeletePageAPIResponse]

Przykład

Przykład deletePage

Copy

let (response, httpResponse) = client.deletePage(tenantId = "site-tenant-456", id = "news/winter-updates-2025")
if response.isSome:
  let deleted = response.get()
  echo "DeletePageAPIResponse:", deleted
else:
  echo "Delete failed, HTTP response:", httpResponse

getPageByURLId

Parametry

Name	Type	Required	Description
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: Option[GetPageByURLIdAPIResponse]

Przykład

Przykład getPageByURLId

Copy

let (response, httpResponse) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let page = response.get()
  echo "Page ID: ", page.id
  echo "Title: ", page.title
  echo "URL: ", page.url
  echo "Published: ", $page.published
  echo "Tags: ", $page.tags
else:
  echo "No page found. HTTP status: ", httpResponse.statusCode

getPages

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: Option[GetPagesAPIResponse]

Przykład

Przykład getPages

Copy

let (response, httpResponse) = client.getPages(tenantId = "news-site-456")
if response.isSome:
  let pages = response.get()
  echo "Received pages response: ", pages
else:
  echo "No pages returned. HTTP response: ", httpResponse

patchPage

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateAPIPageData	UpdateAPIPageData	Nie

Odpowiedź

Zwraca: Option[PatchPageAPIResponse]

Przykład

Przykład patchPage

Copy

let updateData = UpdateAPIPageData(
  title = "Breaking: Major Event Update",
  urlId = "news/major-event-update",
  visible = true,
  tags = @["breaking", "headline"],
  sortOrder = 5
)
let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/major-event-update",
  updateAPIPageData = updateData
)
if response.isSome:
  let page = response.get()
  discard page

deletePendingWebhookEvent

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

deletePendingWebhookEvent Przykład

Copy

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

getPendingWebhookEventCount

Parametry

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
externalId	string	Nie
eventType	string	Nie
domain	string	Nie
attemptCountGT	float64	Nie

Odpowiedź

Zwraca: Option[GetPendingWebhookEventCount_200_response]

Przykład

Przykład getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
externalId	string	Nie
eventType	string	Nie
domain	string	Nie
attemptCountGT	float64	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetPendingWebhookEvents_200_response]

Przykład

Przykład użycia getPendingWebhookEvents

Copy

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

createQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionConfigBody	CreateQuestionConfigBody	Nie

Odpowiedź

Zwraca: Option[CreateQuestionConfig_200_response]

Przykład

Przykład createQuestionConfig

Copy

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

deleteQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład deleteQuestionConfig

Copy

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

getQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetQuestionConfig_200_response]

Przykład

getQuestionConfig Przykład

Copy

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

getQuestionConfigs

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetQuestionConfigs_200_response]

Przykład

Przykład getQuestionConfigs

Copy

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

updateQuestionConfig

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateQuestionConfigBody	UpdateQuestionConfigBody	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateQuestionConfig

Copy

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

createQuestionResult

Parametry

Name	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionResultBody	CreateQuestionResultBody	Nie

Odpowiedź

Zwraca: Option[CreateQuestionResult_200_response]

Przykład

Przykład createQuestionResult

Copy

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

deleteQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład deleteQuestionResult

Copy

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

getQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetQuestionResult_200_response]

Przykład

Przykład getQuestionResult

Copy

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

getQuestionResults

Parametry

Name	Type	Required
tenantId	string	Tak
urlId	string	Tak
userId	string	Nie
startDate	string	Nie
questionId	string	Nie
questionIds	string	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetQuestionResults_200_response]

Przykład

Przykład getQuestionResults

Copy

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

updateQuestionResult

Parametry

Name	Type	Wymagane
tenantId	string	Tak
id	string	Nie
updateQuestionResultBody	UpdateQuestionResultBody	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateQuestionResult

Copy

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

aggregateQuestionResults

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
questionId	string	Nie
questionIds	seq[string]	Nie
urlId	string	Tak
timeBucket	AggregateTimeBucket	Nie
startDate	string	Nie
forceRecalculate	bool	Nie

Odpowiedź

Zwraca: Option[AggregateQuestionResults_200_response]

Przykład

Przykład aggregateQuestionResults

Copy

let (response, httpResponse) = client.aggregateQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "",
  questionIds = @[],
  urlId = "news/economy/budget-2025",
  timeBucket = AggregateTimeBucket(0),
  startDate = "",
  forceRecalculate = false
)
if response.isSome:
  let aggResults = response.get()
  discard aggResults

bulkAggregateQuestionResults

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Nie
forceRecalculate	bool	Nie

Odpowiedź

Zwraca: Option[BulkAggregateQuestionResults_200_response]

Przykład

Przykład bulkAggregateQuestionResults

Copy

let request = BulkAggregateQuestionResultsRequest()
let (response, httpResponse) = client.bulkAggregateQuestionResults(tenantId = "my-tenant-123", bulkAggregateQuestionResultsRequest = request, forceRecalculate = false)
if response.isSome:
  let aggregated = response.get()
  echo aggregated

combineCommentsWithQuestionResults

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
questionId	string	Nie
questionIds	seq[string]	Nie
urlId	string	Tak
startDate	string	Nie
forceRecalculate	bool	Nie
minValue	float64	Nie
maxValue	float64	Nie
limit	float64	Nie

Odpowiedź

Zwraca: Option[CombineCommentsWithQuestionResults_200_response]

Przykład

Przykład combineCommentsWithQuestionResults

Copy

let (response, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "q-9876",
  questionIds = @["q-9876", "q-9877"],
  urlId = "news/article-title",
  startDate = "2025-01-01T00:00:00Z",
  forceRecalculate = false,
  minValue = 1.0,
  maxValue = 5.0,
  limit = 100.0
)
if response.isSome:
  let combined = response.get()
  discard combined

addSSOUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPISSOUserData	CreateAPISSOUserData	Nie

Odpowiedź

Zwraca: Option[AddSSOUserAPIResponse]

Przykład

Przykład addSSOUser

Copy

let (response, httpResponse) = client.addSSOUser(
  tenantId = "my-tenant-123",
  createAPISSOUserData = CreateAPISSOUserData(
    id = "sso-456",
    email = "alice.johnson@newsorg.com",
    name = "Alice Johnson",
    roles = @["editor", "contributor"],
    isActive = true,
    isAdmin = false
  )
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp
else:
  discard httpResponse

deleteSSOUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
deleteComments	bool	Nie
commentDeleteMode	string	Nie

Odpowiedź

Zwraca: Option[DeleteSSOUserAPIResponse]

Przykład

Przykład deleteSSOUser

Copy

let (response, httpResponse) = client.deleteSSOUser(tenantId = "my-tenant-123", id = "sso-user-9876", deleteComments = true, commentDeleteMode = "hard")
if response.isSome:
  let deleted = response.get()
  discard deleted
else:
  discard httpResponse

getSSOUserByEmail

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
email	string	Nie

Odpowiedź

Zwraca: Option[GetSSOUserByEmailAPIResponse]

Przykład

Przykład getSSOUserByEmail

Copy

let (response, httpResponse) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "alice@newsco.com")
if response.isSome:
  let ssoUser = response.get()
  echo "SSO user found: ", ssoUser.email
else:
  echo "No SSO user found. HTTP status: ", httpResponse.status

getSSOUserById

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetSSOUserByIdAPIResponse]

Przykład

Przykład użycia getSSOUserById

Copy

let (response, httpResponse) = client.getSSOUserById(tenantId = "my-tenant-123", id = "user-789")
if response.isSome:
  let ssoUser: GetSSOUserByIdAPIResponse = response.get()
  echo "SSO user retrieved: ", $ssoUser
else:
  echo "No SSO user found, HTTP status: ", httpResponse.statusCode

getSSOUsers

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	int	Nie

Odpowiedź

Zwraca: Option[GetSSOUsers_200_response]

Przykład

Przykład getSSOUsers

Copy

let (response, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if response.isSome:
  let ssoUsers = response.get()
  echo "Fetched SSO users:"
  echo ssoUsers
else:
  echo "No SSO users returned, HTTP status: ", httpResponse.statusCode

patchSSOUser

Parametry

Name	Type	Required
tenantId	string	Tak
id	string	Nie
updateAPISSOUserData	UpdateAPISSOUserData	Nie
updateComments	bool	Nie

Odpowiedź

Zwraca: Option[PatchSSOUserAPIResponse]

Przykład

Przykład patchSSOUser

Copy

let (response, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-987",
    username = "j.smith",
    email = "j.smith@news.example.com",
    displayName = "John Smith",
    roles = @["author", "editor"],
    avatarUrl = "https://cdn.news.example.com/avatars/j.smith.png"
  ),
  updateComments = true
)
if response.isSome:
  let patched = response.get()
  echo patched

putSSOUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateAPISSOUserData	UpdateAPISSOUserData	Nie
updateComments	bool	Nie

Odpowiedź

Zwraca: Option[PutSSOUserAPIResponse]

Przykład

putSSOUser Przykład

Copy

let (response, httpResponse) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-789",
    displayName = "Jane Doe",
    email = "jane.doe@example.com",
    avatarUrl = "https://cdn.news-site.com/avatars/jane.jpg",
    roles = @["member", "subscriber"]
  ),
  updateComments = true
)
if response.isSome:
  let result = response.get()
  echo "SSO user updated:", result

createSubscription

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Nie

Odpowiedź

Zwraca: Option[CreateSubscriptionAPIResponse]

Przykład

Przykład createSubscription

Copy

let createData = CreateAPIUserSubscriptionData(
  subscriberId = "user-987",
  email = "jane.doe@newsreader.com",
  urlId = "news/local-weather",
  active = true,
  tags = @["weather", "local"],
  frequency = "immediate"
)
let (response, httpResponse) = client.createSubscription(tenantId = "my-tenant-123", createAPIUserSubscriptionData = createData)
if response.isSome:
  let created = response.get()
  echo "Created subscription id: ", created.id

deleteSubscription

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
userId	string	Nie

Odpowiedź

Zwraca: Option[DeleteSubscriptionAPIResponse]

Przykład

Przykład deleteSubscription

Copy

let (response, httpResponse) = client.deleteSubscription(tenantId = "my-tenant-123", id = "sub-98765", userId = "user-456")
if response.isSome:
  let deleteResp = response.get()
  echo "Delete subscription response received"
else:
  echo "No subscription response"

getSubscriptions

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string	Nie

Odpowiedź

Zwraca: Option[GetSubscriptionsAPIResponse]

Przykład

Przykład getSubscriptions

Copy

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

getTenantDailyUsages

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
yearNumber	float64	Nie
monthNumber	float64	Nie
dayNumber	float64	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetTenantDailyUsages_200_response]

Przykład

Przykład getTenantDailyUsages

Copy

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

createTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantPackageBody	CreateTenantPackageBody	Nie

Odpowiedź

Zwraca: Option[CreateTenantPackage_200_response]

Przykład

Przykład createTenantPackage

Copy

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

deleteTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład deleteTenantPackage

Copy

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

getTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetTenantPackage_200_response]

Przykład

getTenantPackage Przykład

Copy

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

getTenantPackages

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetTenantPackages_200_response]

Przykład

Przykład getTenantPackages

Copy

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

replaceTenantPackage

Parametry

Name	Type	Required
tenantId	string	Tak
id	string	Nie
replaceTenantPackageBody	ReplaceTenantPackageBody	Nie

Response

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład replaceTenantPackage

Copy

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

updateTenantPackage

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateTenantPackageBody	UpdateTenantPackageBody	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateTenantPackage

Copy

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

createTenantUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantUserBody	CreateTenantUserBody	Nie

Odpowiedź

Zwraca: Option[CreateTenantUser_200_response]

Przykład

Przykład createTenantUser

Copy

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

deleteTenantUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
deleteComments	string	Nie
commentDeleteMode	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład deleteTenantUser

Copy

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

getTenantUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetTenantUser_200_response]

Przykład

Przykład getTenantUser

Copy

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

getTenantUsers

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetTenantUsers_200_response]

Przykład

Przykład getTenantUsers

Copy

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

replaceTenantUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
replaceTenantUserBody	ReplaceTenantUserBody	Nie
updateComments	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład replaceTenantUser

Copy

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

sendLoginLink

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
redirectURL	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład sendLoginLink

Copy

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

updateTenantUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateTenantUserBody	UpdateTenantUserBody	Nie
updateComments	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateTenantUser

Copy

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

createTenant

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantBody	CreateTenantBody	Nie

Odpowiedź

Zwraca: Option[CreateTenant_200_response]

Przykład

Przykład createTenant

Copy

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

deleteTenant

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
sure	string	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

deleteTenant Przykład

Copy

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

getTenant

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetTenant_200_response]

Przykład

Przykład getTenant

Copy

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

getTenants

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
meta	string	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetTenants_200_response]

Przykład

Przykład getTenants

Copy

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

updateTenant

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateTenantBody	UpdateTenantBody	Nie

Odpowiedź

Zwraca: Option[FlagCommentPublic_200_response]

Przykład

Przykład updateTenant

Copy

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

uploadImage

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
file	string	Nie
sizePreset	SizePreset	Nie
urlId	string	Tak

Odpowiedź

Zwraca: Option[UploadImageResponse]

Przykład

Przykład uploadImage

Copy

let (response, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "assets/images/comment-avatar.jpg",
  sizePreset = SizePreset.small,
  urlId = "news/article-2025-11-22"
)
if response.isSome:
  let upload = response.get()
  echo "Uploaded image id: ", upload.id
  echo "Uploaded image url: ", upload.url

getUserBadgeProgressById

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetUserBadgeProgressById_200_response]

Przykład

Przykład getUserBadgeProgressById

Copy

let (response, httpResponse) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "editor-badge-42")
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress received:"
  echo badgeProgress
else:
  echo "No badge progress found for tenant 'my-tenant-123' and id 'editor-badge-42'"
  echo httpResponse

getUserBadgeProgressByUserId

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string	Nie

Odpowiedź

Zwraca: Option[GetUserBadgeProgressById_200_response]

Przykład

Przykład getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
limit	float64	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetUserBadgeProgressList_200_response]

Przykład

Przykład getUserBadgeProgressList

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(tenantId = "my-tenant-123", userId = "user-9823", limit = 25.0, skip = 0.0)
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress received:", badgeProgress
else:
  echo "No badge progress. HTTP response:", httpResponse.status

createUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createUserBadgeParams	CreateUserBadgeParams	Nie

Odpowiedź

Zwraca: Option[CreateUserBadge_200_response]

Przykład

Przykład createUserBadge

Copy

let (response, httpResponse) = client.createUserBadge(tenantId = "my-tenant-123",
  createUserBadgeParams = CreateUserBadgeParams(userId = "user-987", badgeId = "top-commenter"))
if response.isSome:
  let createdBadge = response.get()
  echo "Created badge for user: ", createdBadge.userId
else:
  echo "Failed to create badge, status: ", $httpResponse.status

deleteUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[UpdateUserBadge_200_response]

Przykład

Przykład deleteUserBadge

Copy

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

getUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetUserBadge_200_response]

Przykład

Przykład getUserBadge

Copy

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

getUserBadges

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
badgeId	string	Nie
displayedOnComments	bool	Nie
limit	float64	Nie
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetUserBadges_200_response]

Przykład

Przykład użycia getUserBadges

Copy

let (response, httpResponse) = client.getUserBadges(
  tenantId = "my-tenant-123",
  userId = "user-789",
  badgeId = "top-commenter",
  displayedOnComments = true,
  limit = 50.0,
  skip = 0.0
)
if response.isSome:
  let badges = response.get()
  echo "Retrieved badges: ", $badges

updateUserBadge

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updateUserBadgeParams	UpdateUserBadgeParams	Nie

Odpowiedź

Zwraca: Option[UpdateUserBadge_200_response]

Przykład

Przykład updateUserBadge

Copy

let updateParams = UpdateUserBadgeParams(
  name = "Top Contributor",
  description = "Awarded for consistent high-quality comments",
  active = true,
  tags = @["community", "milestone"]
)
let (response, httpResponse) = client.updateUserBadge(tenantId = "my-tenant-123", id = "badge-456", updateUserBadgeParams = updateParams)
if response.isSome:
  let updated = response.get()
  echo "Badge updated successfully"
else:
  echo "Failed to update badge, HTTP status: ", $httpResponse.status

getUserNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
sso	string	No

Odpowiedź

Zwraca: Option[GetUserNotificationCount_200_response]

Przykład

Przykład getUserNotificationCount

Copy

let (response, httpResponse) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if response.isSome:
  let notificationData = response.get()
  echo "Received notification data: ", $notificationData
else:
  echo "No notification data returned. HTTP response: ", $httpResponse.status

getUserNotifications

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
pageSize	int	Nie
afterId	string	Nie
includeContext	bool	Nie
afterCreatedAt	int64	Nie
unreadOnly	bool	Nie
dmOnly	bool	Nie
noDm	bool	Nie
includeTranslations	bool	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[GetUserNotifications_200_response]

Przykład

Przykład getUserNotifications

Copy

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

resetUserNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: Option[ResetUserNotifications_200_response]

Przykład

Przykład resetUserNotificationCount

Copy

let (response, httpResponse) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "sso-jwt-9a8b7c6d")
if response.isSome:
  let resetResult = response.get()
  echo resetResult
else:
  echo "Reset failed, status: ", httpResponse.status

resetUserNotifications

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
afterId	string	Nie
afterCreatedAt	int64	Nie
unreadOnly	bool	Nie
dmOnly	bool	Nie
noDm	bool	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[ResetUserNotifications_200_response]

Przykład

Przykład resetUserNotifications

Copy

let (response, httpResponse) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  afterId = "",
  afterCreatedAt = int64(0),
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  sso = ""
)
if response.isSome:
  let result = response.get()

updateUserNotificationCommentSubscriptionStatus

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
notificationId	string	Nie
optedInOrOut	string	Nie
commentId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: Option[UpdateUserNotificationStatus_200_response]

Przykład

Przykład updateUserNotificationCommentSubscriptionStatus

Copy

let (response, httpResponse) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  optedInOrOut = "opted_in",
  commentId = "cmt-789",
  sso = "sso-token-abc"
)
if response.isSome:
  let updatedStatus = response.get()
  discard updatedStatus
else:
  discard httpResponse

updateUserNotificationPageSubscriptionStatus

Parametry

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

Odpowiedź

Zwraca: Option[UpdateUserNotificationStatus_200_response]

Przykład

Przykład updateUserNotificationPageSubscriptionStatus

Copy

let (response, httpResponse) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-2025-11-22",
  url = "https://example.com/news/article-2025-11-22",
  pageTitle = "Breaking News: Market Update",
  subscribedOrUnsubscribed = "subscribed",
  sso = "sso-token-abc123"
)
if response.isSome:
  let result = response.get()
  discard result

updateUserNotificationStatus

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
notificationId	string	Nie
newStatus	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[UpdateUserNotificationStatus_200_response]

Przykład

Przykład updateUserNotificationStatus

Copy

let (response, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = "sso-abc-789"
)
if response.isSome:
  let updateResp = response.get()
  discard updateResp

getUserPresenceStatuses

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlIdWS	string	Nie
userIds	string	Nie

Odpowiedź

Zwraca: Option[GetUserPresenceStatuses_200_response]

Przykład

Przykład getUserPresenceStatuses

Copy

let (response, httpResponse) = client.getUserPresenceStatuses(
  tenantId = "my-tenant-123",
  urlIdWS = "news/2025/technology/ai-ethics",
  userIds = "user-789,user-456"
)
if response.isSome:
  let presence = response.get()
  echo "Presence received: ", presence
else:
  echo "No presence information returned, HTTP status: ", httpResponse.status.code

searchUsers

Parametry

Name	Type	Required
tenantId	string	Tak
urlId	string	Tak
usernameStartsWith	string	Nie
mentionGroupIds	seq[string]	Nie
sso	string	Nie

Odpowiedź

Zwraca: Option[SearchUsers_200_response]

Przykład

Przykład searchUsers

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  usernameStartsWith = "jo",
  mentionGroupIds = @["editors", "sports-team"],
  sso = "sso-abc-456"
)
if response.isSome:
  let users = response.get()
  echo "Users found: ", users
else:
  echo "No users found; HTTP status: ", httpResponse.status

getUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetUser_200_response]

Przykład

Przykład getUser

Copy

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

createVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
direction	string	Nie
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: Option[VoteComment_200_response]

Przykład

Przykład createVote

Copy

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

deleteVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
editKey	string	Nie

Odpowiedź

Zwraca: Option[DeleteCommentVote_200_response]

Przykład

Przykład deleteVote

Copy

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

getVotes

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: Option[GetVotes_200_response]

Przykład

Przykład getVotes

Copy

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

getVotesForUser

Parametry

Name	Type	Wymagane
tenantId	string	Tak
urlId	string	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: Option[GetVotesForUser_200_response]

Przykład

Przykład getVotesForUser

Copy

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

Potrzebujesz pomocy?

Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące Nim SDK, prosimy:

Wkład

Wkład jest mile widziany! Odwiedź repozytorium GitHub w celu zapoznania się z wytycznymi dotyczącymi kontrybucji.

Język 🇵🇱 Polski

Dokumentacja

Pierwsze kroki

Referencja API

Użycie

Agregacja

Dzienniki audytu

Blokowanie z komentarza

Sprawdzanie zablokowanych komentarzy

Komentarze

Konfiguracje domen

Szablony e-mail

Dziennik zdarzeń

Posty

Zgłoś komentarz

Hashtagi

Moderatorzy

Liczba powiadomień

Powiadomienia

Strony

Oczekujące zdarzenia webhook

Konfiguracje pytań

Wyniki pytań

Agregacja wyników pytań

Użytkownicy SSO

Subskrypcje

Dzienne użycie najemcy

Pakiety najemcy

Użytkownicy najemcy

Najemcy

Przesyłanie obrazu

Postęp odznaki użytkownika

Odznaki użytkownika

Powiadomienia użytkownika

Status obecności użytkownika

Wyszukiwanie użytkowników

Użytkownicy

Głosy

FastComments Nim SDK

Repozytorium

Wymagania

Instalacja

Korzystanie z Nimble

Budowanie ze źródeł

Zawartość biblioteki

Publiczne vs Zabezpieczone API

Dla klienta API istnieją dwa moduły API, api_default i api_public. 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.

Szybki start

Używanie uwierzytelnionych API (DefaultAPI)

Używanie publicznych API (PublicAPI)

Typowe problemy

Wykonywanie wywołań API

Przykład: Pobieranie komentarzy

Uwagi

Identyfikatory Broadcast

SSO (Logowanie jednokrotne)

Użycie SSO

Proste SSO

Bezpieczne SSO

Dokumentacja fastcomments

Dokumentacja fastcomments

Dokumentacja punktów końcowych API

Dokumentacja modeli

Dokumentacja autoryzacji

api_key

aggregate

Parametry

Odpowiedź

Przykład

getAuditLogs

Parametry

Odpowiedź

Przykład

blockFromCommentPublic

Parametry

Odpowiedź

Przykład

unBlockCommentPublic

Parametry

Odpowiedź

Dla klienta API istnieją dwa moduły API, `api_default` i `api_public`. `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.