FastComments Nim SDK

이것은 FastComments용 공식 Nim SDK입니다.

FastComments API용 공식 Nim SDK

저장소

요구 사항

Nim >= 1.6.0
nimcrypto >= 0.5.4

설치

Nimble 사용

nimble install fastcomments

소스에서 빌드

nimble build

라이브러리 내용

이 라이브러리는 생성된 API 클라이언트와 API 사용을 쉽게 해주는 SSO 유틸리티를 포함하고 있습니다.

API Client Library Docs

공개 API와 보안 API

API 클라이언트에는 api_default, api_public, api_moderation 세 가지 API 모듈이 있습니다. api_default는 API 키가 필요한 메서드를 포함하고, api_public은 인증 없이 브라우저/모바일 디바이스 등에서 직접 호출할 수 있는 API 호출을 포함합니다. api_moderation 모듈은 관리자 대시보드를 위한 메서드를 포함합니다.

api_moderation 모듈은 실시간 및 빠른 검토 API의 포괄적인 스위트를 제공합니다. 모든 api_moderation 메서드는 sso 매개변수를 받아들이며, SSO 또는 FastComments.com 세션 쿠키를 통해 인증할 수 있습니다.

빠른 시작

Using Authenticated APIs (DefaultAPI)

중요: 인증된 엔드포인트는 API 키를 x-api-key 헤더에 설정해야 합니다.

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

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

# 인증된 API 호출을 수행합니다.
# 필수 매개변수(및 요청 본문)는 위치 기반이며; 선택적
# 매개변수는 작업의 옵션 객체를 통해 전달됩니다.
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()

# 공개 API 호출을 수행합니다.
# tenantId와 urlId는 필수(위치 기반)이며; 나머지는 모두 선택 사항입니다.
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()

# 조정 대시보드의 댓글을 나열합니다.
# 이 작업은 필수 매개변수가 없으므로 모든 것이 선택 사항입니다.
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 인증 오류: DefaultAPI 요청을 하기 전에 HttpClient에 x-api-key 헤더를 설정했는지 확인하십시오: client.headers["x-api-key"] = "your-api-key"
잘못된 API 클래스: 서버 측 인증 요청에는 api_default를, 클라이언트 측/공개 요청에는 api_public을, 관리자 대시보드 요청에는 api_moderation을 사용하십시오.

API 호출하기

All API methods in this SDK return tuples of (Option[ResponseType], Response). 첫 번째 요소는 성공 시 파싱된 응답을 포함하고, 두 번째 요소는 원시 HTTP 응답입니다.

필수 매개변수와 요청 본문은 위치 기반으로 전달됩니다. 나머지 선택적 매개변수들은 단일 Api<Operation>Options 객체에 수집되며, 이는 마지막 인수입니다. 선택적 매개변수가 없는 작업은 옵션 객체를 사용하지 않습니다.

예제: 댓글 가져오기

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"

참고

브로드캐스트 ID

일부 API 호출에서는 broadcastId를 전달해야 한다는 것을 보게 됩니다. 이벤트를 수신할 때 이 ID를 반환하므로, 클라이언트에서 변경을 낙관적으로 적용하려는 경우(사용자 경험이 가장 좋기 때문에 아마 그렇게 하게 될 것입니다) 해당 이벤트를 무시해야 하는지 알 수 있습니다. 여기에 UUID를 전달하세요. 이 ID는 브라우저 세션 내에서 두 번 발생하지 않을 만큼 충분히 고유해야 합니다.

SSO (싱글 사인온)

SSO 예제는 아래를 참조하세요.

SSO 사용법

간단한 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

보안 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

FastComments 문서

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
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	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
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	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	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.
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}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

aggregate

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

매개변수

이름	유형	필수
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

응답

반환: Option[AggregateResponse]

예시

집계 예시

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

매개변수

이름	타입	필수	설명
tenantId	string	Yes
options	GetAuditLogsOptions	No

응답

반환: Option[GetAuditLogsResponse]

예시

getAuditLogs 예시

Copy

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

logoutPublic

응답

반환: Option[APIEmptyResponse]

예시

logoutPublic 예제

Copy

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

blockFromCommentPublic

매개변수

이름	타입	필수
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

응답

반환: Option[BlockSuccess]

예시

blockFromCommentPublic 예시

Copy

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

unBlockCommentPublic

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
publicBlockFromCommentParams	PublicBlockFromCommentParams	아니오
sso	string = ""	아니오

응답

반환: Option[UnblockSuccess]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentIds	string	No
sso	string = ""	No

응답

반환: Option[CheckBlockedCommentsResponse]

예시

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

이름	유형	필수
tenantId	string	예
id	string	아니오
blockFromCommentParams	BlockFromCommentParams	아니오
options	BlockUserFromCommentOptions	아니오

Response

반환: Option[BlockSuccess]

Example

blockUserFromComment 예시

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

Parameters

이름	타입	필수
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Response

반환: Option[SaveCommentsResponseWithPresence]

Example

createCommentPublic 예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

응답

반환: Option[DeleteCommentResult]

예시

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

매개변수

이름	타입	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

응답

반환: Option[PublicAPIDeleteCommentResponse]

