FastComments SDK για Nim

Αυτό είναι το επίσημο Nim SDK για το FastComments.

Επίσημο Nim SDK για το FastComments API

Αποθετήριο

Απαιτήσεις

Nim >= 1.6.0
nimcrypto >= 0.5.4

Εγκατάσταση

Χρήση Nimble

nimble install fastcomments

Δόμηση από Πηγή

nimble build

Περιεχόμενα Βιβλιοθήκης

Αυτή η βιβλιοθήκη περιέχει τον δημιουργημένο πελάτη API και τα εργαλεία SSO για να διευκολύνουν την εργασία με το API.

Τεκμηρίωση Βιβλιοθήκης Πελάτη API

Δημόσια vs Προστατευμένα APIs

Για τον πελάτη API, υπάρχουν τρία API modules, api_default, api_public και api_moderation. Το api_default περιέχει μεθόδους που απαιτούν το κλειδί API σας, και το api_public περιέχει κλήσεις API που μπορούν να γίνουν απευθείας από έναν φυλλομετρητή/συσκευή κινητού κ.λπ. χωρίς πιστοποίηση. Το module api_moderation περιέχει μεθόδους για τον πίνακα ελέγχου του συντονιστή.

Το api_moderation module παρέχει μια εκτενή σειρά ζωντανών και γρήγορων APIs συντονισμού. Κάθε μέθοδος 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)

Τα σημεία λήψης εποπτείας τροφοδοτούν τον πίνακα ελεγκτή και πιστοποιούνται με ένα token 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.

Οι απαιτούμενες παράμετροι και το σώμα του αιτήματος περνούν με τη σειρά. Οι υπόλοιπες προαιρετικές παράμετροι συγκεντρώνονται σε ένα ενιαίο αντικείμενο Api<Operation>Options, το οποίο είναι το τελευταίο όρισμα. Οι λειτουργίες χωρίς προαιρετικές παραμέτρους δεν λαμβάνουν αντικείμενο επιλογών.

Example: Fetching Comments

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"

Σημειώσεις

Αναγνωριστικά Broadcast

Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε ορισμένες κλήσεις API. Όταν λαμβάνετε συμβάντα, θα λάβετε αυτό το ID πίσω, έτσι θα ξέρετε να αγνοήσετε το συμβάν εάν σκοπεύετε να εφαρμόσετε οπτιμιστικά τις αλλαγές στο client (το οποίο πιθανότατα θα θέλετε να κάνετε καθώς προσφέρει την καλύτερη εμπειρία). Δώστε εδώ ένα UUID. Το ID πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μια συνεδρία προγράμματος περιήγησης.

SSO (Ενιαία Σύνδεση)

Για παραδείγματα SSO, δείτε παρακάτω.

Χρήση SSO

Απλό SSO

import fastcomments/sso

let user = newSimpleSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()

echo "SSO Token: ", token

Ασφαλές SSO

import fastcomments/sso

let user = newSecureSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  username = "johndoe",
  avatar = "https://example.com/avatar.jpg"
)

let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()

echo "Secure SSO Token: ", token

Τεκμηρίωση για το FastComments

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires `enableFChat` to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

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

aggregate

