FastComments Nim SDK

यह FastComments का आधिकारिक Nim SDK है।

अपने Nim एप्लिकेशन से कमेंट्स, यूज़र्स, SSO और मॉडरेशन को प्रबंधित करें।

रिपॉज़िटरी

AI कोडिंग एजेंट

अपने कोडिंग एजेंट को FastComments का वह संदर्भ दें जिसकी उसे आवश्यकता है - विजेट्स, कॉन्फ़िगरेशन, Secure SSO, REST API, और SDKs:

npx skills add fastcomments/skills

यह Claude Code, Codex, Cursor, Copilot, Gemini, और skills CLI द्वारा समर्थित हर अन्य एजेंट के साथ काम करता है।

आवश्यकताएँ

Nim >= 1.6.0
nimcrypto >= 0.5.4

इंस्टॉलेशन

Nimble का उपयोग करना

nimble install fastcomments

स्रोत से बिल्ड करना

nimble build

लाइब्रेरी की सामग्री

इस लाइब्रेरी में जेनरेट किया गया API क्लाइंट और SSO यूटिलिटीज़ शामिल हैं, जो API के साथ काम करना आसान बनाते हैं।

API क्लाइंट लाइब्रेरी दस्तावेज़ीकरण

पब्लिक बनाम सुरक्षित APIs

API क्लाइंट में तीन API मॉड्यूल हैं: api_default, api_public, और api_moderation। api_default में वे मेथड्स हैं जिनके लिए आपकी API key आवश्यक है, और api_public में वे API कॉल शामिल हैं जिन्हें बिना प्रमाणीकरण के सीधे ब्राउज़र/मोबाइल डिवाइस/आदि से किया जा सकता है। api_moderation मॉड्यूल में मॉडरेटर डैशबोर्ड के लिए मेथड्स हैं।

api_moderation मॉड्यूल लाइव और तेज़ मॉडरेशन APIs का एक व्यापक सूट प्रदान करता है। हर api_moderation मेथड एक sso पैरामीटर स्वीकार करता है और SSO या FastComments.com सेशन कुकी के माध्यम से प्रमाणित हो सकता है।

क्विक स्टार्ट

प्रमाणित APIs का उपयोग (DefaultAPI)

महत्वपूर्ण: प्रमाणित endpoints के लिए आपकी API key को x-api-key header के रूप में सेट करना आवश्यक है।

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

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

# प्रमाणित API कॉल करें।
# आवश्यक पैरामीटर (और request body) positional होते हैं; वैकल्पिक
# पैरामीटर operation के 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"

सार्वजनिक APIs का उपयोग (PublicAPI)

सार्वजनिक endpoints के लिए प्रमाणीकरण की आवश्यकता नहीं है:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# सार्वजनिक API कॉल करें।
# tenantId और urlId आवश्यक हैं (positional); बाकी सब वैकल्पिक है।
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"

मॉडरेशन APIs का उपयोग (ModerationAPI)

मॉडरेशन endpoints मॉडरेटर डैशबोर्ड को संचालित करते हैं और कार्यरत मॉडरेटर के लिए SSO token से प्रमाणित होते हैं:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# मॉडरेशन डैशबोर्ड में कमेंट्स की सूची बनाएं।
# इस operation में कोई आवश्यक पैरामीटर नहीं है, इसलिए सब कुछ वैकल्पिक है।
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 प्रमाणीकरण त्रुटि: DefaultAPI requests करने से पहले अपने HttpClient पर x-api-key header सेट करना सुनिश्चित करें: client.headers["x-api-key"] = "your-api-key"
गलत API class: सर्वर-साइड प्रमाणित requests के लिए api_default, क्लाइंट-साइड/सार्वजनिक requests के लिए api_public, और मॉडरेटर डैशबोर्ड requests के लिए api_moderation का उपयोग करें।

API कॉल करना

इस SDK की सभी API मेथड्स (Option[ResponseType], Response) के टुपल्स लौटाती हैं। पहला एलिमेंट सफल होने पर पार्स किया गया रिस्पॉन्स रखता है, और दूसरा एलिमेंट रॉ HTTP रिस्पॉन्स है।

