FastComments SDK dla Nim

To jest oficjalny SDK Nim dla FastComments.

Oficjalny SDK Nim dla API FastComments

Repozytorium

Wymagania

Nim >= 1.6.0
nimcrypto >= 0.5.4

Instalacja

Używanie Nimble

nimble install fastcomments

Budowanie ze źródła

nimble build

Zawartość Biblioteki

Ta biblioteka zawiera wygenerowanego klienta API oraz narzędzia SSO ułatwiające pracę z API.

Dokumentacja Biblioteki Klienta API

Publiczne vs Zabezpieczone API

Dla klienta API istnieją trzy moduły API: api_default, api_public i api_moderation. api_default zawiera metody wymagające klucza API, a api_public zawiera wywołania API, które można wykonać bezpośrednio z przeglądarki/urządzenia mobilnego itp. bez uwierzytelnienia. Moduł api_moderation zawiera metody przeznaczone do panelu moderatora.

Moduł api_moderation oferuje rozbudowany zestaw szybkich i bieżących API moderacji. Każda metoda api_moderation przyjmuje parametr sso i może uwierzytelnić się za pomocą SSO lub ciasteczka sesyjnego FastComments.com.

Szybki start

Using Authenticated APIs (DefaultAPI)

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

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

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

# Wykonaj uwierzytelnione wywołania API.
# Wymagane parametry (i ciało żądania) są pozycyjne; opcjonalne
# parametry są przekazywane za pomocą obiektu opcji operacji.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Using Public APIs (PublicAPI)

Public endpoints don't require authentication:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Wykonaj publiczne wywołania API.
# tenantId i urlId są wymagane (pozycyjne); wszystko inne jest opcjonalne.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Using Moderation APIs (ModerationAPI)

Moderation endpoints power the moderator dashboard and are authenticated with an SSO token for the acting moderator:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Lista komentarzy w panelu moderacji.
# Ta operacja nie ma wymaganych parametrów, więc wszystko jest opcjonalne.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Common Issues

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

Making API Calls

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

Wymagane parametry i ciało żądania są przekazywane pozycyjnie. Pozostałe opcjonalne parametry są zbierane w pojedynczy obiekt Api<Operation>Options, który jest ostatnim argumentem. Operacje bez parametrów opcjonalnych nie przyjmują obiektu opcji.

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",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    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"

Notatki

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

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

Klasa	Metoda	Żądanie HTTP	Opis
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Agreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele 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	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
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	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Poprzedni komentatorzy na stronie, którzy NIE są aktualnie online. Sortowani według displayName. Użyj tego po wyczerpaniu /users/online, aby wyświetlić sekcję "Members". Paginacja kursora po commenterName: serwer przegląda częściowy indeks {tenantId, urlId, commenterName} od afterName do przodu za pomocą $gt, bez kosztu $skip.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Obecnie online przeglądający stronę: osoby, których sesja websocket jest aktualnie subskrybowana do tej strony. Zwraca anonCount + totalCount (subskrybenci całego pokoju, w tym anonimowi przeglądający, których nie wymieniamy).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Lista stron dla najemcy. Używana przez klienta desktopowego FChat do wypełnienia listy pokoi. Wymaga, aby `enableFChat` było ustawione na true w rozwiązywanej konfiguracji niestandardowej każdej strony. Strony wymagające SSO są filtrowane w oparciu o dostęp grupowy użytkownika żądającego.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
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	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
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 subskrybują stronę, powiadomienia są tworzone dla nowych komentarzy głównych, oraz 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

aggregate

Agreguje dokumenty poprzez grupowanie ich (jeśli podano groupBy) i stosowanie wielu operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg, itp.).

Parametry

Name	Type	Required
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Odpowiedź

Zwraca: Option[AggregateResponse]

Przykład

Przykład agregacji

Copy

let (aggResp, httpResp) = client.aggregate(tenantId = "my-tenant-123", aggregationRequest = AggregationRequest(), options = AggregateOptions())
if aggResp.isSome:
  let response = aggResp.get()
  echo response
echo httpResp

getAuditLogs

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetAuditLogsOptions	Nie

Odpowiedź

Zwraca: Option[GetAuditLogsResponse]

Przykład

Przykład getAuditLogs

Copy

let (auditOpt, httpResp) = client.getAuditLogs(tenantId = "my-tenant-123", options = GetAuditLogsOptions())
if auditOpt.isSome:
  let audit = auditOpt.get()
  echo audit

logoutPublic

Response

Zwraca: Option[APIEmptyResponse]

Przykład

logoutPublic Przykład

Copy

let (responseOpt, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", userId = "user-456")
if responseOpt.isSome:
  let emptyResponse = responseOpt.get()

blockFromCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nie
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[BlockSuccess]

Przykład

blockFromCommentPublic Przykład

Copy

let (blockOpt, httpResp) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if blockOpt.isSome:
  let block = blockOpt.get()

unBlockCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nie
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[UnblockSuccess]

Przykład

Przykład unBlockCommentPublic

Copy

let (unblockResult, httpResp) = client.unBlockCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if unblockResult.isSome:
  let result = unblockResult.get()

checkedCommentsForBlocked

Parametry

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

Odpowiedź

Zwraca: Option[CheckBlockedCommentsResponse]

Przykład

Przykład checkedCommentsForBlocked

Copy

let (maybeResponse, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "cmt-1,cmt-2",
  sso = ""
)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  discard response

blockUserFromComment

Parameters

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

Response

Zwraca: Option[BlockSuccess]

Example

blockUserFromComment Przykład

Copy

let params = BlockFromCommentParams()
let opts = BlockUserFromCommentOptions()
let (blockResult, httpResp) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  blockFromCommentParams = params,
  options = opts
)
if blockResult.isSome:
  let success = blockResult.get()
  discard success

createCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Odpowiedź

Zwraca: Option[SaveCommentsResponseWithPresence]

Przykład

createCommentPublic Przykład

Copy

let
  tenantId = "my-tenant-123"
  urlId = "news/article-title"
  broadcastId = "broadcast-456"
  commentData = CommentData()
  options = CreateCommentPublicOptions()
let (maybeResp, httpResp) = client.createCommentPublic(
  tenantId = tenantId,
  urlId = urlId,
  broadcastId = broadcastId,
  commentData = commentData,
  options = options)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

deleteComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Odpowiedź

Zwraca: Option[DeleteCommentResult]

Przykład

Przykład deleteComment

Copy

let (delResult, httpResponse) = client.deleteComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  options = DeleteCommentOptions()
)
if delResult.isSome:
  let result = delResult.get()
  echo result

deleteCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
options	DeleteCommentPublicOptions	Nie

Odpowiedź

Zwraca: Option[PublicAPIDeleteCommentResponse]

Przykład

deleteCommentPublic Przykład

Copy

let (responseOpt, httpResp) = client.deleteCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "",
  options = DeleteCommentPublicOptions())
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

deleteCommentVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
voteId	string	Nie
urlId	string	Tak
broadcastId	string	Nie
options	DeleteCommentVoteOptions	Nie

Odpowiedź

Zwraca: Option[VoteDeleteResponse]

Przykład

deleteCommentVote Przykład

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  voteId = "vote-789",
  urlId = "news/article-title",
  broadcastId = "broadcast-001",
  options = DeleteCommentVoteOptions()
)
if response.isSome:
  let voteDelete = response.get()

flagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
options	FlagCommentOptions	No

Odpowiedź

Zwraca: Option[FlagCommentResponse]

Przykład

flagComment Przykład

Copy

let options = FlagCommentOptions(reason: "spam content", note: "Automated posting detected", isSpam: true, categories: @["spam"])
let (flagRes, httpRes) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-789", options = options)
if flagRes.isSome:
  let res = flagRes.get()
  discard res

getComment

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
id	string	No

Odpowiedź

Zwraca: Option[APIGetCommentResponse]

Przykład

Przykład getComment

Copy

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

getComments

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
options	GetCommentsOptions	No

Odpowiedź

Zwraca: Option[APIGetCommentsResponse]

Przykład

Przykład getComments

Copy

let options = GetCommentsOptions(
  urlId = "news/article-title",
  page = 0,
  pageSize = 20,
  sort = "newest",
  includeDeleted = false,
  includeReplies = true,
  userIds = @[],
  tags = @[]
)
let (response, httpResponse) = client.getComments(tenantId = "my-tenant-123", options = options)
if response.isSome:
  let comments = response.get()
  discard comments

getCommentsPublic

req tenantId urlId

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
urlId	string	Yes
options	GetCommentsPublicOptions	No

Odpowiedź

Zwraca: Option[GetCommentsResponseWithPresencePublicComment]

Przykład

getCommentsPublic Przykład

Copy

let (optResp, httpResp) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetCommentsPublicOptions(
    page = 0,
    pageSize = 10,
    includeDeleted = false,
    tags = @[]
  )
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
options	GetCommentTextOptions	Nie

Odpowiedź

Zwraca: Option[PublicAPIGetCommentTextResponse]

Przykład

Przykład getCommentText

Copy

let (maybeResponse, httpResponse) = client.getCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = GetCommentTextOptions()
)
if maybeResponse.isSome:
  let response = maybeResponse.get()

getCommentVoteUserNames

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
dir	int	No
sso	string = ""	No

Odpowiedź

Zwraca: Option[GetCommentVoteUserNamesSuccessResponse]

Przykład

Przykład getCommentVoteUserNames

Copy

let (voteNamesOpt, httpRes) = client.getCommentVoteUserNames(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  dir = 0,
  sso = ""
)
if voteNamesOpt.isSome:
  let voteNames = voteNamesOpt.get()
  echo voteNames

lockComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład lockComment

Copy

let (lockResult, httpRes) = client.lockComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  broadcastId = "",
  sso = "")
if lockResult.isSome:
  let resp = lockResult.get()
  discard resp

