FastComments Nim SDK

זה ה-SDK הרשמי של Nim עבור FastComments.

ה-SDK הרשמי של Nim עבור ממשק ה-API של FastComments

מאגר

דרישות

Nim >= 1.6.0
nimcrypto >= 0.5.4

התקנה

Using Nimble

nimble install fastcomments

Building from Source

nimble build

Library Contents

ספרייה זו מכילה את לקוח ה‑API שנוצר ואת כלי העזר של SSO כדי להקל על העבודה עם ה‑API.

תיעוד ספריית לקוח ה‑API

Public vs Secured APIs

ללקוח ה‑API קיימים שלושה מודולי API: api_default, api_public, ו‑api_moderation. המודול api_default מכיל שיטות הדורשות את מפתח ה‑API שלכם, וה‑api_public מכיל קריאות API שניתן לבצע ישירות מדפדפן/מכשיר נייד/וכו׳ ללא אימות. מודול api_moderation מכיל שיטות ללוח המחוונים של המפקח.

מודול api_moderation מספק חבילה נרחבת של API מודרציה חיים ומהירים. כל שיטת api_moderation מקבלת פרמטר sso וניתן לאמת באמצעות SSO או קובץ cookie של מושב FastComments.com.

התחלה מהירה

שימוש בממשקי API מאומתים (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"

# Make authenticated API calls.
# Required parameters (and the request body) are positional; optional
# parameters are passed via the operation's options object.
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"

שימוש בממשקי API ציבוריים (PublicAPI)

קצוות ציבוריים אינם דורשים אימות:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Make public API calls.
# tenantId and urlId are required (positional); everything else is optional.
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"

שימוש בממשקי API למודרציה (ModerationAPI)

קצוות המודרציה מניעים את לוח הבקרה של המנחה ומאומתים בעזרת אסימון SSO למנחה הפועל:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# List comments in the moderation dashboard.
# This operation has no required parameters, so everything is optional.
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"

בעיות נפוצות

שגיאת אימות 401: ודא שהגדרת את כותרת x-api-key ב-HttpClient שלך לפני ביצוע בקשות DefaultAPI: 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). The first element contains the parsed response if successful, and the second element is the raw HTTP response.

Required parameters and the request body are passed positionally. The remaining optional parameters are collected into a single Api<Operation>Options object, which is the last argument. Operations with no optional parameters take no options object.

דוגמה: הבאת תגובות

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"

הערות

מזהי שידור

תראו שעליכם להעביר broadcastId בחלק מקריאות ה-API. כשתקבלו אירועים, תקבלו חזרה את ה-ID הזה, כך שתדעו להתעלם מהאירוע אם אתם מתכננים ליישם שינויים באופן אופטימי בצד הלקוח (שאתם כנראה תרצו לעשות שכן זה מספק את חוויית המשתמש הטובה ביותר). העבירו כאן UUID. ה-ID צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים במהלך הפעלה אחת של הדפדפן.

SSO (Single Sign-On)

לדוגמאות של 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

אגרגציה