आवश्यक पैरामीटर और रिक्वेस्ट बॉडी पोज़िशनल रूप से पास किए जाते हैं। शेष वैकल्पिक पैरामीटर एक ही Api<Operation>Options ऑब्जेक्ट में संग्रहित होते हैं, जो अंतिम आर्ग्युमेंट होता है। जिन ऑपरेशनों में कोई वैकल्पिक पैरामीटर नहीं होता, वे कोई ऑप्शंस ऑब्जेक्ट नहीं लेते।

उदाहरण: कमेंट्स प्राप्त करना

import httpclient
import options
import fastcomments
import fastcomments/apis/api_default

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

let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

नोट्स

ब्रॉडकास्ट आईडी (Broadcast Ids)

आप देखेंगे कि कुछ API कॉल में broadcastId पास करना अपेक्षित है। जब आपको इवेंट्स प्राप्त होते हैं, तो आपको यह ID वापस मिलेगी, ताकि आप जान सकें कि यदि आप क्लाइंट पर ऑप्टिमिस्टिक रूप से बदलाव लागू करने की योजना बना रहे हैं (जो आप शायद करना चाहेंगे क्योंकि यह सबसे बेहतर अनुभव देता है) तो उस इवेंट को अनदेखा करें। यहाँ एक UUID पास करें। यह ID इतनी अद्वितीय होनी चाहिए कि वह एक ब्राउज़र सेशन में दो बार न आए।

SSO (सिंगल साइन-ऑन)

SSO के उदाहरणों के लिए, नीचे देखें।

SSO उपयोग

सरल SSO

import fastcomments/sso

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

echo "SSO Token: ", token

सुरक्षित SSO

import fastcomments/sso

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

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

echo "Secure SSO Token: ", token

fastcomments के लिए दस्तावेज़ीकरण

Documentation for API Endpoints

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

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

Documentation for Models

Documentation for Authorization

api_key

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

aggregate

दस्तावेज़ों को समूहित करके (यदि groupBy दिया गया है) और कई ऑपरेशन लागू करके एकत्रित करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
aggregationRequest	AggregationRequest	नहीं
options	AggregateOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[AggregateResponse]

उदाहरण

aggregate उदाहरण

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	हाँ
commentId	string	हाँ
publicBlockFromCommentParams	PublicBlockFromCommentParams	नहीं
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: 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	हाँ
urlId	string	हाँ
broadcastId	string	नहीं
commentData	CommentData	नहीं
options	CreateCommentPublicOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[SaveCommentsResponseWithPresence]

उदाहरण

createCommentPublic उदाहरण

Copy

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

deleteComment

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
options	DeleteCommentOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: 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	हाँ
commentId	string	हाँ
voteId	string	नहीं
urlId	string	हाँ
broadcastId	string	नहीं
options	DeleteCommentVoteOptions	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
id	string	नहीं
options	FlagCommentOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[FlagCommentResponse]

उदाहरण

flagComment उदाहरण

Copy

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

getComment

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
id	string	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIGetCommentResponse]

उदाहरण

getComment उदाहरण

Copy

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

getComments

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetCommentsOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIGetCommentsResponse]

उदाहरण

getComments उदाहरण

Copy

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

getCommentsPublic

req tenantId urlId

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
urlId	string	हाँ
options	GetCommentsPublicOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetCommentsResponseWithPresencePublicComment]

उदाहरण

getCommentsPublic उदाहरण

Copy

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

getCommentText

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
commentId	string	हाँ
options	GetCommentTextOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[PublicAPIGetCommentTextResponse]

उदाहरण

getCommentText उदाहरण

Copy

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

getCommentVoteUserNames

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
commentId	string	हाँ
dir	int	नहीं
sso	string = ""	नहीं

प्रतिक्रिया

लौटाता है: Option[GetCommentVoteUserNamesSuccessResponse]

उदाहरण

getCommentVoteUserNames उदाहरण

Copy

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

lockComment

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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	हाँ
commentId	string	हाँ
broadcastId	string	नहीं
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[ChangeCommentPinStatusResponse]

उदाहरण

pinComment उदाहरण

Copy

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

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	हाँ
createCommentParams	seq[CreateCommentParams]	नहीं
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	नहीं
id	string	नहीं
fromName	string	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

saveCommentsBulk उदाहरण

Copy

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

setCommentText

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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	हाँ
commentId	string	हाँ
broadcastId	string	नहीं
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[ChangeCommentPinStatusResponse]

उदाहरण

unPinComment उदाहरण

Copy

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

updateComment

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
updatableCommentParams	UpdatableCommentParams	नहीं
options	UpdateCommentOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