pinComment

Parameters

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
sso	string = ""	Nie

Response

Zwraca: Option[ChangeCommentPinStatusResponse]

Example

pinComment Przykład

Copy

let (pinResult, httpResp) = client.pinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = "",
)
if pinResult.isSome:
  let response = pinResult.get()
  echo response

saveComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createCommentParams	CreateCommentParams	Nie
options	SaveCommentOptions	Nie

Odpowiedź

Zwraca: Option[APISaveCommentResponse]

Przykład

saveComment Przykład

Copy

let commentParams = CreateCommentParams(
  body: "Great read, thanks!",
  name: "Alice Smith",
  email: "alice@example.com",
  parentId: ""
)
let saveOpts = SaveCommentOptions(
  isPreview: false,
  isApproved: true,
  skipSpamCheck: false
)
let (apiResponse, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = commentParams,
  options = saveOpts
)
if apiResponse.isSome:
  let saved = apiResponse.get()
  echo saved

saveCommentsBulk

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createCommentParams	seq[CreateCommentParams]	Nie
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Nie
id	string	Nie
fromName	string	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

saveCommentsBulk Przykład

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  options = SaveCommentsBulkOptions(),
  id = "",
  fromName = ""
)
if response.isSome:
  let result = response.get()

setCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Nie
commentTextUpdateRequest	CommentTextUpdateRequest	Nie
options	SetCommentTextOptions	Nie

Odpowiedź

Zwraca: Option[PublicAPISetCommentTextResponse]

Przykład

Przykład setCommentText

Copy

let commentUpdate = CommentTextUpdateRequest(text: "Updated comment text")
let opts = SetCommentTextOptions()
let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  broadcastId = "broadcast-789",
  commentTextUpdateRequest = commentUpdate,
  options = opts)
if response.isSome:
  let result = response.get()

unBlockUserFromComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
unBlockFromCommentParams	UnBlockFromCommentParams	Nie
options	UnBlockUserFromCommentOptions	Nie

Odpowiedź

Zwraca: Option[UnblockSuccess]

Przykład

Przykład unBlockUserFromComment

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  unBlockFromCommentParams = UnBlockFromCommentParams(userId = "user-789", commentId = "cmt-321"),
  options = UnBlockUserFromCommentOptions(),
)
if response.isSome:
  let unblockSuccess = response.get()

unFlagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
options	UnFlagCommentOptions	Nie

Odpowiedź

Zwraca: Option[FlagCommentResponse]

Przykład

unFlagComment Przykład

Copy

let (flagRespOpt, httpResp) = client.unFlagComment(tenantId = "my-tenant-123", id = "comment-456", options = UnFlagCommentOptions())
if flagRespOpt.isSome:
  let flagResp = flagRespOpt.get()

unLockComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład unLockComment

Copy

let (maybeEmpty, httpResp) = client.unLockComment(tenantId = "my-tenant-123", commentId = "comment-456", broadcastId = "", sso = "")
if maybeEmpty.isSome:
  let emptyResp = maybeEmpty.get()
  echo "Comment unlocked"
else:
  echo "Failed to unlock comment"

unPinComment

Parametry

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

Odpowiedź

Zwraca: Option[ChangeCommentPinStatusResponse]

Przykład

unPinComment Przykład

Copy

let (responseOpt, httpResponse) = client.unPinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = ""
)
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

updateComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
updatableCommentParams	UpdatableCommentParams	Nie
options	UpdateCommentOptions	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład updateComment

Copy

let commentParams = UpdatableCommentParams(content: "Updated comment content")
let updateOpts = UpdateCommentOptions(force: false)
let (respOpt, httpResp) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  updatableCommentParams = commentParams,
  options = updateOpts
)
if respOpt.isSome:
  let resp = respOpt.get()

voteComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
urlId	string	Tak
broadcastId	string	Nie
voteBodyParams	VoteBodyParams	Nie
options	VoteCommentOptions	Nie

Odpowiedź

Zwraca: Option[VoteResponse]

Przykład

Przykład voteComment

Copy

let (voteRespOpt, httpResp) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  urlId = "blog/how-to-code",
  broadcastId = "",
  voteBodyParams = VoteBodyParams(),
  options = VoteCommentOptions()
)
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()

---

getCommentsForUser

Parametry

Nazwa	Typ	Wymagane	Opis
options	GetCommentsForUserOptions	Nie

Odpowiedź

Zwraca: Option[GetCommentsForUserResponse]

Przykład

getCommentsForUser Przykład

Copy

let (maybeResp, httpResp) = client.getCommentsForUser(options = GetCommentsForUserOptions(
  tenantId = "my-tenant-123",
  userId = "user-456",
  page = 0,
  pageSize = 20,
  includeDeleted = false,
  commentIds = @[]
))
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp

addDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
addDomainConfigParams	AddDomainConfigParams	Nie

Odpowiedź

Zwraca: Option[AddDomainConfigResponse]

Przykład

Przykład addDomainConfig

Copy

let (respOpt, httpResp) = client.addDomainConfig(
  tenantId = "my-tenant-123",
  addDomainConfigParams = default(AddDomainConfigParams)
)
if respOpt.isSome:
  let cfg = respOpt.get()

deleteDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
domain	string	No

Odpowiedź

Zwraca: Option[DeleteDomainConfigResponse]

Przykład

deleteDomainConfig Przykład

Copy

let (optResp, httpResp) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
domain	string	No

Odpowiedź

Zwraca: Option[GetDomainConfigResponse]

Przykład

Przykład getDomainConfig

Copy

let (configOpt, httpResp) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if configOpt.isSome:
  let cfg = configOpt.get()
  discard cfg

getDomainConfigs

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: Option[GetDomainConfigsResponse]

Przykład

Przykład getDomainConfigs

Copy

let (domainConfigsOpt, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if domainConfigsOpt.isSome:
  let domainConfigs = domainConfigsOpt.get()
  echo domainConfigs

patchDomainConfig

Parametry

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

Odpowiedź

Zwraca: Option[PatchDomainConfigResponse]

Przykład

patchDomainConfig Przykład

Copy

let (optResp, httpResp) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news.mywebsite.com",
  patchDomainConfigParams = PatchDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

putDomainConfig

Parametry

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

Odpowiedź

Zwraca: Option[PutDomainConfigResponse]

Przykład

putDomainConfig Przykład

Copy

let (optResp, httpResp) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "example.com",
  updateDomainConfigParams = UpdateDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

createEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createEmailTemplateBody	CreateEmailTemplateBody	Nie

Odpowiedź

Zwraca: Option[CreateEmailTemplateResponse]

Przykład

Przykład createEmailTemplate

Copy

let createBody = CreateEmailTemplateBody(
  name: "Welcome Email",
  subject: "Welcome to FastComments",
  htmlBody: "<p>Hello, thank you for joining us!</p>",
  isActive: true,
  tags: @[]
)
let (optResp, httpResp) = client.createEmailTemplate(
  tenantId = "my-tenant-123",
  createEmailTemplateBody = createBody
)
if optResp.isSome:
  let emailTemplate = optResp.get()

deleteEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteEmailTemplate

Copy

let (respOpt, httpResp) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")
if respOpt.isSome:
  let emptyResp = respOpt.get()
  echo "Email template deleted"
else:
  echo "Failed to delete email template"

deleteEmailTemplateRenderError

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
errorId	string	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

deleteEmailTemplateRenderError Przykład

Copy

let (apiRes, httpRes) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  errorId = "render-err-456"
)
if apiRes.isSome:
  let empty = apiRes.get()

getEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetEmailTemplateResponse]

Przykład

getEmailTemplate Przykład

Copy

let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")
if response.isSome:
  let tmpl = response.get()

getEmailTemplateDefinitions

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: Option[GetEmailTemplateDefinitionsResponse]

Przykład

getEmailTemplateDefinitions Przykład

Copy

let (responseOpt, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if responseOpt.isSome:
  let definitions = responseOpt.get()
  echo definitions

getEmailTemplateRenderErrors

Parametry

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

Odpowiedź

Zwraca: Option[GetEmailTemplateRenderErrorsResponse]

Przykład

getEmailTemplateRenderErrors Przykład

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # użyj resp w razie potrzeby
else:
  # obsłuż brak odpowiedzi
  discard

getEmailTemplates

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetEmailTemplatesResponse]

Przykład

Przykład getEmailTemplates

Copy

let (emailTemplatesOpt, httpResp) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if emailTemplatesOpt.isSome:
  let templates = emailTemplatesOpt.get()
  echo templates

renderEmailTemplate

Parametry

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

Odpowiedź

Zwraca: Option[RenderEmailTemplateResponse]

Przykład

renderEmailTemplate Przykład

Copy

let body = RenderEmailTemplateBody()
let (responseOpt, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = body, locale = "en-US")
if responseOpt.isSome:
  let response = responseOpt.get()
  discard response
discard httpResponse

updateEmailTemplate

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

updateEmailTemplate Przykład

Copy

let updateBody = UpdateEmailTemplateBody(
  subject: "Welcome to FastComments",
  body: "Hello \{{user_name}}, thanks for joining!",
  enabled: true,
)
let (maybeResp, httpResp) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  updateEmailTemplateBody = updateBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()

getEventLog

req tenantId urlId userIdWS

Parametry

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

Odpowiedź

Zwraca: Option[GetEventLogResponse]

Przykład

Przykład getEventLog

Copy

let (eventLogOpt, httpResp) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

getGlobalEventLog

req tenantId urlId userIdWS

Parametry

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

Odpowiedź

Zwraca: Option[GetEventLogResponse]

Przykład

Przykład getGlobalEventLog

Copy

let (eventLogOpt, httpResp) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "user-456",
  startTime = 1700000000'i64,
  endTime = 1700003600'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

createFeedPost

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

Odpowiedź

Zwraca: Option[CreateFeedPostsResponse]