예시

deleteCommentPublic 예시

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

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
voteId	string	아니오
urlId	string	예
broadcastId	string	아니오
options	DeleteCommentVoteOptions	아니오

응답

Returns: Option[VoteDeleteResponse]

예시

deleteCommentVote 예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
options	FlagCommentOptions	No

응답

반환: Option[FlagCommentResponse]

예시

flagComment 예시

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

매개변수

이름	타입	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[APIGetCommentResponse]

예시

getComment 예시

Copy

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

getComments

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetCommentsOptions	No

응답

반환: Option[APIGetCommentsResponse]

예시

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

매개변수

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
options	GetCommentsPublicOptions	No

응답

반환: Option[GetCommentsResponseWithPresencePublicComment]

예시

getCommentsPublic 예제

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

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
options	GetCommentTextOptions	아니오

응답

반환: Option[PublicAPIGetCommentTextResponse]

예시

getCommentText 예시

Copy

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

getCommentVoteUserNames

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
dir	int	아니오
sso	string = ""	아니오

응답

반환: Option[GetCommentVoteUserNamesSuccessResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

응답

반환: Option[ChangeCommentPinStatusResponse]

예시

pinComment 예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
createCommentParams	CreateCommentParams	No
options	SaveCommentOptions	No

응답

반환: Option[APISaveCommentResponse]

예시

saveComment 예시

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

매개변수

이름	유형	필수
tenantId	string	예
createCommentParams	seq[CreateCommentParams]	아니오
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	아니오
id	string	아니오
fromName	string	아니오

응답

반환값: Option[APIEmptyResponse]

예제

saveCommentsBulk 예제

Copy

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

setCommentText

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
options	SetCommentTextOptions	No

응답

반환: Option[PublicAPISetCommentTextResponse]

예제

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

매개변수

이름	유형	필수
tenantId	string	예
id	string	아니오
unBlockFromCommentParams	UnBlockFromCommentParams	아니오
options	UnBlockUserFromCommentOptions	아니오

응답

반환: Option[UnblockSuccess]

예시

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

Parameters

이름	유형	필수
tenantId	string	예
id	string	아니오
options	UnFlagCommentOptions	아니오

응답

반환: Option[FlagCommentResponse]

예시

unFlagComment 예시

Copy

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

unLockComment

매개변수

이름	타입	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

응답

반환: Option[ChangeCommentPinStatusResponse]

예시

unPinComment 예시

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

매개변수

이름	유형	필수
tenantId	string	예
id	string	아니오
updatableCommentParams	UpdatableCommentParams	아니오
options	UpdateCommentOptions	아니오

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
options	VoteCommentOptions	No

응답

반환: Option[VoteResponse]

예시

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

매개변수

이름	유형	필수	설명
options	GetCommentsForUserOptions	아니오

응답

반환: Option[GetCommentsForUserResponse]

예시

getCommentsForUser 예시

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

매개변수

이름	유형	필요 여부	설명
tenantId	string	예
addDomainConfigParams	AddDomainConfigParams	아니오

응답

반환: Option[AddDomainConfigResponse]

예시

addDomainConfig 예제

Copy

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

deleteDomainConfig

매개변수

이름	유형	필수	설명
tenantId	string	예
domain	string	아니오

응답

반환: Option[DeleteDomainConfigResponse]

예시

deleteDomainConfig 예시

Copy

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

getDomainConfig

매개변수

이름	유형	필수	설명
tenantId	string	예
domain	string	아니오

응답

반환: Option[GetDomainConfigResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes

응답

반환: Option[GetDomainConfigsResponse]

예시

getDomainConfigs 예시

Copy

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

patchDomainConfig

매개변수

이름	유형	필수
tenantId	string	예
domainToUpdate	string	아니오
patchDomainConfigParams	PatchDomainConfigParams	아니오

응답

반환: Option[PatchDomainConfigResponse]

예시

patchDomainConfig 예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

응답

반환: Option[PutDomainConfigResponse]

예시

putDomainConfig 예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

응답

반환: Option[CreateEmailTemplateResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	예
id	string	아니오
errorId	string	아니오

응답

반환: Option[APIEmptyResponse]

예시

deleteEmailTemplateRenderError 예시

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

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[GetEmailTemplateResponse]

예시

getEmailTemplate 예시

Copy

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

getEmailTemplateDefinitions

매개변수

이름	유형	필수	설명
tenantId	string	예

응답

반환: Option[GetEmailTemplateDefinitionsResponse]

예시

getEmailTemplateDefinitions 예시

Copy

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

getEmailTemplateRenderErrors

매개변수

Name	Type	Required
tenantId	string	Yes
id	string	No
skip	float64	No

응답

반환: Option[GetEmailTemplateRenderErrorsResponse]

예시

getEmailTemplateRenderErrors 예시

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # 필요에 따라 resp 사용
else:
  # 누락된 응답 처리
  discard

getEmailTemplates

매개변수

이름	유형	필수	설명
tenantId	string	예
skip	float64	아니오

응답

반환: Option[GetEmailTemplatesResponse]

예시

getEmailTemplates 예시

Copy

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

renderEmailTemplate

매개변수

이름	타입	필수
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

응답

Returns: Option[RenderEmailTemplateResponse]

예시

renderEmailTemplate 예제

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

응답

반환: Option[APIEmptyResponse]

예시

updateEmailTemplate 예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

응답

반환: Option[GetEventLogResponse]

예시

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

매개변수

이름	형식	필수
tenantId	string	예
urlId	string	예
userIdWS	string	아니오
startTime	int64	아니오
endTime	int64	아니오

응답

반환: Option[GetEventLogResponse]

예제

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

매개변수

이름	유형	필수
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

응답

반환: Option[CreateFeedPostsResponse]

예시

createFeedPost 예시

Copy

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

createFeedPostPublic

매개변수

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

응답

반환: Option[CreateFeedPostResponse]

예제

createFeedPostPublic 예제

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

매개변수

이름	유형	필수
tenantId	string	Yes
postId	string	No
options	DeleteFeedPostPublicOptions	No

응답

반환: Option[DeleteFeedPostPublicResponse]

예시

deleteFeedPostPublic 예시

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

Parameters

이름	타입	필수	설명
tenantId	string	예
options	GetFeedPostsOptions	아니오

Response

반환: Option[GetFeedPostsResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetFeedPostsPublicOptions	No

응답

반환: Option[PublicFeedPostsResponse]

예시

getFeedPostsPublic 예시

Copy

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

getFeedPostsStats

매개변수

이름	유형	필수
tenantId	string	예
postIds	seq[string]	아니오
sso	string = ""	아니오

응답

반환: Option[FeedPostsStatsResponse]

예시

getFeedPostsStats 예시

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()
  # 필요에 따라 stats 사용

getUserReactsPublic

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetUserReactsPublicOptions	아니오

응답

반환: Option[UserReactsResponse]

예시

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

매개변수

이름	타입	필수
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

응답

반환: Option[ReactFeedPostResponse]

예시

reactFeedPostPublic 예시

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

매개변수

이름	유형	필수
tenantId	string	예
id	string	아니오
feedPost	FeedPost	아니오

응답

반환: Option[APIEmptyResponse]

예시

updateFeedPost 예시

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

매개변수

이름	유형	필수
tenantId	string	예
postId	string	아니오
updateFeedPostParams	UpdateFeedPostParams	아니오
options	UpdateFeedPostPublicOptions	아니오

응답

반환: Option[CreateFeedPostResponse]

예시

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

Parameters

이름	유형	필수
tenantId	string	예
commentId	string	예
isFlagged	bool	아니오
sso	string = ""	아니오

Response

반환: Option[APIEmptyResponse]

Example

flagCommentPublic 예시

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

매개변수

이름	형식	필수	설명
tenantId	string	예
largeInternalURLSanitized	string	아니오

응답

Returns: Option[GifGetLargeResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

응답

Returns: Option[GetGifsSearchResponse]

예시

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()
  # resp를 필요에 따라 사용

getGifsTrending

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetGifsTrendingOptions	아니오

응답

반환: Option[GetGifsTrendingResponse]

예제

getGifsTrending 예제

Copy

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

addHashTag

매개변수

이름	형식	필수	설명
tenantId	string	예
createHashTagBody	CreateHashTagBody	아니오

응답

반환: Option[CreateHashTagResponse]

예시

addHashTag 예시

Copy

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

addHashTagsBulk

매개변수

이름	유형	필수	설명
tenantId	string	예
bulkCreateHashTagsBody	BulkCreateHashTagsBody	아니오

응답

반환: Option[BulkCreateHashTagsResponse]

예시

addHashTagsBulk 예시

Copy

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

deleteHashTag

Parameters

이름	타입	필수
tenantId	string	Yes
tag	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Response

반환: Option[APIEmptyResponse]

예시

deleteHashTag 예시

Copy

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

getHashTags

매개변수

이름	형식	필수	설명
tenantId	string	예
page	float64	아니오

응답

반환: Option[GetHashTagsResponse]

예시

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

매개변수

이름	타입	필수
tenantId	string	예
tag	string	아니오
updateHashTagBody	UpdateHashTagBody	아니오

응답

반환: Option[UpdateHashTagResponse]

예시

patchHashTag 예제

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
options	DeleteModerationVoteOptions	No

응답

반환: Option[VoteDeleteResponse]

예시

deleteModerationVote 예제

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetApiCommentsOptions	No

응답

반환: Option[ModerationAPIGetCommentsResponse]

예제

getApiComments 예제

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # `resp`를 사용하여 추가 처리를 수행할 수 있습니다

getApiExportStatus

매개변수

이름	타입	필수	설명
tenantId	string	예
options	GetApiExportStatusOptions	아니오

응답

반환: Option[ModerationExportStatusResponse]

예시

getApiExportStatus 예시

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # 필요에 따라 exportStatus 사용

getApiIds

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetApiIdsOptions	No

Response

반환: Option[ModerationAPIGetCommentIdsResponse]

Example

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

응답

반환: Option[GetBannedUsersFromCommentResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
sso	string = ""	아니오

응답

반환: Option[GetCommentBanStatusResponse]

예제

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

응답

Returns: Option[ModerationAPIChildCommentsResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetCountOptions	No

응답

반환: Option[ModerationAPICountCommentsResponse]

예제

getCount 예제

Copy

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

getCounts

매개변수

이름	유형	필수	설명
tenantId	string	예
sso	string = ""	아니오

응답

반환: Option[GetBannedUsersCountResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

응답

반환: Option[ModerationAPIGetLogsResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
sso	string = ""	No

응답

반환: Option[GetTenantManualBadgesResponse]

예시

getManualBadges 예제

Copy

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

getManualBadgesForUser

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

응답

반환: Option[GetUserManualBadgesResponse]

예시

getManualBadgesForUser 예시

Copy

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

getModerationComment

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
options	GetModerationCommentOptions	아니오

응답

반환: Option[ModerationAPICommentResponse]

예시

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

매개변수

이름	타입	필수
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

응답

반환: Option[GetCommentTextResponse]

예시

getModerationCommentText 예시

Copy

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

getPreBanSummary

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
options	GetPreBanSummaryOptions	아니오

응답

반환: Option[PreBanSummary]

예제

getPreBanSummary 예제

Copy

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

getSearchCommentsSummary

Parameters

Name	Type	Required	Description
tenantId	string	예
options	GetSearchCommentsSummaryOptions	아니오

Response

Returns: Option[ModerationCommentSearchResponse]

Example

getSearchCommentsSummary 예제

Copy

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

getSearchPages

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetSearchPagesOptions	아니오

응답

반환: Option[ModerationPageSearchResponse]

예제

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

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetSearchSitesOptions	아니오

응답

반환: Option[ModerationSiteSearchResponse]

예제

getSearchSites 예제

Copy

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

getSearchSuggest

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetSearchSuggestOptions	아니오

응답

반환: Option[ModerationSuggestResponse]

예시

getSearchSuggest 예시

Copy

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

getSearchUsers

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetSearchUsersOptions	아니오

응답

반환: Option[ModerationUserSearchResponse]

예시

getSearchUsers 예제

Copy

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

getTrustFactor

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetTrustFactorOptions	아니오

응답

반환: Option[GetUserTrustFactorResponse]

예시

getTrustFactor 예시

Copy

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

getUserBanPreference

매개변수

이름	유형	필수	설명
tenantId	string	Yes
sso	string = ""	No

응답

반환: Option[APIModerateGetUserBanPreferencesResponse]

예시

getUserBanPreference 예시

Copy

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

getUserInternalProfile

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetUserInternalProfileOptions	No

응답

반환: Option[GetUserInternalProfileResponse]

예시

getUserInternalProfile 예시

Copy

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

postAdjustCommentVotes

Parameters

이름	유형	필수
tenantId	string	예
commentId	string	예
adjustCommentVotesParams	AdjustCommentVotesParams	아니오
options	PostAdjustCommentVotesOptions	아니오

Response

반환: Option[AdjustVotesResponse]

Example

postAdjustCommentVotes 예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	PostApiExportOptions	No

응답

Returns: Option[ModerationExportResponse]

예시

postApiExport 예시

Copy

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

postBanUserFromComment

Parameters

이름	유형	필수
tenantId	string	예
commentId	string	예
options	PostBanUserFromCommentOptions	아니오

Response

반환값: Option[BanUserFromCommentResult]

예제

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

매개변수

이름	유형	필수
tenantId	string	예
banUserUndoParams	BanUserUndoParams	아니오
sso	string = ""	아니오

응답

반환: Option[APIEmptyResponse]

예시

postBanUserUndo 예제

Copy

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

postBulkPreBanSummary

매개변수

이름	유형	필수
tenantId	string	예
bulkPreBanParams	BulkPreBanParams	아니오
options	PostBulkPreBanSummaryOptions	아니오

응답

반환: Option[BulkPreBanSummary]

예시

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

매개변수

이름	유형	필수
tenantId	string	예
commentsByIdsParams	CommentsByIdsParams	아니오
sso	string = ""	아니오

응답

반환: Option[ModerationAPIChildCommentsResponse]

예시

postCommentsByIds 예시

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()
  # 필요에 따라 resp 사용

postFlagComment

매개변수

Name	Type	Required
tenantId	string	예
commentId	string	예
options	PostFlagCommentOptions	아니오

응답

반환: Option[APIEmptyResponse]

예제

postFlagComment 예제

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

매개변수

이름	타입	필수
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

응답

Returns: Option[PostRemoveCommentApiResponse]

예시

postRemoveComment 예시

Copy

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

postRestoreDeletedComment

매개변수

이름	타입	필수
tenantId	string	Yes
commentId	string	Yes
options	PostRestoreDeletedCommentOptions	No

응답

반환: Option[APIEmptyResponse]

예시

postRestoreDeletedComment 예시

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

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
options	PostSetCommentApprovalStatusOptions	아니오

응답

반환: Option[SetCommentApprovedResponse]

예시

postSetCommentApprovalStatus 예시

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

매개변수

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentReviewStatusOptions	No

응답

Returns: Option[APIEmptyResponse]

예시

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

매개변수

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

응답

반환: Option[APIEmptyResponse]

예시

postSetCommentSpamStatus 예시

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

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
setCommentTextParams	SetCommentTextParams	아니오
options	PostSetCommentTextOptions	아니오

응답

반환: Option[SetCommentTextResponse]

예제

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

매개변수

이름	타입	필수
tenantId	string	Yes
commentId	string	Yes
options	PostUnFlagCommentOptions	No

응답

반환: Option[APIEmptyResponse]

예시

postUnFlagComment 예시

Copy

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

postVote

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
options	PostVoteOptions	아니오

응답

반환: Option[VoteResponse]

예시

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

Parameters

이름	유형	필수
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

Response

반환: Option[AwardUserBadgeResponse]

Example

putAwardBadge 예제

Copy

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

putCloseThread

매개변수

이름	형식	필수
tenantId	string	예
urlId	string	예
sso	string = ""	아니오

응답

반환: Option[APIEmptyResponse]

예시

putCloseThread 예시

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

매개변수

이름	유형	필수
tenantId	string	예
badgeId	string	아니오
options	PutRemoveBadgeOptions	아니오

응답

반환: Option[RemoveUserBadgeResponse]

예시

putRemoveBadge 예시

Copy

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

putReopenThread

Parameters

Name	Type	Required
tenantId	string	예
urlId	string	예
sso	string = ""	아니오

Response

Returns: Option[APIEmptyResponse]

Example

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

매개변수

Name	Type	Required	Description
tenantId	string	Yes
options	SetTrustFactorOptions	No

응답

Returns: Option[SetUserTrustFactorResponse]

예시

setTrustFactor 예시

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

매개변수

이름	형식	필수	설명
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	No

응답

반환: Option[CreateModeratorResponse]

예시

createModerator 예시

Copy

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

deleteModerator

매개변수

이름	형식	필수
tenantId	string	Yes
id	string	No
sendEmail	string = ""	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[GetModeratorResponse]

예시

getModerator 예제

Copy

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

getModerators

매개변수

이름	형식	필수	설명
tenantId	string	예
skip	float64	아니오

응답

반환: Option[GetModeratorsResponse]

예시

getModerators 예시

Copy

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

updateModerator

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[APIEmptyResponse]

예시

deleteNotificationCount 예시

Copy

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

getCachedNotificationCount

매개변수

이름	유형	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[GetCachedNotificationCountResponse]

예시

getCachedNotificationCount 예시

Copy

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

getNotificationCount

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetNotificationCountOptions	No

응답

Returns: Option[GetNotificationCountResponse]

예시

getNotificationCount 예시

Copy

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

getNotifications

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetNotificationsOptions	아니오

응답

Returns: Option[GetNotificationsResponse]

예시

getNotifications 예시

Copy

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

updateNotification

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

Name	Type	Required
tenantId	string	예
urlId	string	예
title	string = ""	아니오

응답

반환: Option[CreateV1PageReact]

예시

createV1PageReact 예시

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

Parameters

이름	유형	필수
tenantId	string	예
urlId	string	예
id	string	아니오
title	string = ""	아니오

Response

반환: Option[CreateV1PageReact]

Example

createV2PageReact 예시

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()
  # 필요에 따라 `page` 사용

deleteV1PageReact

Parameters

이름	유형	필수	설명
tenantId	string	Yes
urlId	string	Yes

응답

반환: Option[CreateV1PageReact]

예시

deleteV1PageReact 예시

Copy

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

deleteV2PageReact

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
id	string	아니오

응답

반환: Option[CreateV1PageReact]

예시

deleteV2PageReact 예시

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

매개변수

이름	유형	필수	설명
tenantId	string	예
urlId	string	예

응답

반환: Option[GetV1PageLikes]

예시

getV1PageLikes 예제

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # 필요에 따라 pageLikes 사용

getV2PageReacts

매개변수

이름	유형	필수	설명
tenantId	string	Yes
urlId	string	Yes

응답

반환: Option[GetV2PageReacts]

예시

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

매개변수

이름	형식	필수
tenantId	string	예
urlId	string	예
id	string	아니오

응답

반환: Option[GetV2PageReactUsersResponse]

예제

getV2PageReactUsers 예제

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

응답

반환: Option[AddPageAPIResponse]

예시

addPage 예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[DeletePageAPIResponse]

예제

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

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.

매개변수

이름	타입	필수
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

응답

반환: Option[PageUsersOfflineResponse]

예시

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

현재 페이지에 온라인인 뷰어: 현재 페이지에 구독된 웹소켓 세션을 가진 사람들. 익명 카운트와 전체 카운트(방 전체 구독자, 열거하지 않는 익명 뷰어 포함)를 반환합니다.

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
options	GetOnlineUsersOptions	No

Response

반환: Option[PageUsersOnlineResponse]

Example

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

매개변수

이름	타입	필수	설명
tenantId	string	Yes
urlId	string	Yes

응답

반환: Option[GetPageByURLIdAPIResponse]

예시

getPageByURLId 예제

Copy

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

getPages

파라미터

Name	Type	Required	Description
tenantId	string	Yes

응답

반환값: Option[GetPagesAPIResponse]

예시

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

테넌트의 페이지 목록을 조회합니다. FChat 데스크톱 클라이언트가 방 목록을 채우는 데 사용됩니다.
enableFChat이 각 페이지에 대한 해결된 사용자 지정 구성에서 true로 설정되어 있어야 합니다.
SSO가 필요한 페이지는 요청 사용자의 그룹 접근 권한에 따라 필터링됩니다.

매개변수

Name	Type	Required	Description
tenantId	string	Yes
options	GetPagesPublicOptions	No

응답

반환: Option[GetPublicPagesResponse]

예시

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

이름	유형	필수	설명
tenantId	string	예
ids	string	아니오

Response

Returns: Option[PageUsersInfoResponse]

Example

getUsersInfo 예제

Copy

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

patchPage

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

응답

반환: Option[PatchPageAPIResponse]

예시

patchPage 예시

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

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[APIEmptyResponse]

예시

deletePendingWebhookEvent 예시

Copy

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

getPendingWebhookEventCount

매개변수

이름	타입	필수	설명
tenantId	string	예
options	GetPendingWebhookEventCountOptions	아니오

응답

반환: Option[GetPendingWebhookEventCountResponse]

예시

getPendingWebhookEventCount 예시

Copy

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

getPendingWebhookEvents

매개변수

이름	타입	필수	설명
tenantId	string	Yes
options	GetPendingWebhookEventsOptions	No

응답

반환: Option[GetPendingWebhookEventsResponse]

예제

getPendingWebhookEvents 예제

Copy

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

createQuestionConfig

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	No

응답

반환: Option[CreateQuestionConfigResponse]

예시

createQuestionConfig 예시

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # 필요에 따라 resp 사용

deleteQuestionConfig

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[APIEmptyResponse]

예시

deleteQuestionConfig 예시

Copy

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

getQuestionConfig

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[GetQuestionConfigResponse]

예제

getQuestionConfig 예제

Copy

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

getQuestionConfigs

매개변수

이름	유형	필수	설명
tenantId	string	Yes
skip	float64	No

응답

반환: Option[GetQuestionConfigsResponse]

예제

getQuestionConfigs 예제

Copy

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

updateQuestionConfig

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

응답

반환: Option[APIEmptyResponse]

예시

updateQuestionConfig 예시

Copy

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

createQuestionResult

매개변수

이름	타입	필수	설명
tenantId	string	예
createQuestionResultBody	CreateQuestionResultBody	아니오

응답

반환: Option[CreateQuestionResultResponse]

예제

createQuestionResult 예제

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

매개변수

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

응답

반환: Option[APIEmptyResponse]

예시

deleteQuestionResult 예시

Copy

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

getQuestionResult

Parameters

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

Response

반환: Option[GetQuestionResultResponse]

예시

getQuestionResult 예시

Copy

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

getQuestionResults

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetQuestionResultsOptions	아니오

응답

반환: Option[GetQuestionResultsResponse]

예시

getQuestionResults 예시

Copy

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

updateQuestionResult

매개변수

이름	유형	필수
tenantId	string	예
id	string	아니오
updateQuestionResultBody	UpdateQuestionResultBody	아니오

응답

반환: Option[APIEmptyResponse]

예시

updateQuestionResult 예시

Copy

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

aggregateQuestionResults

매개변수

이름	유형	필수	설명
tenantId	string	예
options	AggregateQuestionResultsOptions	아니오

응답

반환: Option[AggregateQuestionResultsResponse]

예시

aggregateQuestionResults 예시

Copy

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

bulkAggregateQuestionResults

매개변수

이름	유형	필수
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

응답

반환: Option[BulkAggregateQuestionResultsResponse]

예제

bulkAggregateQuestionResults 예제

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

매개변수

이름	형식	필수	설명
tenantId	string	Yes
options	CombineCommentsWithQuestionResultsOptions	No

응답

반환: Option[CombineQuestionResultsWithCommentsResponse]

예시

combineCommentsWithQuestionResults 예시

Copy

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

addSSOUser

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	No

응답

반환: Option[AddSSOUserAPIResponse]

예시

addSSOUser 예시

Copy

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

deleteSSOUser

Parameters

이름	유형	필수
tenantId	string	Yes
id	string	No
options	DeleteSSOUserOptions	No

Response

반환값: Option[DeleteSSOUserAPIResponse]

Example

deleteSSOUser 예제

Copy

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

getSSOUserByEmail

매개변수

Name	Type	Required	Description
tenantId	string	Yes
email	string	No

응답

Returns: Option[GetSSOUserByEmailAPIResponse]

예시

getSSOUserByEmail 예제

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

매개변수

이름	형식	필수	설명
tenantId	string	Yes
id	string	No

응답

Returns: Option[GetSSOUserByIdAPIResponse]

예제

getSSOUserById 예제

Copy

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

getSSOUsers

매개변수

이름	타입	필수	설명
tenantId	string	예
skip	int	아니오

응답

반환: Option[GetSSOUsersResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

응답

반환: Option[PatchSSOUserAPIResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

응답

반환: Option[PutSSOUserAPIResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	예
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	아니오

응답

반환: Option[CreateSubscriptionAPIResponse]

예시

createSubscription 예시

Copy

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

deleteSubscription

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
userId	string = ""	No

반환

반환: Option[DeleteSubscriptionAPIResponse]

예시

deleteSubscription 예시

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # 필요에 따라 apiResult 사용

getSubscriptions

Parameters

이름	유형	필수	설명
tenantId	string	예
userId	string = ""	아니오

Response

반환값: Option[GetSubscriptionsAPIResponse]

Example

getSubscriptions 예시

Copy

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

updateSubscription

Parameters

이름	유형	필수
tenantId	string	Yes
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string = ""	No

Response

반환: Option[UpdateSubscriptionAPIResponse]

Example

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

매개변수

이름	유형	필수	설명
tenantId	string	예
options	GetTenantDailyUsagesOptions	아니오

응답

반환: Option[GetTenantDailyUsagesResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	No

응답

반환: Option[CreateTenantPackageResponse]

예시

createTenantPackage 예시

Copy

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

deleteTenantPackage

매개변수

이름	유형	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[APIEmptyResponse]

예시

deleteTenantPackage 예시

Copy

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

getTenantPackage

매개변수

이름	유형	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[GetTenantPackageResponse]

예시

getTenantPackage 예시

Copy

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

getTenantPackages

Parameters

이름	타입	필수	설명
tenantId	string	예
skip	float64	아니오

응답

반환: Option[GetTenantPackagesResponse]

예제

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

매개변수

이름	타입	필수
tenantId	string	Yes
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

응답

반환: Option[APIEmptyResponse]

예시

replaceTenantPackage 예시

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

매개변수

Name	Type	Required
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	타입	필수	설명
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

응답

반환: Option[CreateTenantUserResponse]

예시

createTenantUser 예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
options	DeleteTenantUserOptions	No

응답

반환: Option[APIEmptyResponse]

예시

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

Parameters

이름	타입	필수	설명
tenantId	string	예
id	string	아니오

Response

반환: Option[GetTenantUserResponse]

예시

getTenantUser 예시

Copy

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

getTenantUsers

매개변수

이름	타입	필수	설명
tenantId	string	예
skip	float64	아니오

응답

반환: Option[GetTenantUsersResponse]

예제

getTenantUsers 예제

Copy

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

replaceTenantUser

매개변수

Name	Type	Required
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

응답

반환: Option[APIEmptyResponse]

예시

replaceTenantUser 예시

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

매개변수

이름	형식	필수
tenantId	string	예
id	string	아니오
redirectURL	string = ""	아니오

응답

반환값: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

응답

반환: Option[APIEmptyResponse]

예시

updateTenantUser 예시

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

Parameters

이름	유형	필수	설명
tenantId	string	예
createTenantBody	CreateTenantBody	아니요

Response

반환: Option[CreateTenantResponse]

Example

createTenant 예제

Copy

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

deleteTenant

매개변수

이름	타입	필수
tenantId	string	Yes
id	string	No
sure	string = ""	No

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[GetTenantResponse]

예시

getTenant 예시

Copy

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

getTenants

매개변수

이름	형식	필수	설명
tenantId	string	예
options	GetTenantsOptions	아니오

응답

반환: Option[GetTenantsResponse]

예시

getTenants 예시

Copy

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

updateTenant

매개변수

이름	유형	필수
tenantId	string	예
id	string	아니오
updateTenantBody	UpdateTenantBody	아니오

응답

반환: Option[APIEmptyResponse]

예시

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

매개변수

이름	타입	필수
tenantId	string	예
userId	string	아니오
id	string	아니오
changeTicketStateBody	ChangeTicketStateBody	아니오

응답

반환: Option[ChangeTicketStateResponse]

예시

changeTicketState 예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
userId	string	No
createTicketBody	CreateTicketBody	No

응답

반환: Option[CreateTicketResponse]

예시

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

Parameters

이름	유형	Required
tenantId	string	Yes
id	string	No
userId	string = ""	No

Response

반환: Option[GetTicketResponse]

Example

getTicket 예시

Copy

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

getTickets

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	GetTicketsOptions	No

응답

반환: Option[GetTicketsResponse]

예시

getTickets 예시

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # 필요에 따라 tickets를 사용하세요

getTranslations

매개변수

이름	형식	필수
namespace	string	아니오
component	string	아니오
options	GetTranslationsOptions	아니오

응답

반환: Option[GetTranslationsResponse]

예시

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

이미지를 업로드하고 리사이즈하기

Parameters

이름	형식	필수
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Response

반환: Option[UploadImageResponse]

Example

uploadImage 예제

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # 결과를 필요에 따라 사용

getUserBadgeProgressById

Parameters

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

Response

반환: Option[APIGetUserBadgeProgressResponse]

Example

getUserBadgeProgressById 예시

Copy

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

getUserBadgeProgressByUserId

매개변수

이름	유형	필수	설명
tenantId	string	Yes
userId	string	No

응답

반환: Option[APIGetUserBadgeProgressResponse]

예시

getUserBadgeProgressByUserId 예시

Copy

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

getUserBadgeProgressList

매개변수

이름	타입	필수	설명
tenantId	string	예
options	GetUserBadgeProgressListOptions	아니오

응답

반환: Option[APIGetUserBadgeProgressListResponse]

예시

getUserBadgeProgressList 예시

Copy

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

createUserBadge

매개변수

이름	유형	필수	설명
tenantId	string	예
createUserBadgeParams	CreateUserBadgeParams	아니오

응답

반환: Option[APICreateUserBadgeResponse]

예시

createUserBadge 예시

Copy

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

deleteUserBadge

매개변수

이름	형식	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[APIEmptySuccessResponse]

예제

deleteUserBadge 예제

Copy

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

getUserBadge

파라미터

이름	유형	필수	설명
tenantId	string	예
id	string	아니오

응답

반환: Option[APIGetUserBadgeResponse]

예시

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

Parameters

Name	Type	Required	Description
tenantId	string	예
options	GetUserBadgesOptions	아니오

Response

반환: Option[APIGetUserBadgesResponse]

Example

getUserBadges 예시

Copy

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

updateUserBadge

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

응답

반환: Option[APIEmptySuccessResponse]

예시

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

Parameters

이름	타입	필수	설명
tenantId	string	Yes
sso	string = ""	No

Response

반환값: Option[GetUserNotificationCountResponse]

Example

getUserNotificationCount 예제

Copy

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

getUserNotifications

매개변수

이름	타입	필수	설명
tenantId	string	예
options	GetUserNotificationsOptions	아니오

응답

반환: Option[GetMyNotificationsResponse]

예제

getUserNotifications 예제

Copy

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

resetUserNotificationCount

매개변수

이름	유형	필수	설명
tenantId	string	Yes
sso	string = ""	No

응답

반환: Option[ResetUserNotificationsResponse]

예시

resetUserNotificationCount 예제

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

매개변수

이름	유형	필수	설명
tenantId	string	Yes
options	ResetUserNotificationsOptions	No

응답

반환: Option[ResetUserNotificationsResponse]

예시

resetUserNotifications 예시

Copy

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

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

이름	타입	필수
tenantId	string	Yes
notificationId	string	No
optedInOrOut	string	No
commentId	string	Yes
sso	string = ""	No

Response

반환: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Example

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

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

매개변수

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

응답

반환: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

예제

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()
  # resp와 추가 처리

updateUserNotificationStatus

Parameters

Name	Type	Required
tenantId	string	예
notificationId	string	아니오
newStatus	string	아니오
sso	string = ""	아니오

Response

반환: Option[UpdateUserNotificationStatusResponse]

Example

updateUserNotificationStatus 예시

Copy

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

getUserPresenceStatuses

매개변수

이름	타입	필수
tenantId	string	Yes
urlIdWS	string	No
userIds	string	No

응답

반환: Option[GetUserPresenceStatusesResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

응답

반환값: Option[SearchUsersResult]

예시

searchUsers 예시

Copy

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

getUser

매개변수

이름	유형	필수	설명
tenantId	string	Yes
id	string	No

응답

반환: Option[GetUserResponse]

예제

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

매개변수

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

응답

반환: Option[VoteResponse]

예시

createVote 예시

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

매개변수

이름	형식	필수
tenantId	string	예
id	string	아니오
editKey	string = ""	아니오

응답

반환: Option[VoteDeleteResponse]

예시

deleteVote 예시

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

매개변수

이름	형식	필수	설명
tenantId	string	Yes
urlId	string	Yes

응답

반환: Option[GetVotesResponse]

예시

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

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
options	GetVotesForUserOptions	아니오

응답

반환: Option[GetVotesForUserResponse]

예시

getVotesForUser 예시

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

도움이 필요하신가요?

Nim SDK 사용 중 문제가 발생하거나 질문이 있으시면, 다음을 이용해 주세요:

기여

기여는 환영합니다! 기여 지침은 GitHub 저장소에서 확인해 주세요.

언어 🇰🇷 한국어

문서

시작하기

API 참조

사용법

집계

감사 로그

인증

댓글 차단

차단된 댓글 확인

댓글

사용자별 댓글

도메인 설정

이메일 템플릿

이벤트 로그

피드 게시물

댓글 신고

GIF

해시태그

관리

운영자

알림 수

알림

페이지 반응

페이지

대기 중인 웹훅 이벤트

질문 설정

질문 결과

질문 결과 집계

SSO 사용자

구독

테넌트 일별 사용량

테넌트 패키지

테넌트 사용자

테넌트

티켓

번역

이미지 업로드

사용자 뱃지 진행률

사용자 뱃지

사용자 알림

사용자 접속 상태

사용자 검색

사용자

투표

FastComments Nim SDK

저장소

요구 사항

설치

Nimble 사용

소스에서 빌드

라이브러리 내용

공개 API와 보안 API

빠른 시작

Using Authenticated APIs (DefaultAPI)

Using Public APIs (PublicAPI)

Using Moderation APIs (ModerationAPI)

Common Issues

API 호출하기

예제: 댓글 가져오기

참고

브로드캐스트 ID

SSO (싱글 사인온)

SSO 사용법

간단한 SSO

보안 SSO

FastComments 문서

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

aggregate

매개변수

응답

예시

getAuditLogs

매개변수

응답

예시

logoutPublic