updateComment उदाहरण

Copy

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

voteComment

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[AddDomainConfigResponse]

उदाहरण

addDomainConfig उदाहरण

Copy

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

deleteDomainConfig

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
domain	string	नहीं

प्रतिक्रिया

लौटाता है: Option[DeleteDomainConfigResponse]

उदाहरण

deleteDomainConfig उदाहरण

Copy

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

getDomainConfig

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
domain	string	नहीं

प्रतिक्रिया

लौटाता है: Option[GetDomainConfigResponse]

उदाहरण

getDomainConfig उदाहरण

Copy

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

getDomainConfigs

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ

प्रतिक्रिया

लौटाता है: Option[GetDomainConfigsResponse]

उदाहरण

getDomainConfigs उदाहरण

Copy

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

patchDomainConfig

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
domainToUpdate	string	नहीं
patchDomainConfigParams	PatchDomainConfigParams	नहीं

प्रतिक्रिया

लौटाता है: Option[PatchDomainConfigResponse]

उदाहरण

patchDomainConfig उदाहरण

Copy

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

putDomainConfig

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
domainToUpdate	string	नहीं
updateDomainConfigParams	UpdateDomainConfigParams	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[PutDomainConfigResponse]

उदाहरण

putDomainConfig उदाहरण

Copy

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

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

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

deleteEmailTemplate उदाहरण

Copy

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

deleteEmailTemplateRenderError

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
errorId	string	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

deleteEmailTemplateRenderError उदाहरण

Copy

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

getEmailTemplate

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: Option[GetEmailTemplateResponse]

उदाहरण

getEmailTemplate उदाहरण

Copy

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

getEmailTemplateDefinitions

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ

प्रतिक्रिया

लौटाता है: Option[GetEmailTemplateDefinitionsResponse]

उदाहरण

getEmailTemplateDefinitions उदाहरण

Copy

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

getEmailTemplateRenderErrors

पैरामीटर

नाम	प्रकार	आवश्यक
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	हाँ
skip	float64	नहीं

प्रतिक्रिया

लौटाता है: Option[GetEmailTemplatesResponse]

उदाहरण

getEmailTemplates उदाहरण

Copy

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

renderEmailTemplate

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
renderEmailTemplateBody	RenderEmailTemplateBody	नहीं
locale	string = ""	नहीं

प्रतिक्रिया

लौटाता है: Option[RenderEmailTemplateResponse]

उदाहरण

renderEmailTemplate उदाहरण

Copy

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

updateEmailTemplate

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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

पैरामीटर

नाम	प्रकार	आवश्यक
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	हाँ
createFeedPostParams	CreateFeedPostParams	नहीं
options	CreateFeedPostPublicOptions	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
postId	string	नहीं
options	DeleteFeedPostPublicOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[DeleteFeedPostPublicResponse]

उदाहरण

deleteFeedPostPublic उदाहरण

Copy

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

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()
  # stats का आवश्यकतानुसार उपयोग करें

getUserReactsPublic

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetUserReactsPublicOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[UserReactsResponse]

उदाहरण

getUserReactsPublic उदाहरण

Copy

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

reactFeedPostPublic

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
postId	string	नहीं
reactBodyParams	ReactBodyParams	नहीं
options	ReactFeedPostPublicOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[ReactFeedPostResponse]

उदाहरण

reactFeedPostPublic उदाहरण

Copy

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

updateFeedPost

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
feedPost	FeedPost	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

updateFeedPost उदाहरण

Copy

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

updateFeedPostPublic

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
postId	string	नहीं
updateFeedPostParams	UpdateFeedPostParams	नहीं
options	UpdateFeedPostPublicOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[CreateFeedPostResponse]

उदाहरण

updateFeedPostPublic उदाहरण

Copy

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

flagCommentPublic

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
commentId	string	हाँ
isFlagged	bool	नहीं
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

flagCommentPublic उदाहरण

Copy

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

getGifLarge

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
largeInternalURLSanitized	string	नहीं

प्रतिक्रिया

लौटाता है: 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

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetGifsTrendingOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetGifsTrendingResponse]

उदाहरण

getGifsTrending उदाहरण

Copy

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

addHashTag

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
createHashTagBody	CreateHashTagBody	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[CreateHashTagResponse]

उदाहरण

addHashTag उदाहरण

Copy

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