Przykład

Przykład createFeedPost

Copy

let (respOpt, httpResp) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(),
  options = CreateFeedPostOptions()
)
if respOpt.isSome:
  let feedPost = respOpt.get()

createFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createFeedPostParams	CreateFeedPostParams	Nie
options	CreateFeedPostPublicOptions	Nie

Odpowiedź

Zwraca: Option[CreateFeedPostResponse]

Przykład

createFeedPostPublic Przykład

Copy

let params = CreateFeedPostParams(
  urlId: "news/big-event",
  title: "Big Event Happened",
  content: "Full article content goes here.",
  tags: @["news", "event"]
)
let opts = CreateFeedPostPublicOptions(
  sendNotifications: false,
  allowComments: true
)
let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = params,
  options = opts
)
if response.isSome:
  let post = response.get()
  echo post

deleteFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
postId	string	No
options	DeleteFeedPostPublicOptions	No

Odpowiedź

Zwraca: Option[DeleteFeedPostPublicResponse]

Przykład

deleteFeedPostPublic Przykład

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-42",
  options = DeleteFeedPostPublicOptions()
)
if response.isSome:
  let deleteResp = response.get()

getFeedPosts

req tenantId afterId

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetFeedPostsOptions	Nie

Odpowiedź

Zwraca: Option[GetFeedPostsResponse]

Przykład

Przykład getFeedPosts

Copy

let (feedResponseOpt, httpResp) = client.getFeedPosts(tenantId = "my-tenant-123", options = GetFeedPostsOptions())
if feedResponseOpt.isSome:
  let feedResponse = feedResponseOpt.get()
  echo feedResponse

getFeedPostsPublic

req tenantId afterId

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetFeedPostsPublicOptions	Nie

Odpowiedź

Zwraca: Option[PublicFeedPostsResponse]

Przykład

getFeedPostsPublic Przykład

Copy

let (feedResponseOpt, httpResponse) = client.getFeedPostsPublic(tenantId = "my-tenant-123", options = GetFeedPostsPublicOptions())
if feedResponseOpt.isSome:
  let feedResponse = feedResponseOpt.get()

getFeedPostsStats

Parametry

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

Odpowiedź

Zwraca: Option[FeedPostsStatsResponse]

Przykład

getFeedPostsStats Przykład

Copy

let (statsOpt, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["post-abc", "post-def"],
  sso = "sso-token",
)
if statsOpt.isSome:
  let stats = statsOpt.get()
  # użyj statystyk w razie potrzeby

getUserReactsPublic

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetUserReactsPublicOptions	Nie

Odpowiedź

Zwraca: Option[UserReactsResponse]

Przykład

Przykład getUserReactsPublic

Copy

let opts = GetUserReactsPublicOptions(
  limit = 20,
  offset = 0,
  includeDeleted = false
)
let (response, httpResponse) = client.getUserReactsPublic(
  tenantId = "my-tenant-123",
  options = opts
)
if response.isSome:
  let userReacts = response.get()

reactFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

Odpowiedź

Zwraca: Option[ReactFeedPostResponse]

Przykład

reactFeedPostPublic Przykład

Copy

let reactParams = ReactBodyParams()
let (optResp, httpResp) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  reactBodyParams = reactParams,
  options = ReactFeedPostPublicOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

updateFeedPost

Parametry

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

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

updateFeedPost Przykład

Copy

let feedPost = FeedPost(
  title: "Breaking News",
  content: "Updated story content",
  tags: @["news", "update"]
)
let (apiRes, httpRes) = client.updateFeedPost(
  tenantId = "my-tenant-123",
  id = "post-456",
  feedPost = feedPost
)
if apiRes.isSome:
  let res = apiRes.get()

updateFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Odpowiedź

Zwraca: Option[CreateFeedPostResponse]

Przykład

Przykład updateFeedPostPublic

Copy

let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-789",
  updateFeedPostParams = UpdateFeedPostParams(),
  options = UpdateFeedPostPublicOptions()
)
if response.isSome:
  let post = response.get()

flagCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
isFlagged	bool	Nie
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

flagCommentPublic Przykład

Copy

let (optResp, httpResp) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  isFlagged = true,
  sso = ""
)
if optResp.isSome:
  let empty = optResp.get()
  discard empty

getGifLarge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
largeInternalURLSanitized	string	Nie

Odpowiedź

Zwraca: Option[GifGetLargeResponse]

Przykład

Przykład getGifLarge

Copy

let (gifOpt, httpResp) = client.getGifLarge(
  tenantId = "my-tenant-123",
  largeInternalURLSanitized = "https://cdn.example.com/gifs/large123.gif")
if gifOpt.isSome:
  let gif = gifOpt.get()
  echo gif

getGifsSearch

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
search	string	Nie
options	GetGifsSearchOptions	Nie

Odpowiedź

Zwraca: Option[GetGifsSearchResponse]

Przykład

Przykład getGifsSearch

Copy

let opts = GetGifsSearchOptions(limit = 10, rating = "g")
let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)
if responseOpt.isSome:
  let resp = responseOpt.get()
  # użyj resp w razie potrzeby

getGifsTrending

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetGifsTrendingOptions	Nie

Odpowiedź

Zwraca: Option[GetGifsTrendingResponse]

Przykład

getGifsTrending Przykład

Copy

let (maybeResponse, httpResponse) = client.getGifsTrending(
  tenantId = "my-tenant-123",
  options = GetGifsTrendingOptions()
)
if maybeResponse.isSome:
  let gifs = maybeResponse.get()
  echo gifs

addHashTag

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createHashTagBody	CreateHashTagBody	Nie

Odpowiedź

Zwraca: Option[CreateHashTagResponse]

Przykład

Przykład addHashTag

Copy

let (hashTagOpt, httpResp) = client.addHashTag(
  tenantId = "my-tenant-123",
  createHashTagBody = CreateHashTagBody(),
)
if hashTagOpt.isSome:
  let tag = hashTagOpt.get()

addHashTagsBulk

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nie

Odpowiedź

Zwraca: Option[BulkCreateHashTagsResponse]

Przykład

addHashTagsBulk Przykład

Copy

let (optResp, httpResp) = client.addHashTagsBulk(
  tenantId = "my-tenant-123",
  bulkCreateHashTagsBody = BulkCreateHashTagsBody(
    hashTags = @["news", "technology"]
  )
)
if optResp.isSome:
  let resp = optResp.get()

deleteHashTag

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
tag	string	Nie
deleteHashTagRequestBody	DeleteHashTagRequestBody	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteHashTag

Copy

let (apiResp, httpResp) = client.deleteHashTag(tenantId = "my-tenant-123", tag = "sports", deleteHashTagRequestBody = DeleteHashTagRequestBody())
if apiResp.isSome:
  let emptyResp = apiResp.get()

getHashTags

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
page	float64	Nie

Odpowiedź

Zwraca: Option[GetHashTagsResponse]

Przykład

Przykład getHashTags

Copy

let (hashTagsOpt, httpResp) = client.getHashTags(tenantId = "my-tenant-123", page = 0.0)
if hashTagsOpt.isSome:
  let hashTags = hashTagsOpt.get()
  echo hashTags
else:
  echo "No hashtags found"

patchHashTag

Parametry

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

Odpowiedź

Zwraca: Option[UpdateHashTagResponse]

Przykład

patchHashTag Przykład

Copy

let updateBody = UpdateHashTagBody()
let (optResp, httpResp) = client.patchHashTag(
  tenantId = "my-tenant-123",
  tag = "news",
  updateHashTagBody = updateBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp
else:
  echo "No response"

deleteModerationVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
voteId	string	Nie
options	DeleteModerationVoteOptions	Nie

Odpowiedź

Zwraca: Option[VoteDeleteResponse]

Przykład

deleteModerationVote Przykład

Copy

let (respOpt, httpResp) = client.deleteModerationVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  voteId = "vote-abc123",
  options = DeleteModerationVoteOptions()
)
if respOpt.isSome:
  let resp = respOpt.get()

getApiComments

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
options	GetApiCommentsOptions	No

Odpowiedź

Zwraca: Option[ModerationAPIGetCommentsResponse]

Przykład

Przykład getApiComments

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # dalsze przetwarzanie może być wykonane przy użyciu `resp`

getApiExportStatus

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetApiExportStatusOptions	Nie

Odpowiedź

Zwraca: Option[ModerationExportStatusResponse]

Przykład

Przykład getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # użyj exportStatus w razie potrzeby

getApiIds

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetApiIdsOptions	No

Response

Returns: Option[ModerationAPIGetCommentIdsResponse]

Example

Przykład getApiIds

Copy

let opts = GetApiIdsOptions()
let (maybeResponse, httpResponse) = client.getApiIds(tenantId = "my-tenant-123", options = opts)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  echo response

getBanUsersFromComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[GetBannedUsersFromCommentResponse]

Przykład

Przykład getBanUsersFromComment

Copy

let (response, httpResponse) = client.getBanUsersFromComment(tenantId = "my-tenant-001", commentId = "cmt-123456", sso = "")
if response.isSome:
  let banInfo = response.get()
  echo banInfo

getCommentBanStatus

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[GetCommentBanStatusResponse]

Przykład

Przykład getCommentBanStatus

Copy

let (banStatusOpt, httpResp) = client.getCommentBanStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  sso = "")
if banStatusOpt.isSome:
  let banStatus = banStatusOpt.get()
  echo banStatus

getCommentChildren

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[ModerationAPIChildCommentsResponse]

Przykład

Przykład getCommentChildren

Copy

let (childRespOpt, httpResp) = client.getCommentChildren(tenantId = "my-tenant-123", commentId = "cmt-456789", sso = "")
if childRespOpt.isSome:
  let childResp = childRespOpt.get()
  echo childResp

getCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetCountOptions	Nie

Odpowiedź

Zwraca: Option[ModerationAPICountCommentsResponse]