Συγκεντρώνει έγγραφα ομαδοποιώντας τα (εάν παρέχεται το groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες.
Διαφορετικές λειτουργίες (π.χ. sum, countDistinct, avg, κ.λπ.) υποστηρίζονται.

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Απάντηση

Επιστρέφει: Option[AggregateResponse]

Παράδειγμα

Παράδειγμα Συγκρότησης

Copy

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

getAuditLogs

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetAuditLogsOptions	Όχι

Απόκριση

Επιστρέφει: Option[GetAuditLogsResponse]

Παράδειγμα

Παράδειγμα getAuditLogs

Copy

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

logoutPublic

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

logoutPublic Παράδειγμα

Copy

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

blockFromCommentPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

Απόκριση

Επιστρέφει: Option[BlockSuccess]

Παράδειγμα

blockFromCommentPublic Παράδειγμα

Copy

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

unBlockCommentPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
publicBlockFromCommentParams	PublicBlockFromCommentParams	Όχι
sso	string = ""	Όχι

Απόκριση

Επιστρέφει: Option[UnblockSuccess]

Παράδειγμα

Παράδειγμα unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentIds	string	Όχι
sso	string = ""	Όχι

Απάντηση

Επιστρέφει: Option[CheckBlockedCommentsResponse]

Παράδειγμα

checkedCommentsForBlocked Παράδειγμα

Copy

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

blockUserFromComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
blockFromCommentParams	BlockFromCommentParams	Όχι
options	BlockUserFromCommentOptions	Όχι

Απόκριση

Επιστρέφει: 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

createCommentPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Απόκριση

Επιστρέφει: 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

deleteComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Απάντηση

Επιστρέφει: Option[DeleteCommentResult]

Παράδειγμα

deleteComment Παράδειγμα

Copy

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

deleteCommentPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
broadcastId	string	Όχι
options	DeleteCommentPublicOptions	Όχι

Απόκριση

Επιστρέφει: Option[PublicAPIDeleteCommentResponse]

Παράδειγμα

deleteCommentPublic Παράδειγμα

Copy

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

deleteCommentVote

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	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()

flagComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
options	FlagCommentOptions	No

Απάντηση

Returns: Option[FlagCommentResponse]

Παράδειγμα

Παράδειγμα flagComment

Copy

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

getComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απόκριση

Επιστρέφει: Option[APIGetCommentResponse]

Παράδειγμα

getComment Παράδειγμα

Copy

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

getComments

Parameters

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetCommentsOptions	Όχι

Response

Επιστρέφει: Option[APIGetCommentsResponse]

Example

Παράδειγμα getComments

Copy

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

getCommentsPublic

req tenantId urlId

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
urlId	string	Yes
options	GetCommentsPublicOptions	No

Απάντηση

Επιστρέφει: Option[GetCommentsResponseWithPresencePublicComment]

Παράδειγμα

getCommentsPublic Παράδειγμα

Copy

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

getCommentText

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
options	GetCommentTextOptions	Όχι

Απόκριση

Επιστρέφει: Option[PublicAPIGetCommentTextResponse]

Παράδειγμα

getCommentText Παράδειγμα

Copy

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

getCommentVoteUserNames

Παράμετροι

Name	Type	Required
tenantId	string	Ναι
commentId	string	Ναι
dir	int	Όχι
sso	string = ""	Όχι

Απάντηση

Επιστρέφει: Option[GetCommentVoteUserNamesSuccessResponse]

Παράδειγμα

Παράδειγμα getCommentVoteUserNames

Copy

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

lockComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
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

pinComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Απάντηση

Επιστρέφει: Option[ChangeCommentPinStatusResponse]

Παράδειγμα

Παράδειγμα pinComment

Copy

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

saveComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
createCommentParams	CreateCommentParams	Όχι
options	SaveCommentOptions	Όχι

Απάντηση

Επιστρέφει: Option[APISaveCommentResponse]

Παράδειγμα

saveComment Παράδειγμα

Copy

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

saveCommentsBulk

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα saveCommentsBulk

Copy

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

setCommentText

Parameters

Όνομα	Τύπος	Απαιτείται
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()

unBlockUserFromComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
unBlockFromCommentParams	UnBlockFromCommentParams	Όχι
options	UnBlockUserFromCommentOptions	Όχι

Απόκριση

Επιστρέφει: Option[UnblockSuccess]

Παράδειγμα

unBlockUserFromComment Παράδειγμα

Copy

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

unFlagComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
options	UnFlagCommentOptions	Όχι

Απάντηση

Επιστρέφει: Option[FlagCommentResponse]

Παράδειγμα

Παράδειγμα unFlagComment

Copy

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

unLockComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
broadcastId	string	Όχι
sso	string = ""	Όχι

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα unLockComment

Copy

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

unPinComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Απόκριση

Επιστρέφει: Option[ChangeCommentPinStatusResponse]

Παράδειγμα

Παράδειγμα unPinComment

Copy

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

updateComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

Απόκριση

Returns: Option[APIEmptyResponse]

Παράδειγμα

updateComment Παράδειγμα

Copy

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

voteComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
urlId	string	Ναι
broadcastId	string	Όχι
voteBodyParams	VoteBodyParams	Όχι
options	VoteCommentOptions	Όχι

Απάντηση

Επιστρέφει: Option[VoteResponse]

Παράδειγμα

voteComment Παράδειγμα

Copy

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

getCommentsForUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
options	GetCommentsForUserOptions	Όχι

Απόκριση

Επιστρέφει: Option[GetCommentsForUserResponse]

Παράδειγμα

Παράδειγμα getCommentsForUser

Copy

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

addDomainConfig

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
addDomainConfigParams	AddDomainConfigParams	Όχι

Απόκριση

Returns: Option[AddDomainConfigResponse]

Παράδειγμα

addDomainConfig Παράδειγμα

Copy

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

deleteDomainConfig

Parameters

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
domain	string	Όχι

Απάντηση

Επιστρέφει: Option[DeleteDomainConfigResponse]

Παράδειγμα

Παράδειγμα deleteDomainConfig

Copy

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

getDomainConfig

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
domain	string	Όχι

Απόκριση

Επιστρέφει: Option[GetDomainConfigResponse]

Παράδειγμα

Παράδειγμα getDomainConfig

Copy

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

getDomainConfigs

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes

Απάντηση

Returns: Option[GetDomainConfigsResponse]

Παράδειγμα

Παράδειγμα getDomainConfigs

Copy

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

patchDomainConfig

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Απάντηση

Επιστρέφει: Option[PatchDomainConfigResponse]

Παράδειγμα

Παράδειγμα patchDomainConfig

Copy

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

putDomainConfig

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

Απάντηση

Επιστρέφει: Option[PutDomainConfigResponse]

Παράδειγμα

Παράδειγμα putDomainConfig

Copy

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

createEmailTemplate

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
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()

deleteEmailTemplate

Παράμετροι

Name	Type	Required	Περιγραφή
tenantId	string	Yes
id	string	No

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

deleteEmailTemplate Παράδειγμα

Copy

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

deleteEmailTemplateRenderError

Parameters

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
errorId	string	No

Response

Επιστρέφει: Option[APIEmptyResponse]

Example

deleteEmailTemplateRenderError Παράδειγμα

Copy

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

getEmailTemplate

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απάντηση

Επιστρέφει: Option[GetEmailTemplateResponse]

Παράδειγμα

Παράδειγμα getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι

Απόκριση

Επιστρέφει: Option[GetEmailTemplateDefinitionsResponse]

Παράδειγμα

Παράδειγμα getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
skip	float64	Όχι

Απάντηση

Επιστρέφει: Option[GetEmailTemplateRenderErrorsResponse]

Παράδειγμα

Παράδειγμα getEmailTemplateRenderErrors

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # χρησιμοποιήστε resp όπως χρειάζεται
else:
  # χειριστείτε την απουσία απάντησης
  discard

getEmailTemplates

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
skip	float64	No

Απόκριση

Επιστρέφει: Option[GetEmailTemplatesResponse]

Παράδειγμα

Παράδειγμα getEmailTemplates

Copy

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

renderEmailTemplate

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

Απάντηση

Επιστρέφει: Option[RenderEmailTemplateResponse]

Παράδειγμα

renderEmailTemplate Παράδειγμα

Copy

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

updateEmailTemplate

Parameters

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
updateEmailTemplateBody	UpdateEmailTemplateBody	Όχι

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

updateEmailTemplate Παράδειγμα

Copy

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

getEventLog

req tenantId urlId userIdWS

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
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

getGlobalEventLog

req tenantId urlId userIdWS

Παράμετροι

Name	Type	Required
tenantId	string	Ναι
urlId	string	Ναι
userIdWS	string	Όχι
startTime	int64	Όχι
endTime	int64	Όχι

Απάντηση

Επιστρέφει: Option[GetEventLogResponse]

Παράδειγμα

Παράδειγμα getGlobalEventLog

Copy

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

createFeedPost

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
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()

createFeedPostPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

Απόκριση

Επιστρέφει: Option[CreateFeedPostResponse]

Παράδειγμα

createFeedPostPublic Παράδειγμα

Copy

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

deleteFeedPostPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
postId	string	No
options	DeleteFeedPostPublicOptions	No

Απόκριση

Επιστρέφει: Option[DeleteFeedPostPublicResponse]

Παράδειγμα

deleteFeedPostPublic Παράδειγμα

Copy

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

getFeedPosts

req tenantId afterId

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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

getFeedPostsPublic

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

getFeedPostsStats

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
postIds	seq[string]	Όχι
sso	string = ""	Όχι

Απόκριση

Επιστρέφει: Option[FeedPostsStatsResponse]

Παράδειγμα

Παράδειγμα getFeedPostsStats

Copy

let (statsOpt, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["post-abc", "post-def"],
  sso = "sso-token",
)
if statsOpt.isSome:
  let stats = statsOpt.get()
  # χρησιμοποίησε τα στατιστικά όπως χρειάζεται

getUserReactsPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetUserReactsPublicOptions	Όχι

Απόκριση

Επιστρέφει: Option[UserReactsResponse]

Παράδειγμα

getUserReactsPublic Παράδειγμα

Copy

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

reactFeedPostPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

Απάντηση

Επιστρέφει: Option[ReactFeedPostResponse]

Παράδειγμα

reactFeedPostPublic Παράδειγμα

Copy

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

updateFeedPost

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
feedPost	FeedPost	Όχι

Απόκριση

Returns: Option[APIEmptyResponse]

Παράδειγμα

updateFeedPost Παράδειγμα

Copy

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

updateFeedPostPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
postId	string	Όχι
updateFeedPostParams	UpdateFeedPostParams	Όχι
options	UpdateFeedPostPublicOptions	Όχι

Απόκριση

Επιστρέφει: Option[CreateFeedPostResponse]

Παράδειγμα

updateFeedPostPublic Παράδειγμα

Copy

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

flagCommentPublic

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
isFlagged	bool	No
sso	string = ""	No

Απόκριση

Επιστρέφει: 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

getGifLarge

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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

getGifsSearch

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()
  # χρησιμοποιήστε το resp όπως χρειάζεται

getGifsTrending

Παράμετροι

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

addHashTag

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

Απάντηση

Επιστρέφει: Option[CreateHashTagResponse]

Παράδειγμα

addHashTag Παράδειγμα

Copy

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

addHashTagsBulk

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Απόκριση

Επιστρέφει: Option[BulkCreateHashTagsResponse]

Παράδειγμα

addHashTagsBulk Παράδειγμα

Copy

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

deleteHashTag

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
tag	string	Όχι
deleteHashTagRequestBody	DeleteHashTagRequestBody	Όχι

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα deleteHashTag

Copy

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

getHashTags

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
page	float64	Όχι

Απάντηση

Επιστρέφει: Option[GetHashTagsResponse]

Παράδειγμα

getHashTags Παράδειγμα

Copy

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

patchHashTag

Παράμετροι

Name	Type	Required
tenantId	string	Yes
tag	string	No
updateHashTagBody	UpdateHashTagBody	No

Απάντηση

Επιστρέφει: Option[UpdateHashTagResponse]

Παράδειγμα

patchHashTag Παράδειγμα

Copy

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

deleteModerationVote

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
voteId	string	Όχι
options	DeleteModerationVoteOptions	Όχι

Απόκριση

Επιστρέφει: Option[VoteDeleteResponse]

Παράδειγμα

deleteModerationVote Παράδειγμα

Copy

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

getApiComments

Παράμετροι

Όνομα	Τύπος	Υποχρεωτικό	Περιγραφή
tenantId	string	Ναι
options	GetApiCommentsOptions	Όχι

Απόκριση

Επιστρέφει: Option[ModerationAPIGetCommentsResponse]

Παράδειγμα

getApiComments Παράδειγμα

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # η περαιτέρω επεξεργασία μπορεί να γίνει με `resp`

getApiExportStatus

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetApiExportStatusOptions	Όχι

Απάντηση

Επιστρέφει: Option[ModerationExportStatusResponse]

Παράδειγμα

Παράδειγμα getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # χρησιμοποιήστε το exportStatus όπως χρειάζεται

getApiIds

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetApiIdsOptions	No

Response

Επιστρέφει: Option[ModerationAPIGetCommentIdsResponse]

Example

Παράδειγμα getApiIds

Copy

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

getBanUsersFromComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Απόκριση

Επιστρέφει: Option[GetBannedUsersFromCommentResponse]

Παράδειγμα

getBanUsersFromComment Παράδειγμα

Copy

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

getCommentBanStatus

Παράμετροι

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

Απόκριση

Επιστρέφει: Option[GetCommentBanStatusResponse]

Παράδειγμα

Παράδειγμα getCommentBanStatus

Copy

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

getCommentChildren

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Απόκριση

Επιστρέφει: Option[ModerationAPIChildCommentsResponse]

Παράδειγμα

getCommentChildren Παράδειγμα

Copy

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

getCount

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetCountOptions	Όχι

Απάντηση

Επιστρέφει: Option[ModerationAPICountCommentsResponse]

Παράδειγμα

Παράδειγμα getCount

Copy

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

getCounts

Παράμετροι

Όνομα	Τύπος	Απαραίτητο	Περιγραφή
tenantId	string	Ναι
sso	string = ""	Όχι

Απόκριση

Επιστρέφει: Option[GetBannedUsersCountResponse]

Παράδειγμα

Παράδειγμα getCounts

Copy

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

getLogs

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
sso	string = ""	Όχι

Απόκριση

Επιστρέφει: Option[ModerationAPIGetLogsResponse]

Παράδειγμα

Παράδειγμα getLogs

Copy

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

getManualBadges

Parameters

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
sso	string = ""	Όχι

Response

Επιστρέφει: Option[GetTenantManualBadgesResponse]

Παράδειγμα

Παράδειγμα getManualBadges

Copy

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

getManualBadgesForUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

Απάντηση

Επιστρέφει: Option[GetUserManualBadgesResponse]

Παράδειγμα

Παράδειγμα getManualBadgesForUser

Copy

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

getModerationComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
options	GetModerationCommentOptions	Όχι

Απάντηση

Επιστρέφει: Option[ModerationAPICommentResponse]

Παράδειγμα

Παράδειγμα getModerationComment

Copy

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

getModerationCommentText

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Απάντηση

Επιστρέφει: Option[GetCommentTextResponse]

Παράδειγμα

Παράδειγμα getModerationCommentText

Copy

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

getPreBanSummary

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
options	GetPreBanSummaryOptions	Όχι

Απάντηση

Επιστρέφει: Option[PreBanSummary]

Παράδειγμα

Παράδειγμα getPreBanSummary

Copy

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

getSearchCommentsSummary

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetSearchCommentsSummaryOptions	Όχι

Απάντηση

Επιστρέφει: Option[ModerationCommentSearchResponse]

Παράδειγμα

getSearchCommentsSummary Παράδειγμα

Copy

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

getSearchPages

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetSearchPagesOptions	Όχι

Απόκριση

Επιστρέφει: Option[ModerationPageSearchResponse]

Παράδειγμα

Παράδειγμα getSearchPages

Copy

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

getSearchSites

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetSearchSitesOptions	Όχι

Απάντηση

Επιστρέφει: Option[ModerationSiteSearchResponse]

Παράδειγμα

getSearchSites Παράδειγμα

Copy

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

getSearchSuggest

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetSearchSuggestOptions	Όχι

Απόκριση

Επιστρέφει: Option[ModerationSuggestResponse]

Παράδειγμα

Παράδειγμα getSearchSuggest

Copy

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

getSearchUsers

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
options	GetSearchUsersOptions	No

Απόκριση

Επιστρέφει: Option[ModerationUserSearchResponse]

Παράδειγμα

Παράδειγμα getSearchUsers

Copy

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

getTrustFactor

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	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

getUserBanPreference

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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

getUserInternalProfile

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
options	GetUserInternalProfileOptions	No

Απόκριση

Επιστρέφει: Option[GetUserInternalProfileResponse]

Παράδειγμα

Παράδειγμα getUserInternalProfile

Copy

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

postAdjustCommentVotes

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

postApiExport

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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

postBanUserFromComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
options	PostBanUserFromCommentOptions	Όχι

Απάντηση

Επιστρέφει: Option[BanUserFromCommentResult]

Παράδειγμα

Παράδειγμα postBanUserFromComment

Copy

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

postBanUserUndo

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
banUserUndoParams	BanUserUndoParams	Όχι
sso	string = ""	Όχι

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

postBanUserUndo Παράδειγμα

Copy

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

postBulkPreBanSummary

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
bulkPreBanParams	BulkPreBanParams	Όχι
options	PostBulkPreBanSummaryOptions	Όχι

Απάντηση

Επιστρέφει: Option[BulkPreBanSummary]

Παράδειγμα

Παράδειγμα postBulkPreBanSummary

Copy

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

postCommentsByIds

Παράμετροι

Name	Type	Required
tenantId	string	Ναι
commentsByIdsParams	CommentsByIdsParams	Όχι
sso	string = ""	Όχι

Απόκριση

Επιστρέφει: Option[ModerationAPIChildCommentsResponse]

Παράδειγμα

Παράδειγμα postCommentsByIds

Copy

let tenantId = "my-tenant-123"
let params = CommentsByIdsParams(commentIds = @["cmt-001", "cmt-002"])
let (maybeResp, httpResp) = client.postCommentsByIds(tenantId = tenantId, commentsByIdsParams = params, sso = "")
if maybeResp.isSome:
  let resp = maybeResp.get()
  # χρησιμοποιήστε resp όπως χρειάζεται

postFlagComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

postRemoveComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

postRestoreDeletedComment

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
options	PostRestoreDeletedCommentOptions	No

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

postRestoreDeletedComment Παράδειγμα

Copy

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

postSetCommentApprovalStatus

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	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

postSetCommentReviewStatus

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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

postSetCommentSpamStatus

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
commentId	string	Ναι
options	PostSetCommentSpamStatusOptions	Όχι

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

postSetCommentSpamStatus Παράδειγμα

Copy

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

postSetCommentText

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	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()

postUnFlagComment

Parameters

Όνομα	Τύπος	Απαιτείται
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()

postVote

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

putAwardBadge

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

putCloseThread

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα putCloseThread

Copy

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

putRemoveBadge

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
badgeId	string	Όχι
options	PutRemoveBadgeOptions	Όχι

Απόκριση

Returns: Option[RemoveUserBadgeResponse]

Παράδειγμα

Παράδειγμα putRemoveBadge

Copy

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

putReopenThread

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Απάντηση

Επιστρέφει: 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

setTrustFactor

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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()

createModerator

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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()

deleteModerator

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
sendEmail	string = ""	Όχι

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

deleteModerator Παράδειγμα

Copy

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

getModerator

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απόκριση

Επιστρέφει: Option[GetModeratorResponse]

Παράδειγμα

Παράδειγμα getModerator

Copy

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

getModerators

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	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

updateModerator

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
updateModeratorBody	UpdateModeratorBody	Όχι

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα updateModerator

Copy

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

deleteNotificationCount

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
id	string	No

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

deleteNotificationCount Παράδειγμα

Copy

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

getCachedNotificationCount

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
id	string	No

Απάντηση

Επιστρέφει: Option[GetCachedNotificationCountResponse]

Παράδειγμα

getCachedNotificationCount Παράδειγμα

Copy

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

getNotificationCount

Παράμετρα

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
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

getNotifications

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetNotificationsOptions	Όχι

Απάντηση

Επιστρέφει: Option[GetNotificationsResponse]

Παράδειγμα

getNotifications Παράδειγμα

Copy

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

updateNotification

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
updateNotificationBody	UpdateNotificationBody	Όχι
userId	string = ""	Όχι

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

updateNotification Παράδειγμα

Copy

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

createV1PageReact

Parameters

Όνομα	Τύπος	Απαραίτητο
tenantId	string	Yes
urlId	string	Yes
title	string = ""	No

Response

Επιστρέφει: Option[CreateV1PageReact]

Παράδειγμα

createV1PageReact Παράδειγμα

Copy

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

---

createV2PageReact

Παράμετροι

Name	Type	Required
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` όπως χρειάζεται

deleteV1PageReact

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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()

deleteV2PageReact

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
urlId	string	Yes
id	string	No

Απόκριση

Επιστρέφει: Option[CreateV1PageReact]

Παράδειγμα

deleteV2PageReact Παράδειγμα

Copy

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

getV1PageLikes

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
urlId	string	Yes

Απόκριση

Επιστρέφει: Option[GetV1PageLikes]

Παράδειγμα

Παράδειγμα getV1PageLikes

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # χρησιμοποιήστε το pageLikes όπως χρειάζεται

getV2PageReacts

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
urlId	string	Ναι

Απόκριση

Επιστρέφει: Option[GetV2PageReacts]

Παράδειγμα

Παράδειγμα getV2PageReacts

Copy

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

getV2PageReactUsers

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
urlId	string	Ναι
id	string	Όχι

Απόκριση

Επιστρέφει: Option[GetV2PageReactUsersResponse]

Παράδειγμα

Παράδειγμα getV2PageReactUsers

Copy

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

addPage

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
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

deletePage

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
id	string	No

Απάντηση

Επιστρέφει: Option[DeletePageAPIResponse]

Παράδειγμα

deletePage Παράδειγμα

Copy

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

getOfflineUsers

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

Parameters

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
urlId	string	Ναι
options	GetOfflineUsersOptions	Όχι

Response

Επιστρέφει: Option[PageUsersOfflineResponse]

Example

Παράδειγμα getOfflineUsers

Copy

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

getOnlineUsers

Παρόντες online θεατές μιας σελίδας: άτομα των οποίων η συνεδρία 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

getPageByURLId

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
urlId	string	Yes

Απάντηση

Επιστρέφει: Option[GetPageByURLIdAPIResponse]

Παράδειγμα

Παράδειγμα getPageByURLId

Copy

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

getPages

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes

Απάντηση

Επιστρέφει: Option[GetPagesAPIResponse]

Παράδειγμα

getPages Παράδειγμα

Copy

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

getPagesPublic

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.

Λίστα σελίδων για έναν ενοικιαστή. Χρησιμοποιείται από τον πελάτη FChat στην επιφάνεια εργασίας για τη συμπλήρωση της λίστας δωματίων του. Απαιτεί το enableFChat να είναι true στην επιλυμένη προσαρμοσμένη διαμόρφωση για κάθε σελίδα. Οι σελίδες που απαιτούν SSO φιλτράρονται βάσει της πρόσβασης ομάδας του χρήστη που κάνει την αίτηση.

Parameters

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
options	GetPagesPublicOptions	No

Response

Επιστρέφει: Option[GetPublicPagesResponse]

Example

Παράδειγμα getPagesPublic

Copy

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

getUsersInfo

Συγκεντρωτικές πληροφορίες χρήστη για έναν ενοικιαστή. Δεδομένων των userIds, επιστρέφει πληροφορίες εμφάνισης από το User / SSOUser.
Χρησιμοποιείται από το widget σχολίων για να εμπλουτίσει τους χρήστες που μόλις εμφανίστηκαν μέσω ενός γεγονότος παρουσίας.
Χωρίς περιβάλλον σελίδας: η ιδιωτικότητα εφαρμόζεται ομοιόμορφα (τα ιδιωτικά προφίλ είναι μηδενισμένα).

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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()  

patchPage

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Απάντηση

Επιστρέφει: Option[PatchPageAPIResponse]

Παράδειγμα

Παράδειγμα patchPage

Copy

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

deletePendingWebhookEvent

Parameters

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

deletePendingWebhookEvent Παράδειγμα

Copy

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

getPendingWebhookEventCount

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetPendingWebhookEventCountOptions	Όχι

Απόκριση

Επιστρέφει: Option[GetPendingWebhookEventCountResponse]

Παράδειγμα

getPendingWebhookEventCount Παράδειγμα

Copy

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

getPendingWebhookEvents

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
options	GetPendingWebhookEventsOptions	No

Απόκριση

Επιστρέφει: Option[GetPendingWebhookEventsResponse]

Παράδειγμα

Παράδειγμα getPendingWebhookEvents

Copy

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

createQuestionConfig

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
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()
  # χρήση resp όπως απαιτείται

deleteQuestionConfig

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

deleteQuestionConfig Παράδειγμα

Copy

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

getQuestionConfig

Παράμετροι

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Απάντηση

Επιστρέφει: Option[GetQuestionConfigResponse]

Παράδειγμα

getQuestionConfig Παράδειγμα

Copy

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

getQuestionConfigs

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
skip	float64	Όχι

Απάντηση

Επιστρέφει: Option[GetQuestionConfigsResponse]

Παράδειγμα

Παράδειγμα getQuestionConfigs

Copy

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

updateQuestionConfig

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
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()

createQuestionResult

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
createQuestionResultBody	CreateQuestionResultBody	Όχι

Απάντηση

Επιστρέφει: Option[CreateQuestionResultResponse]

Παράδειγμα

createQuestionResult Παράδειγμα

Copy

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

deleteQuestionResult

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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()

getQuestionResult

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απόκριση

Επιστρέφει: Option[GetQuestionResultResponse]

Παράδειγμα

getQuestionResult Παράδειγμα

Copy

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

getQuestionResults

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetQuestionResultsOptions	Όχι

Απόκριση

Επιστρέφει: Option[GetQuestionResultsResponse]

Παράδειγμα

Παράδειγμα getQuestionResults

Copy

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

updateQuestionResult

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

updateQuestionResult Παράδειγμα

Copy

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

aggregateQuestionResults

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	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()

bulkAggregateQuestionResults

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Απόκριση

Επιστρέφει: Option[BulkAggregateQuestionResultsResponse]

Παράδειγμα

bulkAggregateQuestionResults Παράδειγμα

Copy

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

combineCommentsWithQuestionResults

Parameters

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
options	CombineCommentsWithQuestionResultsOptions	No

Response

Επιστρέφει: Option[CombineQuestionResultsWithCommentsResponse]

Παράδειγμα

Παράδειγμα combineCommentsWithQuestionResults

Copy

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

addSSOUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	No

Απάντηση

Επιστρέφει: Option[AddSSOUserAPIResponse]

Παράδειγμα

addSSOUser Παράδειγμα

Copy

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

deleteSSOUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
options	DeleteSSOUserOptions	No

Απόκριση

Επιστρέφει: 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()

getSSOUserByEmail

Παράμετροι

Name	Type	Required	Description
tenantId	string	Yes
email	string	No

Απάντηση

Επιστρέφει: Option[GetSSOUserByEmailAPIResponse]

Παράδειγμα

getSSOUserByEmail Παράδειγμα

Copy

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

getSSOUserById

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απόκριση

Επιστρέφει: Option[GetSSOUserByIdAPIResponse]

Παράδειγμα

getSSOUserById Παράδειγμα

Copy

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

getSSOUsers

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
skip	int	Όχι

Απάντηση

Επιστρέφει: Option[GetSSOUsersResponse]

Παράδειγμα

getSSOUsers Παράδειγμα

Copy

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

patchSSOUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Απάντηση

Επιστρέφει: Option[PatchSSOUserAPIResponse]

Παράδειγμα

Παράδειγμα patchSSOUser

Copy

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

putSSOUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
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

createSubscription

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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()

deleteSubscription

Παράμετροι

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

Απάντηση

Επιστρέφει: Option[DeleteSubscriptionAPIResponse]

Παράδειγμα

Παράδειγμα deleteSubscription

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # χρησιμοποιήστε το apiResult όπως χρειάζεται

getSubscriptions

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
userId	string = ""	Όχι

Απάντηση

Επιστρέφει: 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

updateSubscription

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

getTenantDailyUsages

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
options	GetTenantDailyUsagesOptions	No

Απόκριση

Επιστρέφει: Option[GetTenantDailyUsagesResponse]

Παράδειγμα

Παράδειγμα getTenantDailyUsages

Copy

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

createTenantPackage

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
createTenantPackageBody	CreateTenantPackageBody	Όχι

Απόκριση

Επιστρέφει: Option[CreateTenantPackageResponse]

Παράδειγμα

createTenantPackage Παράδειγμα

Copy

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

deleteTenantPackage

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
id	string	No

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα deleteTenantPackage

Copy

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

getTenantPackage

Parameters

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
id	string	No

Response

Επιστρέφει: Option[GetTenantPackageResponse]

Παράδειγμα

Παράδειγμα getTenantPackage

Copy

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

getTenantPackages

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
skip	float64	Όχι

Απάντηση

Επιστρέφει: Option[GetTenantPackagesResponse]

Παράδειγμα

Παράδειγμα getTenantPackages

Copy

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

replaceTenantPackage

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
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

updateTenantPackage

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

updateTenantPackage Παράδειγμα

Copy

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

createTenantUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

Απόκριση

Επιστρέφει: Option[CreateTenantUserResponse]

Παράδειγμα

createTenantUser Παράδειγμα

Copy

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

deleteTenantUser

Παράμετροι

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"

getTenantUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απάντηση

Επιστρέφει: Option[GetTenantUserResponse]

Παράδειγμα

Παράδειγμα getTenantUser

Copy

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

getTenantUsers

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
skip	float64	Όχι

Απάντηση

Επιστρέφει: Option[GetTenantUsersResponse]

Παράδειγμα

getTenantUsers Παράδειγμα

Copy

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

replaceTenantUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

sendLoginLink

Parameters

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

Response

Επιστρέφει: Option[APIEmptyResponse]

Example

sendLoginLink Παράδειγμα

Copy

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

updateTenantUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Απόκριση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα updateTenantUser

Copy

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

createTenant

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
createTenantBody	CreateTenantBody	No

Απάντηση

Επιστρέφει: 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

deleteTenant

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

getTenant

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απάντηση

Επιστρέφει: Option[GetTenantResponse]

Παράδειγμα

Παράδειγμα getTenant

Copy

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

getTenants

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	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

updateTenant

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
updateTenantBody	UpdateTenantBody	Όχι

Απάντηση

Επιστρέφει: Option[APIEmptyResponse]

Παράδειγμα

Παράδειγμα updateTenant

Copy

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

changeTicketState

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	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

createTicket

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
userId	string	Όχι
createTicketBody	CreateTicketBody	Όχι

Απόκριση

Returns: Option[CreateTicketResponse]

Παράδειγμα

Παράδειγμα createTicket

Copy

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

getTicket

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
id	string	Όχι
userId	string = ""	Όχι

Απόκριση

Επιστρέφει: 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

getTickets

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	GetTicketsOptions	Όχι

Απόκριση

Επιστρέφει: Option[GetTicketsResponse]

Παράδειγμα

Παράδειγμα getTickets

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # χρησιμοποιήστε τα εισιτήρια όπως χρειάζεται

getTranslations

Παράμετροι

Name	Type	Required
namespace	string	No
component	string	No
options	GetTranslationsOptions	No

Απόκριση

Επιστρέφει: Option[GetTranslationsResponse]

Παράδειγμα

Παράδειγμα getTranslations

Copy

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

uploadImage

Upload and resize an image

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Απάντηση

Επιστρέφει: Option[UploadImageResponse]

Παράδειγμα

uploadImage Παράδειγμα

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # χρησιμοποιήστε το αποτέλεσμα όπως χρειάζεται

getUserBadgeProgressById

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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

getUserBadgeProgressByUserId

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
userId	string	Όχι

Απάντηση

Επιστρέφει: Option[APIGetUserBadgeProgressResponse]

Παράδειγμα

Παράδειγμα getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	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()

createUserBadge

Παράμετροι

Name	Type	Required	Description
tenantId	string	Ναι
createUserBadgeParams	CreateUserBadgeParams	Όχι

Απόκριση

Επιστρέφει: Option[APICreateUserBadgeResponse]

Παράδειγμα

Παράδειγμα createUserBadge

Copy

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

deleteUserBadge

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
id	string	Όχι

Απάντηση

Επιστρέφει: Option[APIEmptySuccessResponse]

Παράδειγμα

Παράδειγμα deleteUserBadge

Copy

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

getUserBadge

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
id	string	No

Απάντηση

Επιστρέφει: Option[APIGetUserBadgeResponse]

Παράδειγμα

Παράδειγμα getUserBadge

Copy

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

getUserBadges

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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()

updateUserBadge

Παράμετροι

Όνομα	Τύπος	Απαιτείται
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()

getUserNotificationCount

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
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

getUserNotifications

Παράμετροι

Name	Type	Required	Description
tenantId	string	Yes
options	GetUserNotificationsOptions	No

Απάντηση

Επιστρέφει: Option[GetMyNotificationsResponse]

Παράδειγμα

getUserNotifications Παράδειγμα

Copy

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

resetUserNotificationCount

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
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"

resetUserNotifications

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
options	ResetUserNotificationsOptions	Όχι

Απάντηση

Επιστρέφει: Option[ResetUserNotificationsResponse]

Παράδειγμα

resetUserNotifications Παράδειγμα

Copy

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

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
notificationId	string	No
optedInOrOut	string	No
commentId	string	Yes
sso	string = ""	No

Response

Επιστρέφει: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Example

updateUserNotificationCommentSubscriptionStatus Παράδειγμα

Copy

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

updateUserNotificationPageSubscriptionStatus

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

Parameters

Όνομα	Τύπος	Απαιτείται
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

updateUserNotificationStatus

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
notificationId	string	Όχι
newStatus	string	Όχι
sso	string = ""	Όχι

Απόκριση

Επιστρέφει: 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()

getUserPresenceStatuses

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
urlIdWS	string	Όχι
userIds	string	Όχι

Απάντηση

Επιστρέφει: Option[GetUserPresenceStatusesResponse]

Παράδειγμα

getUserPresenceStatuses Παράδειγμα

Copy

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

searchUsers

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Ναι
urlId	string	Ναι
options	SearchUsersOptions	Όχι

Απόκριση

Επιστρέφει: Option[SearchUsersResult]

Παράδειγμα

searchUsers Παράδειγμα

Copy

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

getUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Ναι
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"

createVote

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
commentId	string	Yes
direction	string	No
options	CreateVoteOptions	No

Απάντηση

Επιστρέφει: Option[VoteResponse]

Παράδειγμα

createVote Παράδειγμα

Copy

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

deleteVote

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	Yes
id	string	No
editKey	string = ""	No

Απάντηση

Επιστρέφει: Option[VoteDeleteResponse]

Παράδειγμα

Παράδειγμα deleteVote

Copy

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

getVotes

Παράμετροι

Όνομα	Τύπος	Απαιτείται	Περιγραφή
tenantId	string	Yes
urlId	string	Yes

Απάντηση

Επιστρέφει: Option[GetVotesResponse]

Παράδειγμα

Παράδειγμα getVotes

Copy

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

getVotesForUser

Παράμετροι

Όνομα	Τύπος	Απαιτείται
tenantId	string	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

Χρήση

Συναθροιστικά

Καταγραφές ελέγχου

Αυθεντικοποίηση

Αποκλεισμός από σχόλιο

Έλεγχος αποκλεισμένων σχολίων

Σχόλια

Σχόλια χρήστη

Διαμορφώσεις τομέα

Πρότυπα Email

Καταγραφή συμβάντων

Αναρτήσεις ροής

Σήμανση σχολίου

GIFs

Hashtags

Εποπτεία

Επόπτες

Αριθμός ειδοποιήσεων

Ειδοποιήσεις

Αντιδράσεις σε σελίδα

Σελίδες

Εκκρεμή γεγονότα Webhook

Ρυθμίσεις ερωτήσεων

Αποτελέσματα ερωτήσεων

Συγκέντρωση αποτελεσμάτων ερωτήσεων

Χρήστες SSO

Συνδρομές

Ημερήσια χρήση ενοικιαστή

Πακέτα ενοικιαστή

Χρήστες ενοικιαστή

Ενοικιαστές

Εισιτήρια

Μεταφράσεις

Ανέβασμα εικόνας

Πρόοδος badges χρήστη

Διακριτικά χρήστη

Ειδοποιήσεις χρήστη

Κατάσταση παρουσίας χρήστη

Αναζήτηση χρηστών

Χρήστες

Ψήφοι

FastComments SDK για Nim

Αποθετήριο

Απαιτήσεις

Εγκατάσταση

Χρήση Nimble

Δόμηση από Πηγή

Περιεχόμενα Βιβλιοθήκης

Δημόσια vs Προστατευμένα APIs

Γρήγορη Εκκίνηση

Χρήση Πιστοποιημένων API (DefaultAPI)

Χρήση Δημοσίων API (PublicAPI)

Χρήση API Εποπτείας (ModerationAPI)

Κοινά Προβλήματα

Κλήσεις API

Example: Fetching Comments

Σημειώσεις

Αναγνωριστικά Broadcast

SSO (Ενιαία Σύνδεση)

Χρήση SSO

Απλό SSO

Ασφαλές SSO

Τεκμηρίωση για το FastComments

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

aggregate

Παράμετροι

Απάντηση

Παράδειγμα

getAuditLogs

Παράμετροι

Απόκριση

Παράδειγμα

logoutPublic