addHashTagsBulk

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
bulkCreateHashTagsBody	BulkCreateHashTagsBody	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[BulkCreateHashTagsResponse]

उदाहरण

addHashTagsBulk उदाहरण

Copy

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

deleteHashTag

पैरामीटर

नाम	प्रकार	आवश्यक
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

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
tag	string	नहीं
updateHashTagBody	UpdateHashTagBody	नहीं

प्रतिक्रिया

लौटाता है: Option[UpdateHashTagResponse]

उदाहरण

patchHashTag उदाहरण

Copy

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

deleteModerationVote

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetApiIdsOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[ModerationAPIGetCommentIdsResponse]

उदाहरण

getApiIds उदाहरण

Copy

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

getBanUsersFromComment

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
commentId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetBannedUsersFromCommentResponse]

उदाहरण

getBanUsersFromComment उदाहरण

Copy

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

getCommentBanStatus

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
commentId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetCommentBanStatusResponse]

उदाहरण

getCommentBanStatus उदाहरण

Copy

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

getCommentChildren

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
commentId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: 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

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

लौटाता है: Option[GetTenantManualBadgesResponse]

उदाहरण

getManualBadges उदाहरण

Copy

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

getManualBadgesForUser

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetManualBadgesForUserOptions	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
commentId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
options	GetSearchUsersOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[ModerationUserSearchResponse]

उदाहरण

getSearchUsers उदाहरण

Copy

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

getTrustFactor

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetTrustFactorOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetUserTrustFactorResponse]

उदाहरण

getTrustFactor उदाहरण

Copy

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

getUserBanPreference

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
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	हाँ
options	GetUserInternalProfileOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: 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	हाँ
commentId	string	हाँ
adjustCommentVotesParams	AdjustCommentVotesParams	नहीं
options	PostAdjustCommentVotesOptions	नहीं

प्रतिक्रिया

रिटर्न: 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

पैरामीटर

नाम	प्रकार	आवश्यक
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	हाँ
commentId	string	हाँ
options	PostFlagCommentOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

postFlagComment उदाहरण

Copy

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

postRemoveComment

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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	हाँ
commentId	string	हाँ
options	PostRestoreDeletedCommentOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

postRestoreDeletedComment उदाहरण

Copy

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

postSetCommentApprovalStatus

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
commentId	string	हाँ
options	PostSetCommentApprovalStatusOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[SetCommentApprovedResponse]

उदाहरण

postSetCommentApprovalStatus उदाहरण

Copy

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

postSetCommentReviewStatus

पैरामीटर

नाम	प्रकार	आवश्यक
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	हाँ
commentId	string	हाँ
setCommentTextParams	SetCommentTextParams	नहीं
options	PostSetCommentTextOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[SetCommentTextResponse]

उदाहरण

postSetCommentText उदाहरण

Copy

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

postUnFlagComment

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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	हाँ
commentId	string	हाँ
options	PostVoteOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[VoteResponse]

उदाहरण

postVote उदाहरण

Copy

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

putAwardBadge

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
badgeId	string	नहीं
options	PutAwardBadgeOptions	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
urlId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

putCloseThread उदाहरण

Copy

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

putRemoveBadge

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
badgeId	string	नहीं
options	PutRemoveBadgeOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[RemoveUserBadgeResponse]

उदाहरण

putRemoveBadge उदाहरण

Copy

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

putReopenThread

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
urlId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

putReopenThread उदाहरण

Copy

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

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	हाँ
skip	float64	नहीं

प्रतिक्रिया

लौटाता है: Option[GetModeratorsResponse]

उदाहरण

getModerators उदाहरण

Copy

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

updateModerator

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
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	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: 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

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
urlId	string	हाँ
title	string = ""	नहीं

प्रतिक्रिया

लौटाता है: Option[CreateV1PageReact]

उदाहरण

createV1PageReact उदाहरण

Copy

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

createV2PageReact

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
urlId	string	हाँ
id	string	नहीं
title	string = ""	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
urlId	string	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: Option[CreateV1PageReact]

उदाहरण

deleteV2PageReact उदाहरण

Copy

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

getV1PageLikes

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
urlId	string	हाँ

प्रतिक्रिया

लौटाता है: Option[GetV1PageLikes]

उदाहरण

getV1PageLikes उदाहरण

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # pageLikes का आवश्यकतानुसार उपयोग करें

getV2PageReacts

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
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	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: Option[DeletePageAPIResponse]