Przykład

Przykład getCount

Copy

let (countOpt, httpResponse) = client.getCount(tenantId = "my-tenant-123", options = GetCountOptions())
if countOpt.isSome:
  let count = countOpt.get()

getCounts

Parametry

Name	Type	Required	Description
tenantId	string	Yes
sso	string = ""	No

Odpowiedź

Zwraca: Option[GetBannedUsersCountResponse]

Przykład

Przykład getCounts

Copy

let (maybeCounts, httpRes) = client.getCounts(tenantId = "my-tenant-123", sso = "")
if maybeCounts.isSome:
  let counts = maybeCounts.get()
  echo counts
else:
  echo "No counts returned"

getLogs

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[ModerationAPIGetLogsResponse]

Przykład

Przykład getLogs

Copy

let (logsOpt, httpRes) = client.getLogs(tenantId = "my-tenant-123", commentId = "cmt-789", sso = "")
if logsOpt.isSome:
  let logs = logsOpt.get()
  echo logs

getManualBadges

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
sso	string = ""	No

Odpowiedź

Zwraca: Option[GetTenantManualBadgesResponse]

Przykład

Przykład getManualBadges

Copy

let (manualBadgesOpt, httpResponse) = client.getManualBadges(tenantId = "my-tenant-123", sso = "")
if manualBadgesOpt.isSome:
  let manualBadges = manualBadgesOpt.get()
  echo manualBadges

getManualBadgesForUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

Odpowiedź

Zwraca: Option[GetUserManualBadgesResponse]

Przykład

getManualBadgesForUser Przykład

Copy

let (userBadgesOpt, httpResp) = client.getManualBadgesForUser(
  tenantId = "my-tenant-123",
  options = GetManualBadgesForUserOptions()
)
if userBadgesOpt.isSome:
  let badges = userBadgesOpt.get()
  echo badges

getModerationComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
options	GetModerationCommentOptions	No

Odpowiedź

Zwraca: Option[ModerationAPICommentResponse]

Przykład

Przykład getModerationComment

Copy

let (maybeComment, httpResponse) = client.getModerationComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(GetModerationCommentOptions)
)
if maybeComment.isSome:
  let comment = maybeComment.get()
  echo comment

getModerationCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[GetCommentTextResponse]

Przykład

getModerationCommentText Przykład

Copy

let (optResp, httpResp) = client.getModerationCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456abc",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getPreBanSummary

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
options	GetPreBanSummaryOptions	No

Odpowiedź

Zwraca: Option[PreBanSummary]

Przykład

Przykład getPreBanSummary

Copy

let (preBanSummaryOpt, httpResponse) = client.getPreBanSummary(tenantId = "my-tenant-123", commentId = "cmt-456", options = GetPreBanSummaryOptions())
if preBanSummaryOpt.isSome:
  let summary = preBanSummaryOpt.get()

getSearchCommentsSummary

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetSearchCommentsSummaryOptions	Nie

Odpowiedź

Zwraca: Option[ModerationCommentSearchResponse]

Przykład

getSearchCommentsSummary Przykład

Copy

let (summaryOpt, httpResp) = client.getSearchCommentsSummary(
  tenantId = "my-tenant-123",
  options = GetSearchCommentsSummaryOptions()
)
if summaryOpt.isSome:
  let summary = summaryOpt.get()
  echo summary

getSearchPages

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
options	GetSearchPagesOptions	No

Odpowiedź

Zwraca: Option[ModerationPageSearchResponse]

Przykład

Przykład getSearchPages

Copy

let (searchResp, httpResp) = client.getSearchPages(
  tenantId = "my-tenant-123",
  options = GetSearchPagesOptions(
    page: 1,
    pageSize: 20,
    query: "spam"
  )
)
if searchResp.isSome:
  let resp = searchResp.get()

getSearchSites

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetSearchSitesOptions	Nie

Odpowiedź

Zwraca: Option[ModerationSiteSearchResponse]

Przykład

Przykład getSearchSites

Copy

let (searchResult, httpResp) = client.getSearchSites(tenantId = "my-tenant-123", options = GetSearchSitesOptions())
if searchResult.isSome:
  let siteResp = searchResult.get()

getSearchSuggest

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetSearchSuggestOptions	Nie

Odpowiedź

Zwraca: Option[ModerationSuggestResponse]

Przykład

Przykład getSearchSuggest

Copy

let (suggestOpt, httpResp) = client.getSearchSuggest(
  tenantId = "my-tenant-123",
  options = GetSearchSuggestOptions(),
)
if suggestOpt.isSome:
  let suggest = suggestOpt.get()
  echo suggest

getSearchUsers

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetSearchUsersOptions	Nie

Odpowiedź

Zwraca: Option[ModerationUserSearchResponse]

Przykład

Przykład getSearchUsers

Copy

let (searchRes, httpRes) = client.getSearchUsers(tenantId = "my-tenant-123", options = default(GetSearchUsersOptions))
if searchRes.isSome:
  let data = searchRes.get()
  echo data

getTrustFactor

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetTrustFactorOptions	Nie

Odpowiedź

Zwraca: Option[GetUserTrustFactorResponse]

Przykład

Przykład getTrustFactor

Copy

let (trustOpt, httpResp) = client.getTrustFactor(tenantId = "my-tenant-123", options = GetTrustFactorOptions())
if trustOpt.isSome:
  let trust = trustOpt.get()
  discard trust

getUserBanPreference

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[APIModerateGetUserBanPreferencesResponse]

Przykład

Przykład getUserBanPreference

Copy

let (maybePref, httpResp) = client.getUserBanPreference(tenantId = "my-tenant-123", sso = "")
if maybePref.isSome:
  let pref = maybePref.get()
  echo pref

getUserInternalProfile

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetUserInternalProfileOptions	Nie

Odpowiedź

Zwraca: Option[GetUserInternalProfileResponse]

Przykład

Przykład getUserInternalProfile

Copy

let (profileOpt, httpResp) = client.getUserInternalProfile(
  tenantId = "my-tenant-123",
  options = GetUserInternalProfileOptions()
)
if profileOpt.isSome:
  let profile = profileOpt.get()

postAdjustCommentVotes

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
adjustCommentVotesParams	AdjustCommentVotesParams	Nie
options	PostAdjustCommentVotesOptions	Nie

Odpowiedź

Zwraca: Option[AdjustVotesResponse]

Przykład

postAdjustCommentVotes Przykład

Copy

let (adjustRespOpt, httpResp) = client.postAdjustCommentVotes(
  tenantId = "my-tenant-123",
  commentId = "cmt-789",
  adjustCommentVotesParams = AdjustCommentVotesParams(),
  options = PostAdjustCommentVotesOptions()
)
if adjustRespOpt.isSome:
  let adjustResp = adjustRespOpt.get()

postApiExport

Parameters

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
options	PostApiExportOptions	No

Odpowiedź

Zwraca: Option[ModerationExportResponse]

Przykład

postApiExport Przykład

Copy

let (optExport, httpResp) = client.postApiExport(tenantId = "my-tenant-123", options = PostApiExportOptions())
if optExport.isSome:
  let export = optExport.get()
  echo export

postBanUserFromComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
options	PostBanUserFromCommentOptions	Nie

Odpowiedź

Zwraca: Option[BanUserFromCommentResult]

Przykład

Przykład postBanUserFromComment

Copy

let (banResult, httpResp) = client.postBanUserFromComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  options = PostBanUserFromCommentOptions()
)
if banResult.isSome:
  let result = banResult.get()
  echo result

postBanUserUndo

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
banUserUndoParams	BanUserUndoParams	Nie
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład postBanUserUndo

Copy

let (apiResp, httpResp) = client.postBanUserUndo(
  tenantId = "my-tenant-123",
  banUserUndoParams = BanUserUndoParams(userId = "user-456"),
  sso = ""
)
if apiResp.isSome:
  let _ = apiResp.get()

postBulkPreBanSummary

Parametry

Name	Type	Required
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Odpowiedź

Zwraca: Option[BulkPreBanSummary]

Przykład

Przykład postBulkPreBanSummary

Copy

let bulkParams = BulkPreBanParams(emailAddresses: @["spam@example.com"], ipAddresses: @["203.0.113.5"])
let opt = PostBulkPreBanSummaryOptions(dryRun: false, maxResults: 0)
let (summaryOpt, httpResp) = client.postBulkPreBanSummary(tenantId = "my-tenant-123", bulkPreBanParams = bulkParams, options = opt)
if summaryOpt.isSome:
  let _ = summaryOpt.get()

postCommentsByIds

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentsByIdsParams	CommentsByIdsParams	Nie
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[ModerationAPIChildCommentsResponse]

Przykład

postCommentsByIds Przykład

Copy

let tenantId = "my-tenant-123"
let params = CommentsByIdsParams(commentIds = @["cmt-001", "cmt-002"])
let (maybeResp, httpResp) = client.postCommentsByIds(tenantId = tenantId, commentsByIdsParams = params, sso = "")
if maybeResp.isSome:
  let resp = maybeResp.get()
  # użyj resp w razie potrzeby

postFlagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
options	PostFlagCommentOptions	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

postFlagComment Przykład

Copy

let opts = PostFlagCommentOptions()
let (response, httpResponse) = client.postFlagComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = opts,
)
if response.isSome:
  let result = response.get()

postRemoveComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Odpowiedź

Zwraca: Option[PostRemoveCommentApiResponse]

Przykład

postRemoveComment Przykład

Copy

let (apiResponseOpt, httpResp) = client.postRemoveComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = PostRemoveCommentOptions()
)
if apiResponseOpt.isSome:
  let apiResponse = apiResponseOpt.get()

postRestoreDeletedComment

Parameters

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
options	PostRestoreDeletedCommentOptions	Nie

Response

Zwraca: Option[APIEmptyResponse]