מאגד מסמכים על‑ידי קיבוץ שלהם (אם מתקבל groupBy) והחלת מספר פעולות.
פעולות שונות (למשל sum, countDistinct, avg, וכד') נתמכות.

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
aggregationRequest	AggregationRequest	לא
options	AggregateOptions	לא

תגובה

מחזיר: 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

קבלת יומני ביקורת

פרמטרים

שם	סוג	נדרש	תיאור
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

התנתקות (ציבורי)

תגובה

מחזיר: Option[APIEmptyResponse]

דוגמה

logoutPublic דוגמה

Copy

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

חסימה מתוך תגובה

פרמטרים

שם	סוג	נדרש
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()

ביטול חסימה מתוך תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

תגובה

מחזיר: 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()

בדיקת תגובות חסומות

פרמטרים

שם	סוג	נדרש
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

חסימת משתמש מתגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

תגובה

מחזיר: Option[BlockSuccess]

דוגמה

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

יצירת תגובה ציבורית

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
broadcastId	string	לא
commentData	CommentData	לא
options	CreateCommentPublicOptions	לא

תגובה

מחזיר: Option[SaveCommentsResponseWithPresence]

דוגמה

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

מחיקת תגובה

Parameters

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
options	DeleteCommentOptions	לא

Response

מחזירים: Option[DeleteCommentResult]

Example

דוגמת 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

מחיקת תגובה (ציבורי)

Parameters

שם	סוג	חובה
tenantId	string	כן
commentId	string	כן
broadcastId	string	לא
options	DeleteCommentPublicOptions	לא

Response

מחזיר: Option[PublicAPIDeleteCommentResponse]

Example

דוגמת 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

מחיקת הצבעת תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
options	DeleteCommentVoteOptions	No

תגובה

מחזיר: 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()

דיווח על תגובה

פרמטרים

שם	סוג	חובה
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

קבלת תגובה

פרמטרים

שם	סוג	נדרש	תיאור
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

קבלת תגובות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
options	GetCommentsOptions	לא

תגובה

מחזיר: 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

קבלת תגובות (ציבורי)

req tenantId urlId

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
options	GetCommentsPublicOptions	לא

תגובה

Returns: 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

קבלת טקסט של תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
commentId	string	Yes
options	GetCommentTextOptions	No

תגובה

מחזיר: 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()

קבלת שמות משתמש שהצביעו על תגובה

פרמטרים

שם	סוג	נדרש
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

נעילת תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
broadcastId	string	לא
sso	string = ""	לא

תגובה

מחזיר: 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

הצמדת תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	כן
commentId	string	כן
broadcastId	string	לא
sso	string = ""	לא

תגובה

מחזיר: 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

שמירת תגובה

פרמטרים

שם	סוג	נדרש
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

שמירת תגובות באצווה

פרמטרים

שם	סוג	חובה
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()

הגדרת טקסט תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
broadcastId	string	לא
commentTextUpdateRequest	CommentTextUpdateRequest	לא
options	SetCommentTextOptions	לא

תשובה

מחזיר: 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()

ביטול חסימת משתמש מתגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
options	UnBlockUserFromCommentOptions	No

תגובה

מחזיר: 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()

ביטול דיווח על תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
options	UnFlagCommentOptions	No

תגובה

מחזיר: 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()

שחרור נעילת תגובה

פרמטרים

שם	סוג	נדרש
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"

הסרת הצמדת תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
broadcastId	string	לא
sso	string = ""	לא

תשובה

מחזיר: 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

עדכון תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

תגובה

מחזיר: 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()

הצבעת תגובה

פרמטרים

שם	סוג	נדרש
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()

קבלת תגובות עבור משתמש

פרמטרים

שם	סוג	נדרש	תיאור
options	GetCommentsForUserOptions	No

תגובה

מחזיר: 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

הוספת הגדרת דומיין

פרמטרים

שם	סוג	מחובה	תיאור
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()

מחיקת הגדרת דומיין

פרמטרים

שם	סוג	חובה	תיאור
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

קבלת הגדרת דומיין

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
domain	string	No

תגובה

מחזיר: 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

קבלת הגדרות דומיין

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן

תגובה

מחזיר: Option[GetDomainConfigsResponse]

דוגמה

דוגמת getDomainConfigs

Copy

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

עדכון חלקי של הגדרת דומיין

פרמטרים

שם	סוג	חובה
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

החלפת הגדרת דומיין

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
domainToUpdate	string	לא
updateDomainConfigParams	UpdateDomainConfigParams	לא

תגובה

מחזיר: 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

יצירת תבנית אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createEmailTemplateBody	CreateEmailTemplateBody	לא

תגובה

מחזיר: 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()

מחיקת תבנית אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	לא

תגובה

מחזיר: 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"

מחיקת שגיאת עיבוד תבנית אימייל

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
errorId	string	No

תגובה

מחזיר: 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()

קבלת תבנית אימייל

פרמטרים

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

תגובה

מחזיר: Option[GetEmailTemplateResponse]

דוגמה

דוגמת getEmailTemplate

Copy

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

קבלת הגדרות תבניות אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן

תגובה

מחזיר: Option[GetEmailTemplateDefinitionsResponse]

דוגמה

דוגמה getEmailTemplateDefinitions

Copy

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

קבלת שגיאות עיבוד של תבניות אימייל

Parameters

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
skip	float64	No

Response

מחזיר: Option[GetEmailTemplateRenderErrorsResponse]

Example

getEmailTemplateRenderErrors דוגמה

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # השתמש בתגובה לפי הצורך
else:
  # טפל במצב שבו אין תגובה
  discard

קבלת תבניות אימייל

פרמטרים

שם	סוג	נדרש	תיאור
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

עיבוד תבנית אימייל

פרמטרים

שם	טיפוס	נדרש
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

תשובה

מחזיר: 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

עדכון תבנית אימייל

פרמטרים

שם	סוג	חובה
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()

קבלת יומן אירועים

בקשה tenantId urlId userIdWS

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
userIdWS	string	לא
startTime	int64	לא
endTime	int64	לא

תגובה

מחזיר: 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

קבלת יומן אירועים גלובלי

req tenantId urlId userIdWS

פרמטרים

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

תגובה

Returns: 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

יצירת פוסט בפיד

פרמטרים

שם	סוג	חובה
tenantId	string	כן
createFeedPostParams	CreateFeedPostParams	לא
options	CreateFeedPostOptions	לא

תגובה

מחזיר: Option[CreateFeedPostsResponse]

דוגמה

דוגמה createFeedPost

Copy

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

יצירת פוסט בפיד (ציבורי)

פרמטרים

שם	סוג	נדרש
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

מחיקת פוסט בפיד (ציבורי)

פרמטרים

שם	סוג	חובה
tenantId	string	כן
postId	string	לא
options	DeleteFeedPostPublicOptions	לא

תגובה

מחזיר: 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()

קבלת פוסטים בפיד

req tenantId afterId

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
options	GetFeedPostsOptions	לא

תגובה

מחזיר: Option[GetFeedPostsResponse]

דוגמה

דוגמת getFeedPosts

Copy

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

קבלת פוסטים בפיד (ציבורי)

req tenantId afterId

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
options	GetFeedPostsPublicOptions	לא

תגובה

מחזיר: Option[PublicFeedPostsResponse]

דוגמה

getFeedPostsPublic דוגמה

Copy

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

קבלת סטטיסטיקות פוסטים בפיד

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
postIds	seq[string]	No
sso	string = ""	No

תגובה

מחזיר: 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()
  # השתמש בסטטיסטיקות בהתאם לצורך

קבלת ריאקטים של משתמש (ציבורי)

פרמטרים

שם	סוג	נדרש	תיאור
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()

תגובה על פוסט בפיד (ציבורי)

פרמטרים

שם	סוג	נדרש
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

עדכון פוסט בפיד

פרמטרים

שם	סוג	נדרש
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()

עדכון פוסט בפיד (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

תגובה

מחזיר: 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()

דיווח על תגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
isFlagged	bool	לא
sso	string = ""	לא

תגובה

מחזיר: Option[APIEmptyResponse]

דוגמה

דוגמה ל-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

קבלת GIF גדול

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
largeInternalURLSanitized	string	No

תשובה

מחזיר: 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

חיפוש GIFים

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
search	string	לא
options	GetGifsSearchOptions	לא

תגובה

מחזיר: 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()
  # השתמש בתגובה לפי הצורך

קבלת GIFים פופולריים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
options	GetGifsTrendingOptions	No

תגובה

מחזיר: Option[GetGifsTrendingResponse]

דוגמה

דוגמת getGifsTrending

Copy

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

הוספת האשטאג

פרמטרים

שם	סוג	נדרש	תיאור
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()

הוספת האשטאגים באצווה

פרמטרים

שם	סוג	דרוש	תיאור
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()

מחיקת האשטאג

Parameters

שם	סוג	נדרש
tenantId	string	Yes
tag	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Response

מחזיר: Option[APIEmptyResponse]

Example

deleteHashTag דוגמה

Copy

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

קבלת האשטאגים

פרמטרים

שם	סוג	נדרש	תיאור
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"

עדכון חלקי של האשטאג

פרמטרים

שם	סוג	נדרש
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"

מחיקת הצבעת מודרציה

פרמטרים

שם	סוג	נדרש
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()

קבלת תגובות דרך ה-API

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetApiCommentsOptions	No

Response

מחזיר: Option[ModerationAPIGetCommentsResponse]

Example

דוגמת getApiComments

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # ניתן לבצע עיבוד נוסף עם `resp`

קבלת סטטוס ייצוא API

פרמטרים

שם	סוג	חובה	תיאור
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 לפי הצורך

קבלת מזהי API

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
options	GetApiIdsOptions	לא

תגובה

מחזיר: Option[ModerationAPIGetCommentIdsResponse]

דוגמה

דוגמת 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

קבלת משתמשים שנחסמו מתגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
sso	string = ""	לא

תגובה

מחזיר: 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

קבלת סטטוס חסימת תגובה

פרמטרים

שם	סוג	חובה
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

קבלת תגיות-בנות של תגובה

Parameters

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
sso	string = ""	לא

Response

מחזיר: Option[ModerationAPIChildCommentsResponse]

Example

דוגמת getCommentChildren

Copy

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

קבלת ספירה

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetCountOptions	No

Response

מחזיר: Option[ModerationAPICountCommentsResponse]

דוגמה

דוגמת getCount

Copy

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

קבלת ספירות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
sso	string = ""	No

תגובה

מחזיר: 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"

קבלת לוגים

Parameters

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
sso	string = ""	לא

Response

מחזיר: Option[ModerationAPIGetLogsResponse]

Example

getLogs דוגמה

Copy

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

קבלת תגי ידניים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
sso	string = ""	לא

תגובה

מחזיר: Option[GetTenantManualBadgesResponse]

דוגמה

דוגמה getManualBadges

Copy

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

קבלת תגי ידניים עבור משתמש

Parameters

Name	Type	Required	Description
tenantId	string	כן
options	GetManualBadgesForUserOptions	לא

Response

מחזיר: Option[GetUserManualBadgesResponse]

Example

דוגמת getManualBadgesForUser

Copy

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

קבלת תגיית מודרציה

Parameters

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

Response

מחזיר: Option[ModerationAPICommentResponse]

Example

דוגמת 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

קבלת טקסט תגיית מודרציה

פרמטרים

שם	סוג	נדרש
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

קבלת סיכום טרם חסימה

פרמטרים

שם	סוג	נדרש
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()

קבלת סיכום חיפוש תגובות

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes
options	GetSearchCommentsSummaryOptions	No

תגובה

מחזיר: Option[ModerationCommentSearchResponse]

דוגמה

getSearchCommentsSummary דוגמה

Copy

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

קבלת דפי חיפוש

פרמטרים

שם	סוג	נדרש	תיאור
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()

קבלת אתרי חיפוש

פרמטרים

שם	סוג	נדרש	תיאור
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()

קבלת הצעות חיפוש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
options	GetSearchSuggestOptions	No

תגובה

מחזיר: Option[ModerationSuggestResponse]

דוגמה

דוגמה ל‑getSearchSuggest

Copy

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

קבלת משתמשים בחיפוש

פרמטרים

שם	סוג	חובה	תיאור
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

קבלת מדד אמון

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
options	GetTrustFactorOptions	No

תגובה

מחזיר: Option[GetUserTrustFactorResponse]

דוגמה

getTrustFactor דוגמה

Copy

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

קבלת העדפת חסימת משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
sso	string = ""	לא

תגובה

מחזיר: Option[APIModerateGetUserBanPreferencesResponse]

דוגמה

דוגמה getUserBanPreference

Copy

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

קבלת פרופיל פנימי של משתמש

פרמטרים

שם	סוג	נדרש	תיאור
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()

התאמת הצבעות על תגובות

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	No
options	PostAdjustCommentVotesOptions	No

תגובה

מחזיר: Option[AdjustVotesResponse]

דוגמה

דוגמה ל‑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()

ביצוע ייצוא דרך ה-API

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
options	PostApiExportOptions	לא

תגובה

מחזיר: Option[ModerationExportResponse]

דוגמה

postApiExport דוגמה

Copy

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

הטלת חסימה על משתמש מתוך תגובה

Parameters

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
options	PostBanUserFromCommentOptions	לא

Response

מחזיר: Option[BanUserFromCommentResult]

Example

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

ביטול חסימת משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
banUserUndoParams	BanUserUndoParams	No
sso	string = ""	No

תגובה

מחזיר: 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()

ביצוע אצווה של סיכום טרם חסימה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

תגובה

מחזיר: 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()

קבלת תגובות לפי מזהים

פרמטרים

שם	סוג	נחוץ
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()
  # השתמש בתגובה לפי הצורך

סימון תגובה (POST)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
options	PostFlagCommentOptions	No

תגובה

מחזיר: 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()

הסרת תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	כן
commentId	string	כן
options	PostRemoveCommentOptions	לא

תגובה

מחזיר: 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()

שחזור תגובה שנמחקה

Parameters

שם	סוג	נדרש
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"

הגדרת סטטוס אישור תגובה

פרמטרים

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

תגובה

מחזיר: 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

הגדרת סטטוס סקירת תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
options	PostSetCommentReviewStatusOptions	לא

תגובה

מחזיר: 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

הגדרת סטטוס דואר זבל לתגובה

פרמטרים

שם	סוג	נדרש
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()

הגדרת טקסט של תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

תגובה

מחזיר: 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()

ביטול דיווח על תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
options	PostUnFlagCommentOptions	לא

תגובה

מחזיר: 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()

הצבעה (POST)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
options	PostVoteOptions	No

תגובה

מחזיר: 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()

הענקת תג

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

תגובה

מחזיר: Option[AwardUserBadgeResponse]

דוגמה

דוגמת putAwardBadge

Copy

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

סגירת שרשור

פרמטרים

שם	טיפוס	נדרש
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"

הסרת תג

פרמטרים

שם	סוג	נדרש
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()

פתיחת שרשור מחדש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
sso	string = ""	לא

תגובה

מחזיר: Option[APIEmptyResponse]

דוגמה

דוגמת putReopenThread

Copy

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

הגדרת מדד אמון

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
options	SetTrustFactorOptions	לא

תגובה

מחזיר: 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()

יצירת ממונה

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
createModeratorBody	CreateModeratorBody	לא

תגובה

מחזיר: Option[CreateModeratorResponse]

דוגמה

דוגמת createModerator

Copy

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

מחיקת ממונה

פרמטרים

שם	סוג	נדרש
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"

קבלת ממונה

Parameters

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	לא

Response

מחזיר: Option[GetModeratorResponse]

Example

דוגמת getModerator

Copy

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

קבלת ממונים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
skip	float64	No

תגובה

מחזיר: 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

עדכון ממונה

פרמטרים

Name	Type	Required
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

תגובה

Returns: 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()

מחיקת ספירת התראות

פרמטרים

שם	סוג	נדרש	תיאור
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()

קבלת ספירת התראות מטמון

פרמטרים

שם	סוג	נדרש	תיאור
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

קבלת ספירת התראות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
options	GetNotificationCountOptions	לא

תגובה

מחזיר: Option[GetNotificationCountResponse]

דוגמה

getNotificationCount דוגמה

Copy

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

קבלת התראות

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes
options	GetNotificationsOptions	No

תגובה

מחזיר: Option[GetNotificationsResponse]

דוגמה

דוגמת getNotifications

Copy

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

עדכון התראה

פרמטרים

שם	סוג	נדרש
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()

יצירת תגובת דף V1

Parameters

שם	סוג	נדרש
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

יצירת תגובת דף V2

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	Yes
id	string	No
title	string = ""	No

תגובה

מחזירה: Option[CreateV1PageReact]

דוגמה

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` לפי הצורך

מחיקת תגובת דף V1

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
urlId	string	כן

תגובה

מחזיר: Option[CreateV1PageReact]

דוגמה

deleteV1PageReact דוגמה

Copy

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

מחיקת תגובת דף V2

פרמטרים

שם	סוג	נדרש
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

קבלת לייקים לעמוד V1

פרמטרים

שם	סוג	נדרש	תיאור
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 לפי הצורך

קבלת ריאקטים לעמוד V2

פרמטרים

שם	סוג	נדרש	תיאור
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

קבלת משתמשי ריאקטים לעמוד V2

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	Yes
id	string	No

תגובה

מחזיר: 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

הוספת עמוד

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createAPIPageData	CreateAPIPageData	לא

תגובה

מחזיר: 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

מחיקת עמוד

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	לא

תגובה

מחזיר: 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

קבלת משתמשים לא מקוונים

המתגירים הקודמים בדף שאינם מחוברים כעת. ממוין לפי displayName.
השתמש בזה לאחר שניצלו /users/online כדי להציג חלק "Members".
דף אינדקס עם cursor על commenterName: השרת מתנהל על החלק החלקי {tenantId, urlId, commenterName}
מאינדקס אחרי שם באמצעות $gt, ללא עלות $skip.

פרמטרים

Name	Type	Required
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)

קבלת משתמשים מקוונים

צופים מקוונים של דף: אנשים שהחיבור WebSocket שלהם מנוי לדף ברגע זה. מחזיר anonCount + totalCount (מנויים בחדר כולו, כולל צופי אנונימי שאינם נספרים).

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
urlId	string	Yes
options	GetOnlineUsersOptions	No

תגובה

מחזיר: Option[PageUsersOnlineResponse]

דוגמה

דוגמה 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

קבלת עמוד לפי URL/ID

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
urlId	string	כן

תגובה

מחזיר: 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

קבלת דפים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן

תגובה

מחזיר: 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

קבלת דפים (ציבורי)

רשימת דפים עבור שוכר. משמש את לקוח ה‑desktop של FChat למלא את רשימת החדרים שלו. דורש enableFChat להיות true בתצורה המותאמת שנפתרה עבור כל דף. דפים הדורשים SSO מסוננים על פי גישת קבוצת המשתמש המבקש.

Parameters

שם	סוג	נדרש	תיאור
tenantId	string	כן
options	GetPagesPublicOptions	לא

Response

מחזיר: Option[GetPublicPagesResponse]

דוגמה

דוגמת getPagesPublic

Copy

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

קבלת מידע על משתמשים

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).

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
ids	string	לא

תגובה

מחזיר: Option[PageUsersInfoResponse]

דוגמה

דוגמת getUsersInfo

Copy

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

עדכון חלקי של עמוד

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
updateAPIPageData	UpdateAPIPageData	לא

תגובה

מחזיר: 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()

מחיקת אירוע Webhook בהמתנה

פרמטרים

שם	סוג	נדרש	תיאור
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()

קבלת מספר אירועי Webhook בהמתנה

פרמטרים

שם	סוג	חובה	תיאור
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

קבלת אירועי Webhook בהמתנה

פרמטרים

שם	סוג	נדרש	תיאור
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()

יצירת הגדרת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createQuestionConfigBody	CreateQuestionConfigBody	לא

תגובה

מחזיר: 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()
  # השתמש בתגובה לפי הצורך

מחיקת הגדרת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
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()

קבלת הגדרת שאלה

פרמטרים

שם	סוג	חובה	תיאור
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

קבלת הגדרות שאלות

פרמטרים

שם	סוג	נדרש	תיאור
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

עדכון הגדרת שאלה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
updateQuestionConfigBody	UpdateQuestionConfigBody	לא

תגובה

מחזיר: 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()

יצירת תוצאת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	No

תגובה

מחזיר: 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

מחיקת תוצאת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	לא

תגובה

מחזירה: Option[APIEmptyResponse]

דוגמה

דוגמת deleteQuestionResult

Copy

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

קבלת תוצאת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	No

תגובה

מחזיר: 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

קבלת תוצאות שאלות

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes
options	GetQuestionResultsOptions	No

תשובה

מחזיר: Option[GetQuestionResultsResponse]

דוגמה

דוגמה getQuestionResults

Copy

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

עדכון תוצאת שאלה

Parameters

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
updateQuestionResultBody	UpdateQuestionResultBody	לא

Response

מחזיר: 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()

אגרגציית תוצאות שאלות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
options	AggregateQuestionResultsOptions	No

תגובה

מחזיר: 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()

אגרגציה בכמות לתוצאות שאלות

Parameters

שם	סוג	חובה
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()

שילוב תגובות עם תוצאות שאלות

פרמטרים

שם	סוג	נדרש	תיאור
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()

הוספת משתמש SSO

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createAPISSOUserData	CreateAPISSOUserData	לא

תגובה

מחזיר: Option[AddSSOUserAPIResponse]

דוגמה

דוגמת addSSOUser

Copy

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

מחיקת משתמש SSO

Parameters

שם	סוג	חובה
tenantId	string	כן
id	string	לא
options	DeleteSSOUserOptions	לא

תגובה

מחזיר: Option[DeleteSSOUserAPIResponse]

דוגמה

דוגמת deleteSSOUser

Copy

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

קבלת משתמש SSO לפי אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
email	string	לא

תגובה

מחזיר: 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

קבלת משתמש SSO לפי מזהה

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes
id	string	No

תגובה

מחזיר: 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

קבלת משתמשי SSO

פרמטרים

שם	סוג	חובה	תיאור
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

עדכון חלקי של משתמש SSO

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
updateAPISSOUserData	UpdateAPISSOUserData	לא
updateComments	bool	לא

תגובה

מחזיר: 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

החלפת משתמש SSO

Parameters

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
updateAPISSOUserData	UpdateAPISSOUserData	לא
updateComments	bool	לא

תגובה

מחזיר: 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

יצירת מנוי

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

תגובה

מחזיר: Option[CreateSubscriptionAPIResponse]

דוגמה

דוגמת createSubscription

Copy

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

מחיקת מנוי

פרמטרים

שם	סוג	נדרש
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 לפי הצורך

קבלת מנויים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
userId	string = ""	No

תגובה

מחזיר: Option[GetSubscriptionsAPIResponse]

דוגמה

getSubscriptions דוגמה

Copy

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

עדכון מנוי

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string = ""	No

תגובה

מחזיר: Option[UpdateSubscriptionAPIResponse]

דוגמה

דוגמת 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()

קבלת שימוש יומי של טננט

פרמטרים

שם	סוג	נדרש	תיאור
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

יצירת חבילת טננט

פרמטרים

שם	סוג	נדרש	תיאור
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()

מחיקת חבילת טננט

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	לא

תגובה

מחזיר: Option[APIEmptyResponse]

דוגמה

deleteTenantPackage דוגמה

Copy

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

קבלת חבילת טננט

פרמטרים

שם	סוג	נדרש	תיאור
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

קבלת חבילות טננט

פרמטרים

שם	סוג	נדרש	תיאור
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

החלפת חבילת טננט

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
replaceTenantPackageBody	ReplaceTenantPackageBody	לא

תגובה

מחזיר: 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

עדכון חבילת טננט

Parameters

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
updateTenantPackageBody	UpdateTenantPackageBody	לא

Response

מחזיר: 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()

יצירת משתמש טננט

פרמטרים

שם	סוג	נדרש	תיאור
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

מחיקת משתמש טננט

פרמטרים

Name	Type	Required
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"

קבלת משתמש טננט

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	No

תגובה

מחזירה: 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

קבלת משתמשי טננט

פרמטרים

שם	סוג	נדרש	תיאור
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

החלפת משתמש טננט

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
replaceTenantUserBody	ReplaceTenantUserBody	לא
updateComments	string = ""	לא

תגובה

מחזיר: 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()

שליחת קישור כניסה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
redirectURL	string = ""	לא

תגובה

Returns: 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()

עדכון משתמש טננט

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
updateTenantUserBody	UpdateTenantUserBody	לא
updateComments	string = ""	לא

תשובה

מחזיר: 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()

יצירת טננט

Parameters

שם	סוג	נדרש	תיאור
tenantId	string	Yes
createTenantBody	CreateTenantBody	No

Response

מחזיר: Option[CreateTenantResponse]

דוגמה

דוגמת createTenant

Copy

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

מחיקת טננט

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	לא
sure	string = ""	לא

תגובה

מחזיר: 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()

קבלת טננט

פרמטרים

שם	סוג	נדרש	תיאור
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

קבלת טננטים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
options	GetTenantsOptions	No

תגובה

מחזיר: Option[GetTenantsResponse]

לדוגמה

דוגמת getTenants

Copy

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

עדכון טננט

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
updateTenantBody	UpdateTenantBody	No

תגובה

מחזיר: 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()

שינוי מצב כרטיס

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

תגובה

מחזיר: 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

יצירת כרטיס

פרמטרים

שם	סוג	חובה
tenantId	string	כן
userId	string	לא
createTicketBody	CreateTicketBody	לא

תגובה

מחזיר: 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()

קבלת כרטיס

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	No
userId	string = ""	No

תגובה

מחזיר: Option[GetTicketResponse]

דוגמה

getTicket דוגמה

Copy

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

קבלת כרטיסים

פרמטרים

שם	סוג	נדרש	תיאור
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()
  # השתמש בכרטיסים לפי הצורך

קבלת תרגומים

פרמטרים

שם	סוג	נדרש
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

העלאת תמונה

Upload and resize an image

Parameters

שם	סוג	נדרש
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Response

Returns: 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()
  # השתמש בתוצאה לפי הצורך

קבלת התקדמות תג משתמש לפי מזהה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	No

תגובה

מחזיר: Option[APIGetUserBadgeProgressResponse]

דוגמה

דוגמה getUserBadgeProgressById

Copy

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

קבלת התקדמות תג משתמש לפי מזהה משתמש

פרמטרים

שם	סוג	נדרש	תיאור
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

קבלת רשימת התקדמות תג משתמש

פרמטרים

Name	Type	Required	Description
tenantId	string	Yes
options	GetUserBadgeProgressListOptions	No

תגובה

מחזיר: Option[APIGetUserBadgeProgressListResponse]

דוגמה

דוגמה getUserBadgeProgressList

Copy

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

יצירת תג משתמש

פרמטרים

שם	סוג	נדרש	תיאור
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()

מחיקת תג משתמש

פרמטרים

שם	סוג	נדרש	תיאור
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()

קבלת תג משתמש

פרמטרים

שם	סוג	נדרש	תיאור
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

קבלת תגי משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
options	GetUserBadgesOptions	No

תגובה

מחזיר: Option[APIGetUserBadgesResponse]

דוגמה

getUserBadges דוגמה

Copy

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

עדכון תג משתמש

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	לא
updateUserBadgeParams	UpdateUserBadgeParams	לא

תגובה

מחזיר: 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()

קבלת ספירת התראות משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
sso	string = ""	לא

תשובה

מחזיר: Option[GetUserNotificationCountResponse]

דוגמה

דוגמת getUserNotificationCount

Copy

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

קבלת התראות משתמש

פרמטרים

שם	טיפוס	נדרש	תיאור
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()

אתחול ספירת התראות משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
sso	string = ""	לא

תגובה

מחזיר: 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"

אתחול התראות משתמש

פרמטרים

שם	סוג	דרוש	תיאור
tenantId	string	Yes
options	ResetUserNotificationsOptions	No

תגובה

Returns: Option[ResetUserNotificationsResponse]

דוגמה

דוגמה ל-resetUserNotifications

Copy

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

עדכון סטטוס מנוי תגובה של התראות משתמש

הפעל או בטל התראות עבור תגובה ספציפית.

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()

עדכון סטטוס מנוי דף של התראות משתמש

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

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
url	string	לא
pageTitle	string	לא
subscribedOrUnsubscribed	string	לא
sso	string = ""	לא

תגובה

מחזיר: 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

עדכון סטטוס התראות משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
notificationId	string	No
newStatus	string	No
sso	string = ""	No

תגובה

מחזיר: Option[UpdateUserNotificationStatusResponse]

דוגמה

דוגמת updateUserNotificationStatus

Copy

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

קבלת מצבי נוכחות משתמשים

Parameters

שם	סוג	נדרש
tenantId	string	כן
urlIdWS	string	לא
userIds	string	לא

Response

מחזיר: Option[GetUserPresenceStatusesResponse]

Example

דוגמה ל-getUserPresenceStatuses

Copy

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

חיפוש משתמשים

פרמטרים

שם	סוג	חובה
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()

קבלת משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	לא

תגובה

מחזיר: 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"

יצירת הצבעה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
direction	string	לא
options	CreateVoteOptions	לא

תגובה

מחזיר: 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

מחיקת הצבעה

פרמטרים

שם	סוג	נדרש
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

קבלת הצבעות

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
urlId	string	כן

תגובה

מחזיר: 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

קבלת הצבעות עבור משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	Yes
options	GetVotesForUserOptions	No

תשובה

מחזיר: 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ים

האשטאגים

מודרציה

ממונים

ספירת התראות

התראות

תגובות לדף

דפים

אירועי Webhook בהמתנה

הגדרות שאלות

תוצאות שאלות

אגרגציית תוצאות שאלות

משתמשי SSO

מנויים

שימוש יומי של טננט

חבילות טננט

משתמשי טננט

טננטים

כרטיסים

תרגומים

העלאת תמונה

התקדמות תג משתמש

תגי משתמש

התראות משתמש

מצבי נוכחות משתמש

חיפוש משתמשים

משתמשים

הצבעות

FastComments Nim SDK

מאגר

דרישות

התקנה

Using Nimble

Building from Source

Library Contents

Public vs Secured APIs

התחלה מהירה

שימוש בממשקי API מאומתים (DefaultAPI)

שימוש בממשקי API ציבוריים (PublicAPI)

שימוש בממשקי API למודרציה (ModerationAPI)

בעיות נפוצות

ביצוע קריאות API

דוגמה: הבאת תגובות

הערות

מזהי שידור

SSO (Single Sign-On)

שימוש ב-SSO

SSO פשוט

SSO מאובטח

תיעוד ל-fastcomments

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

אגרגציה

פרמטרים

תגובה

דוגמה

קבלת יומני ביקורת

פרמטרים

תגובה

דוגמה

התנתקות (ציבורי)