उदाहरण

deletePage उदाहरण

Copy

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

getOfflineUsers

पेज पर उन पिछले टिप्पणीकारों की सूची जो इस समय ऑनलाइन नहीं हैं। displayName के अनुसार क्रमबद्ध। "Members" सेक्शन रेंडर करने के लिए /users/online का उपयोग पूरा करने के बाद इसका उपयोग करें। commenterName पर कर्सर पेजिनेशन: सर्वर afterName से आगे $gt के माध्यम से आंशिक {tenantId, urlId, commenterName} इंडेक्स को ट्रैवर्स करता है, बिना $skip लागत के।

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
urlId	string	हाँ
options	GetOfflineUsersOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[PageUsersOfflineResponse]

उदाहरण

getOfflineUsers उदाहरण

Copy

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

getOnlineUsers

किसी पेज के वर्तमान में ऑनलाइन दर्शक: वे लोग जिनका websocket सत्र इस समय पेज की सदस्यता लिए हुए है। anonCount + totalCount लौटाता है (पूरे रूम के सब्सक्राइबर, जिनमें वे अनाम दर्शक भी शामिल हैं जिन्हें हम सूचीबद्ध नहीं करते)।

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
urlId	string	हाँ
options	GetOnlineUsersOptions	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
urlId	string	हाँ

प्रतिक्रिया

लौटाता है: Option[GetPageByURLIdAPIResponse]

उदाहरण

getPageByURLId उदाहरण

Copy

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

getPages

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ

प्रतिक्रिया

लौटाता है: Option[GetPagesAPIResponse]

उदाहरण

getPages उदाहरण

Copy

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

getPagesPublic

किसी टेनेंट के लिए पेजों की सूची लौटाता है। FChat डेस्कटॉप क्लाइंट द्वारा अपनी रूम सूची भरने के लिए उपयोग किया जाता है। प्रत्येक पेज के लिए resolved custom config पर enableFChat true होना आवश्यक है। SSO की आवश्यकता वाले पेजों को अनुरोध करने वाले उपयोगकर्ता की group access के आधार पर फ़िल्टर किया जाता है।

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetPagesPublicOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[GetPublicPagesResponse]

उदाहरण

getPagesPublic उदाहरण

Copy

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

getUsersInfo

किसी टेनेंट के लिए बल्क यूज़र जानकारी। दिए गए userIds के लिए, User / SSOUser से डिस्प्ले जानकारी लौटाता है। कमेंट विजेट द्वारा उपयोग किया जाता है ताकि प्रेज़ेंस इवेंट के माध्यम से अभी दिखाई देने वाले यूज़र्स को समृद्ध (enrich) किया जा सके। कोई पेज संदर्भ नहीं: गोपनीयता समान रूप से लागू की जाती है (प्राइवेट प्रोफाइल मास्क कर दिए जाते हैं)।

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
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	हाँ
id	string	नहीं
updateAPIPageData	UpdateAPIPageData	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[PatchPageAPIResponse]

उदाहरण

patchPage उदाहरण

Copy

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

deletePendingWebhookEvent

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

deletePendingWebhookEvent उदाहरण

Copy

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

getPendingWebhookEventCount

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetPendingWebhookEventCountOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetPendingWebhookEventCountResponse]

उदाहरण

getPendingWebhookEventCount उदाहरण

Copy

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

getPendingWebhookEvents

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetPendingWebhookEventsOptions	नहीं

प्रतिक्रिया

लौटाता है: 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

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
id	string	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetQuestionConfigResponse]

उदाहरण

getQuestionConfig उदाहरण

Copy

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

getQuestionConfigs

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
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	हाँ
id	string	नहीं
updateQuestionResultBody	UpdateQuestionResultBody	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

updateQuestionResult उदाहरण

Copy

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

aggregateQuestionResults

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	AggregateQuestionResultsOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[AggregateQuestionResultsResponse]

उदाहरण

aggregateQuestionResults उदाहरण

Copy

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

bulkAggregateQuestionResults

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	नहीं
forceRecalculate	bool	नहीं

प्रतिक्रिया

लौटाता है: Option[BulkAggregateQuestionResultsResponse]

उदाहरण

bulkAggregateQuestionResults उदाहरण

Copy

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

combineCommentsWithQuestionResults

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	CombineCommentsWithQuestionResultsOptions	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
createAPISSOUserData	CreateAPISSOUserData	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
id	string	नहीं
options	DeleteSSOUserOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[DeleteSSOUserAPIResponse]