Przykład

postRestoreDeletedComment Przykład

Copy

let (respOpt, httpResp) = client.postRestoreDeletedComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = default(PostRestoreDeletedCommentOptions)
)
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Comment restored"

postSetCommentApprovalStatus

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
options	PostSetCommentApprovalStatusOptions	Nie

Odpowiedź

Zwraca: Option[SetCommentApprovedResponse]

Przykład

postSetCommentApprovalStatus Przykład

Copy

let (approvedOpt, httpResp) = client.postSetCommentApprovalStatus(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  options = PostSetCommentApprovalStatusOptions()
)
if approvedOpt.isSome:
  let approved = approvedOpt.get()
  echo approved

postSetCommentReviewStatus

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
options	PostSetCommentReviewStatusOptions	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład postSetCommentReviewStatus

Copy

let (apiResp, httpResp) = client.postSetCommentReviewStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-7890",
  options = PostSetCommentReviewStatusOptions()
)
if apiResp.isSome:
  let _ = apiResp.get()
  discard
else:
  discard

postSetCommentSpamStatus

Parameters

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

Response

Zwraca: Option[APIEmptyResponse]

Przykład

postSetCommentSpamStatus Przykład

Copy

let defaultOpts = PostSetCommentSpamStatusOptions()
let (maybeResp, httpResp) = client.postSetCommentSpamStatus(tenantId = "my-tenant-123", commentId = "cmt-456789", options = defaultOpts)
if maybeResp.isSome:
  let resp = maybeResp.get()

postSetCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
setCommentTextParams	SetCommentTextParams	Nie
options	PostSetCommentTextOptions	Nie

Odpowiedź

Zwraca: Option[SetCommentTextResponse]

Przykład

Przykład postSetCommentText

Copy

let (responseOpt, httpResponse) = client.postSetCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  setCommentTextParams = SetCommentTextParams(),
  options = PostSetCommentTextOptions()
)
if responseOpt.isSome:
  let updatedComment = responseOpt.get()

postUnFlagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
options	PostUnFlagCommentOptions	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

postUnFlagComment Przykład

Copy

let (maybeResp, httpResp) = client.postUnFlagComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(PostUnFlagCommentOptions)
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

postVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
commentId	string	Yes
options	PostVoteOptions	No

Odpowiedź

Zwraca: Option[VoteResponse]

Przykład

Przykład postVote

Copy

let (voteOpt, httpResp) = client.postVote(
  tenantId = "my-tenant-123",
  commentId = "comment-789",
  options = default(PostVoteOptions)
)
if voteOpt.isSome:
  let vote = voteOpt.get()

putAwardBadge

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

Odpowiedź

Zwraca: Option[AwardUserBadgeResponse]

Przykład

Przykład putAwardBadge

Copy

let (response, httpResponse) = client.putAwardBadge(
  tenantId = "my-tenant-123",
  badgeId = "gold-badge",
  options = PutAwardBadgeOptions()
)
if response.isSome:
  let award = response.get()

putCloseThread

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

putCloseThread Przykład

Copy

let (respOpt, httpResp) = client.putCloseThread(tenantId = "my-tenant-123", urlId = "news/fastcomments-integration", sso = "")
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Thread successfully closed"

putRemoveBadge

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
badgeId	string	Nie
options	PutRemoveBadgeOptions	Nie

Odpowiedź

Zwraca: Option[RemoveUserBadgeResponse]

Przykład

przykład putRemoveBadge

Copy

let (maybeResp, httpResp) = client.putRemoveBadge(
  tenantId = "my-tenant-123",
  badgeId = "badge-456",
  options = PutRemoveBadgeOptions()
)
if maybeResp.isSome:
  let badgeResp = maybeResp.get()

putReopenThread

Parametry

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład putReopenThread

Copy

let (apiRespOpt, httpResp) = client.putReopenThread(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  sso = ""
)
if apiRespOpt.isSome:
  let emptyResp = apiRespOpt.get()
  discard

setTrustFactor

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	SetTrustFactorOptions	Nie

Odpowiedź

Zwraca: Option[SetUserTrustFactorResponse]

Przykład

setTrustFactor Przykład

Copy

let opts = SetTrustFactorOptions(userId = "user-456", trustFactor = 5, reason = "spam detection")
let (trustResponse, httpResponse) = client.setTrustFactor(tenantId = "my-tenant-123", options = opts)
if trustResponse.isSome:
  let result = trustResponse.get()

createModerator

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createModeratorBody	CreateModeratorBody	Nie

Odpowiedź

Zwraca: Option[CreateModeratorResponse]

Przykład

Przykład createModerator

Copy

let (moderatorRes, httpResp) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = CreateModeratorBody())
if moderatorRes.isSome:
  let moderator = moderatorRes.get()

deleteModerator

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
sendEmail	string = ""	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteModerator

Copy

let (apiResp, httpResp) = client.deleteModerator(
  tenantId = "my-tenant-123",
  id = "mod-789",
  sendEmail = "admin@mydomain.com",
)
if apiResp.isSome:
  let empty = apiResp.get()
  echo "Moderator removed"

getModerator

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetModeratorResponse]

Przykład

Przykład getModerator

Copy

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

getModerators

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetModeratorsResponse]

Przykład

Przykład getModerators

Copy

let (moderatorsOpt, httpResp) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if moderatorsOpt.isSome:
  let moderators = moderatorsOpt.get()
  echo moderators

updateModerator

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład updateModerator

Copy

let body = UpdateModeratorBody(name = "John Doe", email = "john@example.com", isActive = true)
let (apiResult, httpResp) = client.updateModerator(tenantId = "my-tenant-123", id = "mod-456", updateModeratorBody = body)
if apiResult.isSome:
  let result = apiResult.get()

deleteNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Tak
id	string	Nie

Response

Returns: Option[APIEmptyResponse]

Example

deleteNotificationCount Przykład

Copy

let (apiRespOpt, httpResp) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if apiRespOpt.isSome:
  let _ = apiRespOpt.get()

getCachedNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetCachedNotificationCountResponse]

Przykład

Przykład getCachedNotificationCount

Copy

let (cachedCountOpt, httpResp) = client.getCachedNotificationCount(tenantId = "my-tenant-123", id = "article-456")
if cachedCountOpt.isSome:
  let cachedCount = cachedCountOpt.get()
  echo cachedCount

getNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetNotificationCountOptions	Nie

Odpowiedź

Zwraca: Option[GetNotificationCountResponse]

Przykład

Przykład getNotificationCount

Copy

let (notifOpt, httpResp) = client.getNotificationCount(tenantId = "my-tenant-123", options = GetNotificationCountOptions())
if notifOpt.isSome:
  let notif = notifOpt.get()
  echo notif

getNotifications

Parametry

Name	Type	Required	Description
tenantId	string	Yes
options	GetNotificationsOptions	No

Odpowiedź

Zwraca: Option[GetNotificationsResponse]

Przykład

Przykład getNotifications

Copy

let (notifOpt, httpResp) = client.getNotifications(tenantId = "my-tenant-123", options = GetNotificationsOptions())
if notifOpt.isSome:
  let notifications = notifOpt.get()

updateNotification

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład updateNotification

Copy

let body = UpdateNotificationBody(message: "Your comment was approved", isRead: false)
let (optResp, httpResp) = client.updateNotification(
  tenantId = "my-tenant-123",
  id = "notif-789",
  updateNotificationBody = body,
  userId = "user-42"
)
if optResp.isSome:
  let _ = optResp.get()

createV1PageReact

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
title	string = ""	Nie

Odpowiedź

Zwraca: Option[CreateV1PageReact]

Przykład

createV1PageReact Przykład

Copy

let (pageOpt, httpResp) = client.createV1PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  title = "Breaking News: Nim Takes Over"
)
if pageOpt.isSome:
  let page = pageOpt.get()
  discard page
  discard httpResp

createV2PageReact

Parametry

Name	Type	Required
tenantId	string	Tak
urlId	string	Tak
id	string	Nie
title	string = ""	Nie

Odpowiedź

Zwraca: Option[CreateV1PageReact]

Przykład

createV2PageReact Przykład

Copy

let (pageResult, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "page-456",
  title = "Breaking News",
)
if pageResult.isSome:
  let page = pageResult.get()
  # użyj `page` w razie potrzeby

deleteV1PageReact

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: Option[CreateV1PageReact]

Przykład

Przykład deleteV1PageReact

Copy

let (reactOpt, httpResp) = client.deleteV1PageReact(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactOpt.isSome:
  let react = reactOpt.get()

deleteV2PageReact

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
urlId	string	Yes
id	string	No

Odpowiedź

Zwraca: Option[CreateV1PageReact]

Przykład

deleteV2PageReact Przykład

Copy

let (maybeReact, httpResp) = client.deleteV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "react-456",
)
if maybeReact.isSome:
  let react = maybeReact.get()
  echo react

getV1PageLikes

Parametry

Name	Type	Required	Description
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: Option[GetV1PageLikes]

Przykład

getV1PageLikes Przykład

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # użyj pageLikes w razie potrzeby

getV2PageReacts

Parametry

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Odpowiedź

Zwraca: Option[GetV2PageReacts]

Przykład

Przykład getV2PageReacts

Copy

let (reactsOpt, httpResp) = client.getV2PageReacts(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactsOpt.isSome:
  let reacts = reactsOpt.get()
  echo reacts

getV2PageReactUsers

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
urlId	string	Yes
id	string	No

Odpowiedź

Zwraca: Option[GetV2PageReactUsersResponse]

Przykład

getV2PageReactUsers Przykład

Copy

let (maybeResponse, httpResponse) = client.getV2PageReactUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "user-456"
)
if maybeResponse.isSome:
  let resp = maybeResponse.get()
  echo resp

addPage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

Odpowiedź

Zwraca: Option[AddPageAPIResponse]

Przykład

addPage Przykład

Copy

let pageData = CreateAPIPageData(
  urlId = "news/article-2024",
  title = "Breaking News: Nim Takes Over",
  description = "An in-depth article about Nim's rise.",
  tags = @["nim", "programming", "news"]
)
let (addPageResp, httpResp) = client.addPage(
  tenantId = "my-tenant-123",
  createAPIPageData = pageData
)
if addPageResp.isSome:
  let resp = addPageResp.get()
  echo resp

deletePage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[DeletePageAPIResponse]

Przykład

Przykład deletePage

Copy

let (deleteRespOpt, httpResp) = client.deletePage(tenantId = "my-tenant-123", id = "news/article-title")
if deleteRespOpt.isSome:
  let deleteResp = deleteRespOpt.get()
  discard deleteResp
discard httpResp

getOfflineUsers

Poprzedni komentatorzy na stronie, którzy NIE są aktualnie online. Posortowani według displayName.
Użyj tego po wyczerpaniu /users/online, aby wyrenderować sekcję "Members".
Paginacja kursora na commenterName: serwer przegląda częściowy {tenantId, urlId, commenterName} indeks od afterName naprzód przy użyciu $gt, bez kosztu $skip.

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

Odpowiedź

Zwraca: Option[PageUsersOfflineResponse]

Przykład

Przykład getOfflineUsers

Copy

let (offlineResp, httpResponse) = client.getOfflineUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetOfflineUsersOptions()
)
if offlineResp.isSome:
  let offline = offlineResp.get()
  echo offline)

getOnlineUsers

Obecni oglądający stronę: użytkownicy, których sesja websocket jest obecnie subskrybowana do tej strony.
Zwraca anonCount + totalCount (subskrybenci całego pokoju, w tym anonimowi oglądający, których nie wymieniamy).

Parameters

Nazwa	Typ	Wymagane
tenantId	string	Yes
urlId	string	Yes
options	GetOnlineUsersOptions	No

Response

Zwraca: Option[PageUsersOnlineResponse]

Przykład

Przykład getOnlineUsers

Copy

let opts = GetOnlineUsersOptions()
let (onlineUsersOpt, httpResp) = client.getOnlineUsers(tenantId = "my-tenant-123", urlId = "news/article-title", options = opts)
if onlineUsersOpt.isSome:
  let onlineUsers = onlineUsersOpt.get()
  echo onlineUsers

getPageByURLId

Parametry

Name	Type	Required	Description
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Returns: Option[GetPageByURLIdAPIResponse]

Przykład

getPageByURLId Przykład

Copy

let (pageOpt, httpRes) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if pageOpt.isSome:
  let page = pageOpt.get()
  echo page

getPages

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Zwraca: Option[GetPagesAPIResponse]

Example

Przykład getPages

Copy

let (pagesOpt, httpResp) = client.getPages(tenantId = "my-tenant-123")
if pagesOpt.isSome:
  let pages = pagesOpt.get()
  echo pages
else:
  echo "No pages returned"
echo httpResp

getPagesPublic

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetPagesPublicOptions	Nie

Odpowiedź

Zwraca: Option[GetPublicPagesResponse]

Przykład

Przykład getPagesPublic

Copy

let (response, httpResponse) = client.getPagesPublic(tenantId = "my-tenant-123", options = GetPagesPublicOptions())
if response.isSome:
  let pages = response.get()
  echo pages

getUsersInfo

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
ids	string	Nie

Response

Zwraca: Option[PageUsersInfoResponse]

Example

Przykład getUsersInfo

Copy

let (usersInfoOpt, httpResp) = client.getUsersInfo(tenantId = "my-tenant-123", ids = "user42")
if usersInfoOpt.isSome:
  let usersInfo = usersInfoOpt.get()

patchPage

Parametry

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

Odpowiedź

Zwraca: Option[PatchPageAPIResponse]

Przykład

patchPage Przykład

Copy

let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/article-456",
  updateAPIPageData = UpdateAPIPageData(title = "Updated article title", description = "Revised description")
)
if response.isSome:
  let resp = response.get()

deletePendingWebhookEvent

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Zwraca: Option[APIEmptyResponse]

Example

deletePendingWebhookEvent Przykład

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "event-456")
if response.isSome:
  let empty = response.get()

getPendingWebhookEventCount

Parametry

Name	Type	Required	Description
tenantId	string	Tak
options	GetPendingWebhookEventCountOptions	Nie

Odpowiedź

Zwraca: Option[GetPendingWebhookEventCountResponse]

Przykład

getPendingWebhookEventCount Przykład

Copy

let (pendingCountOpt, httpResponse) = client.getPendingWebhookEventCount(tenantId = "my-tenant-123", options = GetPendingWebhookEventCountOptions())
if pendingCountOpt.isSome:
  let pendingCount = pendingCountOpt.get()
  echo pendingCount

getPendingWebhookEvents

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetPendingWebhookEventsOptions	Nie

Odpowiedź

Zwraca: Option[GetPendingWebhookEventsResponse]

Przykład

getPendingWebhookEvents Przykład

Copy

let (maybeResp, httpResp) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  options = GetPendingWebhookEventsOptions()
)
if maybeResp.isSome:
  let resp = maybeResp.get()

createQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionConfigBody	CreateQuestionConfigBody	Nie

Odpowiedź

Zwraca: Option[CreateQuestionConfigResponse]

Przykład

createQuestionConfig Przykład

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # użyj resp w razie potrzeby

deleteQuestionConfig

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteQuestionConfig

Copy

let (apiResult, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "question-config-456")
if apiResult.isSome:
  let empty = apiResult.get()

getQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetQuestionConfigResponse]

Przykład

Przykład getQuestionConfig

Copy

let (questionConfigOpt, httpResp) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "question-987")
if questionConfigOpt.isSome:
  let config = questionConfigOpt.get()
  echo config

getQuestionConfigs

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetQuestionConfigsResponse]

Przykład

getQuestionConfigs Przykład

Copy

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

updateQuestionConfig

Parametry

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

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

updateQuestionConfig Przykład

Copy

let (apiResp, httpResp) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if apiResp.isSome:
  let resp = apiResp.get()

createQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionResultBody	CreateQuestionResultBody	Nie

Odpowiedź

Zwraca: Option[CreateQuestionResultResponse]

Przykład

createQuestionResult Przykład

Copy

let tenantId = "my-tenant-123"
let body = CreateQuestionResultBody()
let (optResult, httpResp) = client.createQuestionResult(tenantId = tenantId, createQuestionResultBody = body)
if optResult.isSome:
  let result = optResult.get()
  echo result

deleteQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

deleteQuestionResult Przykład

Copy

let (maybeResult, httpResp) = client.deleteQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if maybeResult.isSome:
  let result = maybeResult.get()

getQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetQuestionResultResponse]

Przykład

getQuestionResult Przykład

Copy

let (optResult, httpResp) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if optResult.isSome:
  let result = optResult.get()
  discard result

getQuestionResults

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetQuestionResultsOptions	Nie

Odpowiedź

Zwraca: Option[GetQuestionResultsResponse]

Przykład

getQuestionResults Przykład

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  options = GetQuestionResultsOptions()
)
if response.isSome:
  let results = response.get()
  echo results

updateQuestionResult

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

updateQuestionResult Przykład

Copy

let (optResp, httpResp) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody()
)
if optResp.isSome:
  let resp = optResp.get()

aggregateQuestionResults

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	AggregateQuestionResultsOptions	Nie

Odpowiedź

Zwraca: Option[AggregateQuestionResultsResponse]

Przykład

aggregateQuestionResults Przykład

Copy

let opts = AggregateQuestionResultsOptions()
let (aggResultOpt, httpResp) = client.aggregateQuestionResults(tenantId = "my-tenant-123", options = opts)
if aggResultOpt.isSome:
  let aggResult = aggResultOpt.get()

bulkAggregateQuestionResults

Parameters

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

Response

Returns: Option[BulkAggregateQuestionResultsResponse]

Example

bulkAggregateQuestionResults Przykład

Copy

let request = BulkAggregateQuestionResultsRequest()
let (maybeResult, httpResp) = client.bulkAggregateQuestionResults(
  tenantId = "my-tenant-123",
  bulkAggregateQuestionResultsRequest = request,
  forceRecalculate = false)
if maybeResult.isSome:
  let result = maybeResult.get()

combineCommentsWithQuestionResults

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
options	CombineCommentsWithQuestionResultsOptions	No

Odpowiedź

Zwraca: Option[CombineQuestionResultsWithCommentsResponse]

Przykład

combineCommentsWithQuestionResults Przykład

Copy

let (combineOpt, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  options = default(CombineCommentsWithQuestionResultsOptions)
)
if combineOpt.isSome:
  let combineResult = combineOpt.get()

addSSOUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPISSOUserData	CreateAPISSOUserData	Nie

Odpowiedź

Zwraca: Option[AddSSOUserAPIResponse]

Przykład

Przykład addSSOUser

Copy

let (optResp, httpResp) = client.addSSOUser(tenantId = "my-tenant-123", createAPISSOUserData = CreateAPISSOUserData())
if optResp.isSome:
  let userResp = optResp.get()

deleteSSOUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
options	DeleteSSOUserOptions	No

Response

Zwraca: Option[DeleteSSOUserAPIResponse]

Example

deleteSSOUser Przykład

Copy

let (apiRespOpt, httpResp) = client.deleteSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteSSOUserOptions()
)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()

getSSOUserByEmail

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
email	string	Nie

Odpowiedź

Zwraca: Option[GetSSOUserByEmailAPIResponse]

Przykład

getSSOUserByEmail Przykład

Copy

let (optResp, httpResp) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "john.doe@example.com")
if optResp.isSome:
  let user = optResp.get()
  discard user

getSSOUserById

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetSSOUserByIdAPIResponse]

Przykład