उदाहरण

deleteSSOUser उदाहरण

Copy

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

getSSOUserByEmail

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
email	string	नहीं

प्रतिक्रिया

लौटाता है: Option[GetSSOUserByEmailAPIResponse]

उदाहरण

getSSOUserByEmail उदाहरण

Copy

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

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	हाँ
id	string	नहीं
updateAPISSOUserData	UpdateAPISSOUserData	नहीं
updateComments	bool	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[PatchSSOUserAPIResponse]

उदाहरण

patchSSOUser उदाहरण

Copy

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

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	हाँ
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[CreateSubscriptionAPIResponse]

उदाहरण

createSubscription उदाहरण

Copy

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

deleteSubscription

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
userId	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: 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	हाँ
id	string	नहीं
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	नहीं
userId	string = ""	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
options	GetTenantDailyUsagesOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetTenantDailyUsagesResponse]

उदाहरण

getTenantDailyUsages उदाहरण

Copy

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

createTenantPackage

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
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	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

deleteTenantPackage उदाहरण

Copy

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

getTenantPackage

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
id	string	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
id	string	नहीं
updateTenantPackageBody	UpdateTenantPackageBody	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
createTenantUserBody	CreateTenantUserBody	नहीं

प्रतिक्रिया

लौटाता है: Option[CreateTenantUserResponse]

उदाहरण

createTenantUser उदाहरण

Copy

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

deleteTenantUser

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
options	DeleteTenantUserOptions	नहीं

प्रतिक्रिया

लौटाता है: 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

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
redirectURL	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

sendLoginLink उदाहरण

Copy

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

updateTenantUser

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
updateTenantUserBody	UpdateTenantUserBody	नहीं
updateComments	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIEmptyResponse]

उदाहरण

updateTenantUser उदाहरण

Copy

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

createTenant

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
createTenantBody	CreateTenantBody	नहीं

प्रतिक्रिया

लौटाता है: 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	हाँ
options	GetTenantsOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetTenantsResponse]

उदाहरण

getTenants उदाहरण

Copy

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

updateTenant

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
updateTenantBody	UpdateTenantBody	नहीं

प्रतिक्रिया

लौटाता है: Option[APIEmptyResponse]

उदाहरण

updateTenant उदाहरण

Copy

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

changeTicketState

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
userId	string	नहीं
id	string	नहीं
changeTicketStateBody	ChangeTicketStateBody	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[ChangeTicketStateResponse]

उदाहरण

changeTicketState उदाहरण

Copy

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

createTicket

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
userId	string	नहीं
createTicketBody	CreateTicketBody	नहीं

प्रतिक्रिया

लौटाता है: Option[CreateTicketResponse]

उदाहरण

createTicket उदाहरण

Copy

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

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()
  # tickets का आवश्यकतानुसार उपयोग करें

getTranslations

पैरामीटर

नाम	प्रकार	आवश्यक
namespace	string	नहीं
component	string	नहीं
options	GetTranslationsOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[GetTranslationsResponse]

उदाहरण

getTranslations उदाहरण

Copy

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

uploadImage

एक छवि अपलोड और रिसाइज़ करें

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
file	string	नहीं
options	UploadImageOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: 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()
  # result का आवश्यकतानुसार उपयोग करें

getUserBadgeProgressById

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
id	string	नहीं

प्रतिक्रिया

रिटर्न करता है: 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	हाँ
options	GetUserBadgeProgressListOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[APIGetUserBadgeProgressListResponse]

उदाहरण

getUserBadgeProgressList उदाहरण

Copy

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

createUserBadge

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
createUserBadgeParams	CreateUserBadgeParams	नहीं

प्रतिक्रिया

लौटाता है: Option[APICreateUserBadgeResponse]

उदाहरण

createUserBadge उदाहरण

Copy

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

deleteUserBadge

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
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	हाँ
id	string	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[APIGetUserBadgeResponse]

उदाहरण

getUserBadge उदाहरण

Copy

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

getUserBadges

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetUserBadgesOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: 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

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
options	GetUserNotificationsOptions	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[GetMyNotificationsResponse]

उदाहरण

getUserNotifications उदाहरण

Copy

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

resetUserNotificationCount

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
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