Przykład getSSOUserById

Copy

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

getSSOUsers

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	int	Nie

Odpowiedź

Zwraca: Option[GetSSOUsersResponse]

Przykład

Przykład getSSOUsers

Copy

let (maybeResponse, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if maybeResponse.isSome:
  let users = maybeResponse.get()
  echo users
else:
  echo "No SSO users found"
echo httpResponse.statusCode

patchSSOUser

Parametry

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

Odpowiedź

Zwraca: Option[PatchSSOUserAPIResponse]

Przykład

Przykład patchSSOUser

Copy

let updateData = UpdateAPISSOUserData()
let (responseOpt, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = updateData,
  updateComments = true)
if responseOpt.isSome:
  let response = responseOpt.get()
  echo response
echo httpResponse.statusCode

putSSOUser

Parametry

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

Odpowiedź

Zwraca: Option[PutSSOUserAPIResponse]

Przykład

Przykład putSSOUser

Copy

let (apiRespOpt, httpResp) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = default(UpdateAPISSOUserData),
  updateComments = false)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()
  echo apiResp

createSubscription

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Odpowiedź

Zwraca: Option[CreateSubscriptionAPIResponse]

Przykład

Przykład createSubscription

Copy

let (respOpt, httpResp) = client.createSubscription(
  tenantId = "my-tenant-123",
  createAPIUserSubscriptionData = default(CreateAPIUserSubscriptionData),
)
if respOpt.isSome:
  let resp = respOpt.get()

deleteSubscription

Parameters

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

Response

Returns: Option[DeleteSubscriptionAPIResponse]

Example

deleteSubscription Przykład

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # użyj apiResult w razie potrzeby

getSubscriptions

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string = ""	Nie

Odpowiedź

Zwraca: Option[GetSubscriptionsAPIResponse]

Przykład

Przykład getSubscriptions

Copy

let (subscriptionsOpt, httpResp) = client.getSubscriptions(tenantId = "my-tenant-123", userId = "user-456")
if subscriptionsOpt.isSome:
  let subscriptions = subscriptionsOpt.get()
  echo subscriptions

updateSubscription

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string = ""	No

Odpowiedź

Zwraca: Option[UpdateSubscriptionAPIResponse]

Przykład

Przykład updateSubscription

Copy

let subscriptionData = UpdateAPIUserSubscriptionData(
  planId = "premium-plan",
  isActive = true,
  expiresAt = "2025-01-01",
)
let (responseOpt, httpResponse) = client.updateSubscription(
  tenantId = "my-tenant-123",
  id = "sub-456",
  updateAPIUserSubscriptionData = subscriptionData,
  userId = "user-789",
)
if responseOpt.isSome:
  let subscriptionResult = responseOpt.get()

getTenantDailyUsages

Parametry

Name	Type	Required	Description
tenantId	string	Tak
options	GetTenantDailyUsagesOptions	Nie

Odpowiedź

Zwraca: Option[GetTenantDailyUsagesResponse]

Przykład

Przykład getTenantDailyUsages

Copy

let (respOpt, httpResp) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  options = default(GetTenantDailyUsagesOptions),
)
if respOpt.isSome:
  let usage = respOpt.get()
  echo usage
  echo httpResp.statusCode

createTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	No

Odpowiedź

Zwraca: Option[CreateTenantPackageResponse]

Przykład

Przykład createTenantPackage

Copy

let (responseOpt, httpResponse) = client.createTenantPackage(
  tenantId = "my-tenant-123",
  createTenantPackageBody = CreateTenantPackageBody()
)
if responseOpt.isSome:
  let response = responseOpt.get()

deleteTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

deleteTenantPackage Przykład

Copy

let (apiResponse, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-456def")
if apiResponse.isSome:
  let emptyResponse = apiResponse.get()

getTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetTenantPackageResponse]

Przykład

Przykład getTenantPackage

Copy

let (pkgOpt, httpResp) = client.getTenantPackage(tenantId = "my-tenant-123", id = "premium-plan")
if pkgOpt.isSome:
  let pkg = pkgOpt.get()
  echo pkg

getTenantPackages

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetTenantPackagesResponse]

Przykład

Przykład getTenantPackages

Copy

let (maybeResp, httpResp) = client.getTenantPackages(tenantId = "my-tenant-123", skip = 0.0)
if maybeResp.isSome:
  let packages = maybeResp.get()
  echo packages
  echo httpResp.statusCode

replaceTenantPackage

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

replaceTenantPackage Przykład

Copy

let (optResp, httpResp) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-456",
  replaceTenantPackageBody = ReplaceTenantPackageBody()
)
if optResp.isSome:
  let resp = optResp.get()
  discard resp

updateTenantPackage

Parametry

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

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład updateTenantPackage

Copy

let body = UpdateTenantPackageBody()
let (optResp, httpResp) = client.updateTenantPackage(
  tenantId = "my-tenant-123",
  id = "premium-plan",
  updateTenantPackageBody = body
)
if optResp.isSome:
  let empty = optResp.get()

createTenantUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantUserBody	CreateTenantUserBody	Nie

Odpowiedź

Zwraca: Option[CreateTenantUserResponse]

Przykład

createTenantUser Przykład

Copy

let tenantId = "my-tenant-123"
let userBody = CreateTenantUserBody(
  email: "john.doe@example.com",
  name: "John Doe",
  password: "s3cr3tP@ss",
  role: "admin"
)
let (optResp, httpResp) = client.createTenantUser(
  tenantId = tenantId,
  createTenantUserBody = userBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp.userId

deleteTenantUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Nie
options	DeleteTenantUserOptions	Nie

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteTenantUser

Copy

let (response, httpResponse) = client.deleteTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteTenantUserOptions(),
)
if response.isSome:
  let empty = response.get()
  echo "User successfully deleted"

getTenantUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetTenantUserResponse]

Przykład

Przykład getTenantUser

Copy

let (maybeUser, httpResp) = client.getTenantUser(tenantId = "my-tenant-123", id = "user-456")
if maybeUser.isSome:
  let user = maybeUser.get()
  echo user

getTenantUsers

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	float64	Nie

Odpowiedź

Zwraca: Option[GetTenantUsersResponse]

Przykład

getTenantUsers Przykład

Copy

let (response, httpResponse) = client.getTenantUsers(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let data = response.get()
  echo data

replaceTenantUser

Parametry

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

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

replaceTenantUser Przykład

Copy

let replaceBody = ReplaceTenantUserBody()
let (response, httpResponse) = client.replaceTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  replaceTenantUserBody = replaceBody,
  updateComments = "")
if response.isSome:
  let empty = response.get()

sendLoginLink

Parametry

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

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład sendLoginLink

Copy

let (maybeResp, httpResp) = client.sendLoginLink(
  tenantId = "my-tenant-123",
  id = "user-456",
  redirectURL = "https://myapp.example.com/login-success"
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

updateTenantUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

updateTenantUser Przykład

Copy

let updateBody = UpdateTenantUserBody()
let (optResp, httpResp) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateTenantUserBody = updateBody,
  updateComments = "Changed role to moderator",
)
if optResp.isSome:
  let _ = optResp.get()

createTenant

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantBody	CreateTenantBody	Nie

Odpowiedź

Zwraca: Option[CreateTenantResponse]

Przykład

createTenant Przykład

Copy

let (maybeResp, httpResp) = client.createTenant(tenantId = "my-tenant-123", createTenantBody = CreateTenantBody())
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp
discard httpResp

deleteTenant

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
sure	string = ""	No

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład deleteTenant

Copy

let (respOpt, httpResp) = client.deleteTenant(tenantId = "my-tenant-123", id = "tenant-to-delete", sure = "yes")
if respOpt.isSome:
  let emptyResp = respOpt.get()

getTenant

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetTenantResponse]

Przykład

Przykład getTenant

Copy

let (tenantResponse, httpResponse) = client.getTenant(tenantId = "my-tenant-123", id = "config-001")
if tenantResponse.isSome:
  let tenant = tenantResponse.get()
  echo tenant

getTenants

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
options	GetTenantsOptions	No

Odpowiedź

Zwraca: Option[GetTenantsResponse]

Przykład

getTenants Przykład

Copy

let (maybeResp, httpResp) = client.getTenants(tenantId = "my-tenant-123", options = GetTenantsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

updateTenant

Parametry

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

Odpowiedź

Zwraca: Option[APIEmptyResponse]

Przykład

Przykład updateTenant

Copy

let updateBody = UpdateTenantBody(
  name: "My Tenant",
  description: "Tenant for news site",
  isActive: true,
  allowedDomains: @["example.com", "news.com"]
)
let (apiResp, httpResp) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "tenant-456",
  updateTenantBody = updateBody
)
if apiResp.isSome:
  let emptyResp = apiResp.get()

changeTicketState

Parametry

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

Odpowiedź

Zwraca: Option[ChangeTicketStateResponse]

Przykład

changeTicketState Przykład

Copy