किसी विशिष्ट कमेंट के लिए नोटिफिकेशन सक्षम या अक्षम करें।

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
notificationId	string	नहीं
optedInOrOut	string	नहीं
commentId	string	हाँ
sso	string = ""	नहीं

प्रतिक्रिया

लौटाता है: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

उदाहरण

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

किसी पेज के लिए नोटिफिकेशन सक्षम या अक्षम करें। जब उपयोगकर्ता किसी पेज की सदस्यता लेते हैं, तो नई रूट कमेंट्स के लिए नोटिफिकेशन बनाई जाती हैं, और साथ ही

पैरामीटर्स

नाम	प्रकार	आवश्यक
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	हाँ
commentId	string	हाँ
direction	string	नहीं
options	CreateVoteOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[VoteResponse]

उदाहरण

createVote उदाहरण

Copy

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

deleteVote

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
id	string	नहीं
editKey	string = ""	नहीं

प्रतिक्रिया

रिटर्न करता है: Option[VoteDeleteResponse]

उदाहरण

deleteVote उदाहरण

Copy

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

getVotes

पैरामीटर

नाम	प्रकार	आवश्यक	विवरण
tenantId	string	हाँ
urlId	string	हाँ

प्रतिक्रिया

रिटर्न करता है: Option[GetVotesResponse]

उदाहरण

getVotes उदाहरण

Copy

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

getVotesForUser

पैरामीटर

नाम	प्रकार	आवश्यक
tenantId	string	हाँ
urlId	string	हाँ
options	GetVotesForUserOptions	नहीं

प्रतिक्रिया

लौटाता है: Option[GetVotesForUserResponse]

उदाहरण

getVotesForUser उदाहरण

Copy

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

मदद चाहिए?

यदि आपको Nim SDK के बारे में कोई समस्या आती है या कोई प्रश्न होता है, तो कृपया:

योगदान देना

योगदान का स्वागत है! कृपया योगदान दिशानिर्देशों के लिए GitHub रिपॉजिटरी देखें।

भाषा 🇮🇳 हिन्दी

दस्तावेज़ीकरण

शुरू करें

API संदर्भ

उपयोग

एग्रीगेट

ऑडिट लॉग

प्रमाणीकरण

कमेंट से ब्लॉक

ब्लॉक किए गए कमेंट जाँचें

कमेंट

उपयोगकर्ता के लिए कमेंट

डोमेन कॉन्फ़िग

ईमेल टेम्पलेट

इवेंट लॉग

फ़ीड पोस्ट

कमेंट फ़्लैग करें

Gifs

हैश टैग

मॉडरेशन

मॉडरेटर

सूचना संख्या

सूचनाएँ

पेज रिएक्ट

पेज

लंबित वेबहुक इवेंट

प्रश्न कॉन्फ़िग

प्रश्न परिणाम

प्रश्न परिणाम एग्रीगेशन

SSO उपयोगकर्ता

सदस्यताएँ

टेनेंट दैनिक उपयोग

टेनेंट पैकेज

टेनेंट उपयोगकर्ता

टेनेंट

टिकट

अनुवाद

इमेज अपलोड करें

उपयोगकर्ता बैज प्रगति

उपयोगकर्ता बैज

उपयोगकर्ता सूचनाएँ

उपयोगकर्ता उपस्थिति स्थिति

उपयोगकर्ता खोज

उपयोगकर्ता

वोट

FastComments Nim SDK

रिपॉज़िटरी

AI कोडिंग एजेंट

आवश्यकताएँ

इंस्टॉलेशन

Nimble का उपयोग करना

स्रोत से बिल्ड करना

लाइब्रेरी की सामग्री

पब्लिक बनाम सुरक्षित APIs

क्विक स्टार्ट

प्रमाणित APIs का उपयोग (DefaultAPI)

सार्वजनिक APIs का उपयोग (PublicAPI)

मॉडरेशन APIs का उपयोग (ModerationAPI)

सामान्य समस्याएँ

API कॉल करना

उदाहरण: कमेंट्स प्राप्त करना

नोट्स

ब्रॉडकास्ट आईडी (Broadcast Ids)

SSO (सिंगल साइन-ऑन)

SSO उपयोग

सरल SSO

सुरक्षित SSO

fastcomments के लिए दस्तावेज़ीकरण

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

aggregate

पैरामीटर

प्रतिक्रिया

उदाहरण

getAuditLogs

पैरामीटर

प्रतिक्रिया

उदाहरण