let (optResp, httpResp) = client.changeTicketState(
  tenantId = "my-tenant-001",
  userId = "user-42",
  id = "ticket-12345",
  changeTicketStateBody = ChangeTicketStateBody(state = "closed")
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

createTicket

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
userId	string	No
createTicketBody	CreateTicketBody	No

Odpowiedź

Zwraca: Option[CreateTicketResponse]

Przykład

Przykład createTicket

Copy

let tenantId = "my-tenant-123"
let userId = "user-456"
let ticketBody = CreateTicketBody()
let (responseOpt, httpResponse) = client.createTicket(tenantId = tenantId, userId = userId, createTicketBody = ticketBody)
if responseOpt.isSome:
  let ticketResponse = responseOpt.get()

getTicket

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	No
userId	string = ""	No

Odpowiedź

Zwraca: Option[GetTicketResponse]

Przykład

getTicket Przykład

Copy

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

getTickets

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetTicketsOptions	Nie

Odpowiedź

Zwraca: Option[GetTicketsResponse]

Przykład

Przykład getTickets

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # użyj biletów w razie potrzeby

getTranslations

Parametry

Nazwa	Typ	Wymagane
namespace	string	Nie
component	string	Nie
options	GetTranslationsOptions	Nie

Odpowiedź

Zwraca: Option[GetTranslationsResponse]

Przykład

Przykład getTranslations

Copy

let opts = GetTranslationsOptions()
let (maybeResp, httpResp) = client.getTranslations(namespace = "my-tenant-123", component = "news/article-title", options = opts)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

uploadImage

Upload and resize an image

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
file	string	Nie
options	UploadImageOptions	Nie

Odpowiedź

Zwraca: Option[UploadImageResponse]

Przykład

uploadImage Przykład

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # użyj wyniku w razie potrzeby

getUserBadgeProgressById

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
id	string	No

Odpowiedź

Zwraca: Option[APIGetUserBadgeProgressResponse]

Przykład

Przykład getUserBadgeProgressById

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "badge-456")
if badgeProgressOpt.isSome:
  let badgeProgress = badgeProgressOpt.get()
  echo badgeProgress

getUserBadgeProgressByUserId

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string	Nie

Odpowiedź

Zwraca: Option[APIGetUserBadgeProgressResponse]

Przykład

Przykład getUserBadgeProgressByUserId

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if badgeProgressOpt.isSome:
  let progress = badgeProgressOpt.get()
  echo progress

getUserBadgeProgressList

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetUserBadgeProgressListOptions	Nie

Odpowiedź

Zwraca: Option[APIGetUserBadgeProgressListResponse]

Przykład

Przykład getUserBadgeProgressList

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(tenantId = "my-tenant-123", options = GetUserBadgeProgressListOptions())
if response.isSome:
  let badgeProgress = response.get()

createUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createUserBadgeParams	CreateUserBadgeParams	Nie

Odpowiedź

Zwraca: Option[APICreateUserBadgeResponse]

Przykład

createUserBadge Przykład

Copy

let (badgeRespOpt, httpResp) = client.createUserBadge(tenantId = "my-tenant-123", createUserBadgeParams = default(CreateUserBadgeParams))
if badgeRespOpt.isSome:
  let badgeResp = badgeRespOpt.get()

deleteUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[APIEmptySuccessResponse]

Przykład

Przykład deleteUserBadge

Copy

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

getUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Yes
id	string	No

Odpowiedź

Zwraca: Option[APIGetUserBadgeResponse]

Przykład

Przykład getUserBadge

Copy

let (badgeOpt, httpResp) = client.getUserBadge(tenantId = "my-tenant-123", id = "user-789")
if badgeOpt.isSome:
  let badge = badgeOpt.get()
  echo badge
else:
  echo "No badge found"
echo httpResp.statusCode

getUserBadges

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetUserBadgesOptions	Nie

Odpowiedź

Zwraca: Option[APIGetUserBadgesResponse]

Przykład

Przykład getUserBadges

Copy

let opts = GetUserBadgesOptions()
let (badgesOpt, httpResp) = client.getUserBadges(tenantId = "my-tenant-123", options = opts)
if badgesOpt.isSome:
  let badges = badgesOpt.get()

updateUserBadge

Parametry

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

Odpowiedź

Zwraca: Option[APIEmptySuccessResponse]

Przykład

Przykład updateUserBadge

Copy

let params = UpdateUserBadgeParams()
let (maybeResp, httpResp) = client.updateUserBadge(tenantId = "my-tenant-123", id = "user-456", updateUserBadgeParams = params)
if maybeResp.isSome:
  let success = maybeResp.get()

getUserNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[GetUserNotificationCountResponse]

Przykład

Przykład getUserNotificationCount

Copy

let (optResp, httpResp) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getUserNotifications

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	GetUserNotificationsOptions	Nie

Odpowiedź

Zwraca: Option[GetMyNotificationsResponse]

Przykład

getUserNotifications Przykład

Copy

let (maybeResponse, httpResponse) = client.getUserNotifications(tenantId = "my-tenant-123", options = GetUserNotificationsOptions())
if maybeResponse.isSome:
  let notifications = maybeResponse.get()

resetUserNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[ResetUserNotificationsResponse]

Przykład

resetUserNotificationCount Przykład

Copy

let (resetRespOpt, httpResp) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "user-456")
if resetRespOpt.isSome:
  let resetResp = resetRespOpt.get()
  echo resetResp
else:
  echo "Reset notification count response not available"

resetUserNotifications

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
options	ResetUserNotificationsOptions	Nie

Odpowiedź

Zwraca: Option[ResetUserNotificationsResponse]

Przykład

resetUserNotifications Przykład

Copy

let (maybeResp, httpResp) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  options = ResetUserNotificationsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()

updateUserNotificationCommentSubscriptionStatus

Włącz lub wyłącz powiadomienia dla określonego komentarza.

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
notificationId	string	No
optedInOrOut	string	No
commentId	string	Yes
sso	string = ""	No

Odpowiedź

Zwraca: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Przykład

Przykład updateUserNotificationCommentSubscriptionStatus

Copy

let (optResp, httpResp) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  optedInOrOut = "opted-in",
  commentId = "comment-789",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()

updateUserNotificationPageSubscriptionStatus

Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy są subskrybowani do strony, powiadomienia są tworzone dla nowych komentarzy głównych, oraz także

Parameters

Nazwa	Typ	Wymagane
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Response

Zwraca: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Example

Przykład updateUserNotificationPageSubscriptionStatus

Copy

let (optResp, httpResp) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  url = "https://example.com/news/article-456",
  pageTitle = "Breaking News: Something Happened",
  subscribedOrUnsubscribed = "subscribed",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  # dalsze przetwarzanie odpowiedzi

updateUserNotificationStatus

Parametry

Name	Type	Required
tenantId	string	Tak
notificationId	string	Nie
newStatus	string	Nie
sso	string = ""	Nie

Odpowiedź

Zwraca: Option[UpdateUserNotificationStatusResponse]

Przykład

updateUserNotificationStatus Przykład

Copy

let (respOpt, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = ""
)
if respOpt.isSome:
  let status = respOpt.get()

getUserPresenceStatuses

Parametry

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

Odpowiedź

Zwraca: Option[GetUserPresenceStatusesResponse]

Przykład

Przykład getUserPresenceStatuses

Copy

let (presenceOpt, httpResp) = client.getUserPresenceStatuses(tenantId = "my-tenant-123", urlIdWS = "news/article-title", userIds = "user42")
if presenceOpt.isSome:
  let presence = presenceOpt.get()

searchUsers

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
options	SearchUsersOptions	Nie

Odpowiedź

Zwraca: Option[SearchUsersResult]

Przykład

searchUsers Przykład

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = SearchUsersOptions()
)
if response.isSome:
  let result = response.get()

getUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Nie

Odpowiedź

Zwraca: Option[GetUserResponse]

Przykład

Przykład getUser

Copy

let (userOpt, httpResp) = client.getUser(tenantId = "my-tenant-123", id = "user-456")
if userOpt.isSome:
  let user = userOpt.get()
  echo user
else:
  echo "User not found"

createVote

Parametry

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
direction	string	No
options	CreateVoteOptions	No

Odpowiedź

Zwraca: Option[VoteResponse]

Przykład

createVote Przykład

Copy

let (voteOpt, httpResp) = client.createVote(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  direction = "up",
  options = CreateVoteOptions()
)
if voteOpt.isSome:
  let vote = voteOpt.get()
  echo vote

deleteVote

Parametry

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

Odpowiedź

Returns: Option[VoteDeleteResponse]

Przykład

deleteVote Przykład

Copy

let (voteRespOpt, httpResp) = client.deleteVote(tenantId = "my-tenant-123", id = "comment-456", editKey = "")
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()
  discard voteResp
  discard httpResp

getVotes

Parametry

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Odpowiedź

Zwraca: Option[GetVotesResponse]

Przykład

Przykład getVotes

Copy

let (optVotes, httpResp) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/article-42")
if optVotes.isSome:
  let votes = optVotes.get()
  discard votes

getVotesForUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
options	GetVotesForUserOptions	Nie

Odpowiedź

Zwraca: Option[GetVotesForUserResponse]

Przykład

getVotesForUser Przykład

Copy

let (optResp, httpResp) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetVotesForUserOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

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

Uwierzytelnianie

Blokowanie z komentarza

Sprawdź zablokowane komentarze

Komentarze

Komentarze użytkownika

Konfiguracje domen

Szablony e-mail

Dziennik zdarzeń

Posty

Zgłaszanie komentarza

GIFy

Hashtagi

Moderacja

Moderatorzy

Liczba powiadomień

Powiadomienia

Reakcje strony

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

Zgłoszenia

Tłumaczenia

Przesyłanie obrazu

Postęp odznak użytkownika

Odznaki użytkownika

Powiadomienia użytkownika

Status obecności użytkownika

Wyszukiwanie użytkowników

Użytkownicy

Głosy

FastComments SDK dla Nim

Repozytorium

Wymagania

Instalacja

Używanie Nimble

Budowanie ze źródła

Zawartość Biblioteki

Publiczne vs Zabezpieczone API

Szybki start

Using Authenticated APIs (DefaultAPI)

Using Public APIs (PublicAPI)

Using Moderation APIs (ModerationAPI)

Common Issues

Making API Calls

Przykład: Pobieranie komentarzy

Notatki

Identyfikatory Broadcast

SSO (Logowanie jednokrotne)

Użycie SSO

Proste SSO

Bezpieczne SSO

Dokumentacja FastComments

Dokumentacja punktów końcowych API

Dokumentacja modeli

aggregate

Parametry

Odpowiedź

Przykład

getAuditLogs

Parametry

Odpowiedź

Przykład

logoutPublic

Response

Przykład