FastComments JavaScript/TypeScript SDK

Bu, FastComments için resmi JavaScript/TypeScript SDK'sıdır.

Yorumları, kullanıcıları, SSO'yu ve moderasyonu Node.js veya tarayıcı üzerinden yönetin.

Depo

Kurulum

npm install fastcomments-sdk

API Dokümantasyonu

Tam API referansı: docs/api/README.md

Tarayıcı vs Sunucu Uyumluluğu

Bu SDK, optimal uyumluluğu sağlamak ve çalışma zamanı hatalarını önlemek için çift giriş noktaları kullanır:

fastcomments-sdk/browser - Yerel fetch ile tarayıcı güvenli sürüm
fastcomments-sdk/server - SSO desteği ile tam Node.js sürümü
fastcomments-sdk (varsayılan) - Yalnızca tipler, her yere güvenle içe aktarılabilir

Kullanım

Bu SDK, en iyi uyumluluk ve güvenliği sağlamak için tarayıcı ve sunucu ortamları için ayrı giriş noktaları sağlar:

Tarayıcı Kullanımı (İstemci Tarafı)

Tarayıcı/ön yüz uygulamaları için Node.js bağımlılıklarını hariç tutan tarayıcıya güvenli dışa aktarmayı kullanın:

// Tarayıcıya güvenli ithalat (Node.js bağımlılığı yok)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Tarayıcı SDK örneği oluştur
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // isteğe bağlı, varsayılan https://fastcomments.com
});

// Genel API'leri kullan (API anahtarına gerek yok - tarayıcılar için güvenli)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Sunucu Kullanımı (Node.js)

Sunucu/arka uç uygulamaları için SSO ve kimlik doğrulama özelliklerini içeren tam SDK'yı kullanın:

// Sunucu tarafı ithalat (SSO içerir ve NodeJS ile çalışacak şekilde tasarlanmıştır)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Sunucu SDK örneği oluştur
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Sunucuda gizli tutun!
  basePath: 'https://fastcomments.com' // isteğe bağlı, varsayılan https://fastcomments.com
});

// API anahtarınızla güvenli API'leri kullan
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Sadece Tip İçe Aktarımı

Yalnızca TypeScript türlerine (çalışma zamanı kodu yok) ihtiyacınız varsa, varsayılan ithalatı kullanın:

// Yalnızca tipler (çalışma zamanı bağımlılığı yok - her yerde güvenli)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Bireysel API Sınıflarını Kullanma

Tarayıcı Ortamı

import { PublicApi, Configuration } from 'fastcomments-sdk/browser';

const config = new Configuration({
  basePath: 'https://fastcomments.com'
});

const publicApi = new PublicApi(config);

Sunucu Ortamı

import { DefaultApi, PublicApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key',
  basePath: 'https://fastcomments.com'
});

const defaultApi = new DefaultApi(config);
const publicApi = new PublicApi(config);

Genel vs Güvenli API'ler

SDK üç ana API sınıfı sağlar:

DefaultApi - Kimlik doğrulama için API anahtarınızın gerektiği güvenli uç noktalar. Sunucu tarafı işlemler için bunları kullanın.
PublicApi - API anahtarı olmadan erişilebilen genel uç noktalar. Bunlar tarayıcılardan/taşınabilir cihazlardan vb. doğrudan çağrılabilir.
HiddenApi - İleri düzey kullanım durumları için dahili/yönetici uç noktaları.

Örnek: Public API Kullanımı (tarayıcı için güvenli)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// Bir sayfanın yorumlarını al (API anahtarı gerekli değil)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Örnek: Default API Kullanımı (yalnızca sunucu tarafı)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // Bunu gizli tutun!
});
const defaultApi = new DefaultApi(config);

// Tam yönetici erişimi ile yorumları al
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Tekli Oturum Açma) Entegrasyonu

FastComments, mevcut kullanıcı kimlik doğrulama sisteminizle entegre etmek için SSO'yu destekler. SSO functionality is only available in the server export since it requires Node.js crypto features.

Simple SSO (Server-Side Only)

Basit SSO sunucu tarafında oluşturulmalı ve istemciye gönderilmelidir:

// Sunucu tarafı kodu (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Yerleşik yardımcıyı kullanarak basit SSO oluştur  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// ssoToken'ı istemci tarafı kodunuza gönderin
// İstemci tarafı kodu daha sonra bu token'ı tarayıcı SDK'sı ile kullanabilir

Secure SSO (Server-Side, Recommended)

Güvenli SSO sunucu tarafında uygulanmalı ve daha iyi güvenlik sağlar:

// Sunucu tarafı kodu (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Yerleşik yardımcıyı kullanarak güvenli SSO oluştur
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// Sunucuda API çağrılarıyla kullanın
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Veya tarayıcı kullanımı için ssoConfig'i istemciye gönderin

Using SSO from Browser (with Server-Generated Token)

// İstemci tarafı kodu (tarayıcı)
import { PublicApi } from 'fastcomments-sdk/browser';

// Sunucu uç noktanızdan SSO token'ını alın
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Use the server-generated SSO token
});

SSO with Comment Creation

// Sunucu tarafı: SSO ve yorum oluştur
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Yaygın Kullanım Senaryoları

Bir Sayfa İçin Yorumları Alma

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

Yorum Oluşturma

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

Bir Yorum İçin Oy Verme

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 = yukarı oy, -1 = aşağı oy
  }
});

Kullanıcı Yönetimi (API Anahtarı Gerekir)

// Kullanıcıları ara (DefaultApi gerektirir)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Canlı Etkinlikler (Gerçek Zamanlı Güncellemeler)

Yorumlar, oylar ve diğer etkinlikler için gerçek zamanlı güncellemeler almak üzere canlı etkinliklere abone olun.

Sayfa Düzeyi Etkinlikleri

Belirli bir sayfadaki canlı etkinlikleri dinleyin (yorumlar, oylar, vb.):

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// Belirli bir sayfa için canlı etkinliklere abone olun
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (bunu getComments yanıtından alın)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Yeni yorum ile UI'inizi güncelleyin
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Oy sayılarını arayüzünüzde güncelleyin
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

Kullanıcı Etkinliklerine Abone Olma

Kullanıcıya özel etkinlikleri dinleyin (bildirimler, bahsetmeler, vb.):

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Bu değeri getComments yanıtından alın
};

// Kullanıcının kişisel akışına abone olun
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Bildirimi arayüzünüzde gösterin
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }
    
    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// İşiniz bittiğinde kapatın
userSubscription.close();

userIdWS'i Alma

The userIdWS parameter is required for live events and can be obtained from API responses:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Yanıttan userIdWS'yi çıkarın
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Artık canlı etkinliklere abone olabilirsiniz
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Yayın Kimlikleri

Bazı API çağrılarında bir broadcastId geçirmeniz gerektiğini göreceksiniz. Etkinlikleri aldığınızda bu ID size geri gönderilir; bu sayede istemcide değişiklikleri iyimser şekilde uygulamayı planlıyorsanız o etkinliği görmezden geleceğinizi bilirsiniz (muhtemelen en iyi deneyimi sunduğu için bunu yapmak isteyeceksiniz). Burada bir UUID iletin. ID, bir tarayıcı oturumu içinde iki kez oluşmayacak kadar benzersiz olmalıdır.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // Bu işlem için benzersiz ID
  }
});

Hata Yönetimi

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

aggregate

Belgeleri (eğer groupBy sağlanmışsa) gruplandırarak ve birden çok işlem uygulayarak toplar. Farklı işlemler (ör. sum, countDistinct, avg, vb.) desteklenir.

Parametreler

Name	Type	Required
tenantId	string	Evet
aggregationRequest	AggregationRequest	Evet
parentTenantId	string	Hayır
includeStats	boolean	Hayır

Response

Döndürür: Aggregate200Response

Örnek

aggregate Örneği

Copy

const tenantId: string = 'tenant_78a9';
const parentTenantId: string = 'parent_tenant_01';
const includeStats: boolean = true;
const aggregationRequest: AggregationRequest = {
  operation: { type: 'COUNT' },
  groupBy: ['pageUrl'],
  predicate: { field: 'status', operator: 'EQUALS', value: 'approved' },
  sort: [{ field: 'count', direction: 'DESC' }],
  limit: 25
};
const result: Aggregate200Response = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

getAuditLogs

Parametreler

Name	Type	Required
tenantId	string	Evet
limit	number	Hayır
skip	number	Hayır
order	SORTDIR	Hayır
after	number	Hayır
before	number	Hayır

Yanıt

Döndürür: GetAuditLogs200Response

Örnek

getAuditLogs Örneği

Copy

const tenantId: string = 'tenant_5f8d7c3a';
const limit: number = 100;
const skip: number = 0;
const order: SORTDIR = 'DESC' as SORTDIR;
const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // bir hafta önce
const before: number = Date.now();
const result: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after, before);

blockFromCommentPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
publicBlockFromCommentParams	PublicBlockFromCommentParams	Evet
sso	string	Hayır

Yanıt

Döndürür: BlockFromCommentPublic200Response

Örnek

blockFromCommentPublic Örneği

Copy

const tenantId: string = 'tenant_6b3f9a2d';
const commentId: string = 'cmt_8f4b12a9';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'Repeated promotional links',
  durationMinutes: 60 * 24 * 30, // 30 gün
  escalateToModeration: true
};
const sso: string = 'sso_token_3fH7kLw';
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

unBlockCommentPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
publicBlockFromCommentParams	PublicBlockFromCommentParams	Evet
sso	string	Hayır

Yanıt

Döndürür: UnBlockCommentPublic200Response

Örnek

unBlockCommentPublic Örneği

Copy

const tenantId: string = "tenant-42-production";
const commentId: string = "comment_7f3b2a9d";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "flag reviewed and determined not to violate policy",
  restoredBy: "moderator_jane",
  restoredAt: new Date().toISOString()
};
const sso: string = "sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

checkedCommentsForBlocked

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentIds	string	Evet
sso	string	Hayır

Yanıt

Döndürür: CheckedCommentsForBlocked200Response

Örnek

checkedCommentsForBlocked Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_fa3b2c9e';
  const commentIds: string = 'cmt_112233,cmt_445566';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0Njc4IiwidGVuYW50IjoidGVuYW50X2ZhM2IifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, sso);
  const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
  console.log(resultWithSSO, resultWithoutSSO);
})();

blockUserFromComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
blockFromCommentParams	BlockFromCommentParams	Evet
userId	string	Hayır
anonUserId	string	Hayır

Yanıt

Döndürür: BlockFromCommentPublic200Response

Örnek

blockUserFromComment Örneği

Copy

const tenantId: string = "tenant_7f3b4c";
const id: string = "comment_9a8b7c6d";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated spam links",
  durationHours: 168,
  notifyModerators: true
};
const userId: string | undefined = "user_42";
const anonUserId: string | undefined = undefined;
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

createCommentPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
broadcastId	string	Evet
commentData	CommentData	Evet
sessionId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: CreateCommentPublic200Response

Örnek

createCommentPublic Örneği

Copy

const tenantId: string = 'tenant_9a1b2c';
const urlId: string = 'https://www.news-site.com/article/67890';
const broadcastId: string = 'broadcast_2026-06-15-01';
const sessionId: string | undefined = 'sess_abc123xyz';
const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiam9yZGFuIiwiaWF0IjoxNjI0MDAwMDB9.signature';
const commentData: CommentData = {
  content: 'Insightful piece — I appreciated the data-backed points and sources cited.',
  authorDisplayName: 'Jordan Miles'
} as CommentData;
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

deleteComment

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
contextUserId	string	Hayır
isLive	boolean	Hayır

Yanıt

Döndürür: DeleteComment200Response

Örnek

deleteComment Örneği

Copy

const tenantId: string = 'tenant_84a9f2';
const id: string = 'comment_5f3b21';
const contextUserId: string | undefined = 'user_1122';
const isLive: boolean | undefined = true;
async function run(): Promise<void> {
  const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);
  console.log(result);
}
run();

deleteCommentPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
broadcastId	string	Evet
editKey	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: DeleteCommentPublic200Response

Örnek

deleteCommentPublic Örneği

Copy

const tenantId: string = 'tenant_acme_42';
const commentId: string = 'c0mment-9f8b7a6';
const broadcastId: string = 'site_homepage_2026-06-15';
const editKey: string = 'ek_3b7a1f59-4d2c-11eb-8dcd-0242ac130003';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

deleteCommentVote

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
voteId	string	Evet
urlId	string	Evet
broadcastId	string	Evet
editKey	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: DeleteCommentVote200Response

Örnek

deleteCommentVote Örneği

Copy

const tenantId: string = 'tenant_8f3a2b7c';
const commentId: string = 'cmt-5a1f3d92';
const voteId: string = 'vote-3b9c7e1a';
const urlId: string = 'articles/2026/06/typescript-best-practices';
const broadcastId: string = 'broadcast-77f4d2';
const editKey: string = 'edk-9b2f4c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const result: DeleteCommentVote200Response = await deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, editKey, sso);

flagComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
userId	string	Hayır
anonUserId	string	Hayır

Yanıt

Döndürür: FlagComment200Response

Örnek

flagComment Örneği

Copy

const tenantId: string = "tenant_4f21c9a";
const commentId: string = "cmt_7a12b3e9";
const userId: string = "user_82bd123";
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

getComment

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetComment200Response

Örnek

getComment Örneği

Copy

const tenantId: string = 'tenant_6f1a2b';
const commentId: string = 'cmt_4d9e8f';
const includeReplies: boolean | undefined = true; // isteğe bağlı parametre örneği (getComment'a gönderilmez)
const result: GetComment200Response = await getComment(tenantId, commentId);
console.log('Fetched comment for tenant:', tenantId, 'comment id:', commentId);
console.log('API response received:', result);

getComments

Parametreler

Name	Type	Required
tenantId	string	Evet
page	number	Hayır
limit	number	Hayır
skip	number	Hayır
asTree	boolean	Hayır
skipChildren	number	Hayır
limitChildren	number	Hayır
maxTreeDepth	number	Hayır
urlId	string	Hayır
userId	string	Hayır
anonUserId	string	Hayır
contextUserId	string	Hayır
hashTag	string	Hayır
parentId	string	Hayır
direction	SortDirections	Hayır
fromDate	number	Hayır
toDate	number	Hayır

Yanıt

Döndürür: GetComments200Response

Örnek

getComments Örneği

Copy

const tenantId: string = "tenant_9a12b3";
const response: GetComments200Response = await getComments(tenantId, 1, 20, 0, true, 0, 3, 2, "https://mysite.com/posts/678", undefined, undefined, undefined, undefined, "parent_987", undefined, 1716873600000, 1719552000000);

getCommentsPublic

req tenantId urlId

Parametreler

Name	Type	Gerekli
tenantId	string	Evet
urlId	string	Evet
page	number	Hayır
direction	SortDirections	Hayır
sso	string	Hayır
skip	number	Hayır
skipChildren	number	Hayır
limit	number	Hayır
limitChildren	number	Hayır
countChildren	boolean	Hayır
fetchPageForCommentId	string	Hayır
includeConfig	boolean	Hayır
countAll	boolean	Hayır
includei10n	boolean	Hayır
locale	string	Hayır
modules	string	Hayır
isCrawler	boolean	Hayır
includeNotificationCount	boolean	Hayır
asTree	boolean	Hayır
maxTreeDepth	number	Hayır
useFullTranslationIds	boolean	Hayır
parentId	string	Hayır
searchText	string	Hayır
hashTags	Array	Hayır
userId	string	Hayır
customConfigStr	string	Hayır
afterCommentId	string	Hayır
beforeCommentId	string	Hayır

Yanıt

Döndürür: GetCommentsPublic200Response

Örnek

getCommentsPublic Örneği

Copy

const tenantId: string = 'acme-news';
const urlId: string = '/articles/2026/fastcomments-update';
const page: number = 1;
const skip: number = 0;
const limit: number = 25;
const countChildren: boolean = true;
const includeConfig: boolean = true;
const result: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  page,
  undefined,
  undefined,
  skip,
  undefined,
  limit,
  undefined,
  countChildren,
  undefined,
  includeConfig
);

getCommentText

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
editKey	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: GetCommentText200Response

Örnek

getCommentText Örneği

Copy

const tenantId: string = 'tenant_42b7e9';
const commentId: string = 'cmt_9f3a2b';
const editKey: string = 'edk_3f1b7c9d';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

getCommentVoteUserNames

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
dir	number	Evet
sso	string	Hayır

Yanıt

Dönen değer: GetCommentVoteUserNames200Response

Örnek

getCommentVoteUserNames Örneği

Copy

const tenantId: string = "tenant_67890";
const commentId: string = "comment_abc123";
const dir: number = 1;
const ssoToken: string = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const responseWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
const responseWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

lockComment

Parametreler

Name	Type	Required
tenantId	string	Evet
commentId	string	Evet
broadcastId	string	Evet
sso	string	Hayır

Yanıt

Döndürür: LockComment200Response

Örnek

lockComment Örneği

Copy

const tenantId: string = 'tenant_42f6c1';
const commentId: string = 'cmt-9a8b7c';
const broadcastId: string = 'brd_2026_06_15';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTY1MDAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const lockedWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const lockedWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

pinComment

Parametreler

Ad	Tür	Zorunlu
tenantId	string	Evet
commentId	string	Evet
broadcastId	string	Evet
sso	string	Hayır

Yanıt

Döndürür: PinComment200Response

Örnek

pinComment Örneği

Copy

const tenantId: string = "acme-corp-tenant-72";
const commentId: string = "cmt_8f3a2b4c9d";
const broadcastId: string = "live_2026-06-15_21z";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload.signature";
const responseNoSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId);
const responseWithSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, ssoToken);

saveComment

Parametreler

Name	Type	Required
tenantId	string	Evet
createCommentParams	CreateCommentParams	Evet
isLive	boolean	Hayır
doSpamCheck	boolean	Hayır
sendEmails	boolean	Hayır
populateNotifications	boolean	Hayır

Yanıt

Döndürür: SaveComment200Response

Örnek

saveComment Örneği

Copy

const tenantId: string = "fastcomments-tenant-42";
const createCommentParams: CreateCommentParams = {
  threadId: "article-2026-06-0142",
  content: "Great write-up — I followed the migration steps and everything worked as described.",
  userId: "u_9c72b",
  userName: "Ava R.",
  userAvatarUrl: "https://cdn.example.com/avatars/u_9c72b.png",
  metadata: { platform: "web", locale: "en-US" }
};
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

saveCommentsBulk

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
createCommentParams	Array	Evet
isLive	boolean	Hayır
doSpamCheck	boolean	Hayır
sendEmails	boolean	Hayır
populateNotifications	boolean	Hayır

Yanıt

Döndürür: Array<SaveComment200Response

Örnek

saveCommentsBulk Örneği

Copy

const tenantId: string = "tenant_42a1b7";
const mentions: CommentUserMentionInfo[] = [{ userId: "user_2b9", displayName: "Alex Chen" }];
const hashtags: CommentUserHashTagInfo[] = [{ tag: "performance" }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: "Thanks for the detailed article — the alternative approach worked for me.",
    authorId: "user_8f3c2",
    authorName: "Maya Patel",
    authorEmail: "maya.patel@example.com",
    url: "/articles/optimizing-ts-performance",
    createdAt: new Date().toISOString(),
    mentions,
    hashtags
  }
];
const isLive: boolean = true;
const doSpamCheck: boolean = false;
const sendEmails: boolean = true;
const populateNotifications: boolean = true;
const result: Array<SaveComment200Response> = await saveCommentsBulk(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

setCommentText

Parametreler

Name	Type	Required
tenantId	string	Evet
commentId	string	Evet
broadcastId	string	Evet
commentTextUpdateRequest	CommentTextUpdateRequest	Evet
editKey	string	Hayır
sso	string	Hayır

Yanıt

Dönüş: SetCommentText200Response

Örnek

setCommentText Örneği

Copy

const tenantId: string = 'tenant_4f9a2b'
const commentId: string = 'cmt-8421'
const broadcastId: string = 'brd-2026-06-15'
const commentTextUpdateRequest: CommentTextUpdateRequest = { text: 'Updated comment text to clarify the schedule.', mentions: [], hashtags: [] }
const editKey: string = 'editkey_9b12'
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso.signature'
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso)

unBlockUserFromComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
unBlockFromCommentParams	UnBlockFromCommentParams	Evet
userId	string	Hayır
anonUserId	string	Hayır

Yanıt

Döndürür: UnBlockCommentPublic200Response

Örnek

unBlockUserFromComment Örneği

Copy

const tenantId: string = 'tenant_7b9c2a';
const id: string = 'comment_4f8e1d';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'User submitted appeal and provided additional context',
  effectiveAt: new Date().toISOString()
};
const userId: string = 'user_92a3f6';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId);

unFlagComment

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
userId	string	Hayır
anonUserId	string	Hayır

Yanıt

Döndürür: FlagComment200Response

Örnek

unFlagComment Örneği

Copy

const tenantId: string = 'tenant_8f3b2a1f';
const commentId: string = 'cmt_20250614_01';
const userId: string = 'user_47d2b9';
const result: FlagComment200Response = await unFlagComment(tenantId, commentId, userId);

unLockComment

Parametreler

Name	Type	Required
tenantId	string	Evet
commentId	string	Evet
broadcastId	string	Evet
sso	string	Hayır

Yanıt

Döndürür: LockComment200Response

Örnek

unLockComment Örneği

Copy

const tenantId: string = "tenant-8f3b2c4a";
const commentId: string = "cmt_92a7f3e6";
const broadcastId: string = "brd_1b4c9d20";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

unPinComment

Parametreler

İsim	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
broadcastId	string	Evet
sso	string	Hayır

Yanıt

Dönüş: PinComment200Response

Örnek

unPinComment Örneği

Copy

const tenantId: string = "tenant_9f3b2c1a";
const commentId: string = "comment_4d2e8a7f";
const broadcastId: string = "broadcast_live_2026_06_15_18";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.invalid-signature";
const response: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);
console.log(response);

updateComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updatableCommentParams	UpdatableCommentParams	Evet
contextUserId	string	Hayır
doSpamCheck	boolean	Hayır
isLive	boolean	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateComment Örneği

Copy

const tenantId: string = 'tenant_7f3c1b2a';
const commentId: string = 'cmt_8d9f2a4b';
const updatableCommentParams: UpdatableCommentParams = {
  body: 'Updating this comment to clarify the feature behavior and include a timestamp.',
  metadata: { category: 'support', editedReason: 'clarify instructions' },
  visible: true
};
const contextUserId: string = 'user_42';
const doSpamCheck: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, commentId, updatableCommentParams, contextUserId, doSpamCheck);

voteComment

Parametreler

Ad	Tip	Zorunlu
tenantId	string	Evet
commentId	string	Evet
urlId	string	Evet
broadcastId	string	Evet
voteBodyParams	VoteBodyParams	Evet
sessionId	string	Hayır
sso	string	Hayır

Yanıt

Dönüş: VoteComment200Response

Örnek

voteComment Örneği

Copy

const tenantId: string = 'tenant_7f9d2e';
const commentId: string = '5a1d3f9b-2c4e-4a2b-bf7b-1234567890ab';
const urlId: string = 'articles/2026/06/15/typescript-api-patterns';
const broadcastId: string = 'broadcast-20260615-01';
const voteBodyParams: VoteBodyParams = { vote: 'up' };
const sessionId: string = 'sess_9d2f3b45';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY5NzE2MDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const response: VoteComment200Response = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

getCommentsForUser

Parametreler

Ad	Tür	Gerekli
userId	string	Hayır
direction	SortDirections	Hayır
repliesToUserId	string	Hayır
page	number	Hayır
includei10n	boolean	Hayır
locale	string	Hayır
isCrawler	boolean	Hayır

Yanıt

Döndürür: GetCommentsForUser200Response

Örnek

getCommentsForUser Örneği

Copy

const userId: string = "550e8400-e29b-41d4-a716-446655440000";
const page: number = 2;
const includei10n: boolean = true;
const locale: string = "en-US";
const isCrawler: boolean = false;
const comments: GetCommentsForUser200Response = await getCommentsForUser(
  userId,
  undefined, // direction atlandı
  undefined, // repliesToUserId atlandı
  page,
  includei10n,
  locale,
  isCrawler
);
console.log(comments);

addDomainConfig

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
addDomainConfigParams	AddDomainConfigParams	Evet

Yanıt

Döndürür: AddDomainConfig200Response

deleteDomainConfig

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
domain	string	Evet

Yanıt

Döndürür: DeleteDomainConfig200Response

getDomainConfig

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
domain	string	Evet

Yanıt

Döndürür: GetDomainConfig200Response

getDomainConfigs

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet

Yanıt

Döndürür: GetDomainConfigs200Response

patchDomainConfig

Parametreler

İsim	Tür	Gerekli
tenantId	string	Evet
domainToUpdate	string	Evet
patchDomainConfigParams	PatchDomainConfigParams	Evet

Yanıt

Döndürür: GetDomainConfig200Response

putDomainConfig

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
domainToUpdate	string	Evet
updateDomainConfigParams	UpdateDomainConfigParams	Evet

Yanıt

Döndürür: GetDomainConfig200Response

createEmailTemplate

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createEmailTemplateBody	CreateEmailTemplateBody	Evet

Yanıt

Döndürür: CreateEmailTemplate200Response

Örnek

createEmailTemplate Örneği

Copy

const tenantId: string = "tenant_4f2b1c9e";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "New Comment Notification",
  subject: "Someone replied to your discussion",
  fromName: "Community Team",
  fromAddress: "no-reply@community.example.com",
  htmlBody: "<p>\{{comment.author}} replied: \{{comment.text}}</p>",
  plaintextBody: "\{{comment.author}} replied: \{{comment.text}}",
  previewText: "A new reply on a discussion you follow",
  isDefault: false // isteğe bağlı parametre kullanımını gösteren bayrak
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

deleteEmailTemplate

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteEmailTemplate Örneği

Copy

const tenantId: string = "tenant_9c4f1b2a";
const id: string = "emailtmpl_4d2b9a5e";
const requestorNote: string | undefined = undefined; // isteğe bağlı meta veriler (fonksiyon için gerekli değil)
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, id);

deleteEmailTemplateRenderError

Parametreler

Name	Type	Required
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteEmailTemplateRenderError Örneği

Copy

const tenantId: string = 'tenant-72f3b4';
const templateId: string = 'email_template-9c3a1';
let providedErrorId: string | undefined = undefined; // isteğe bağlı bir değer, başka bir yerde ayarlanmış olabilir
const errorId: string = providedErrorId ?? 'render_err-5d2f7';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, templateId, errorId);

getEmailTemplate

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetEmailTemplate200Response

Örnek

getEmailTemplate Örneği

Copy

const tenantId: string = 'tenant_7f3b2c';
const templateId: string = 'welcome-email-2024';
const includeDrafts: boolean | undefined = undefined;
const emailTemplate: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

getEmailTemplateDefinitions

Parametreler

Name	Type	Required	Description
tenantId	string	Yes

Yanıt

Döndürür: GetEmailTemplateDefinitions200Response

Örnek

getEmailTemplateDefinitions Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_acme_001';
  const options: { includeDrafts?: boolean } = { includeDrafts: true }; // isteğe bağlı parametre gösterimi
  const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId, options);
  console.log(templates);
})();

getEmailTemplateRenderErrors

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
skip	number	Hayır

Yanıt

Döndürür: GetEmailTemplateRenderErrors200Response

Örnek

getEmailTemplateRenderErrors Örneği

Copy

const tenantId: string = 'acme-tenant-01';
const id: string = 'tmpl_7f9a2b4c';
const skip: number = 20;
const errorsWithSkip: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
const errorsFirstPage: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id);

getEmailTemplates

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
skip	number	Hayır

Yanıt

Döndürür: GetEmailTemplates200Response

Örnek

getEmailTemplates Örneği

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme-marketing-tenant-001";
  const templatesDefault: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const templatesPaged: GetEmailTemplates200Response = await getEmailTemplates(tenantId, 25);
  console.log(templatesDefault, templatesPaged);
}
run();

renderEmailTemplate

Parametreler

Ad	Tür	Zorunlu
tenantId	string	Evet
renderEmailTemplateBody	RenderEmailTemplateBody	Evet
locale	string	Hayır

Yanıt

Dönen değer: RenderEmailTemplate200Response

Örnek

renderEmailTemplate Örneği

Copy

const tenantId: string = '7f7e2b90-3a2b-4d9b-9df1-5f0b6b2e8a1c';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'welcome_email',
  recipient: { email: 'jordan.smith@acme.co', name: 'Jordan Smith' },
  variables: { siteName: 'Acme Forum', verificationUrl: 'https://acme.forum/verify?code=abc123' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateEmailTemplateBody	UpdateEmailTemplateBody	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateEmailTemplate Örneği

Copy

const tenantId: string = 'acme-corp-123';
const id: string = 'template-789';
const locale: string | undefined = 'en-US';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  subject: 'Welcome to Acme — Get started',
  bodyHtml: '<p>Hi \{{firstName}}, welcome to Acme. Start by visiting your dashboard.</p>',
  fromName: 'Acme Support',
  fromEmail: 'support@acme.com',
  enabled: true,
  ...(locale ? { locale } : {})
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Parametreler

Name	Type	Required
tenantId	string	Evet
urlId	string	Evet
userIdWS	string	Evet
startTime	number	Evet
endTime	number	Hayır

Yanıt

Döndürür: GetEventLog200Response

Örnek

getEventLog Örneği

Copy

const tenantId: string = 'tenant_9f3a2b';
const urlId: string = 'news/2026/06/fastcomments-release';
const userIdWS: string = 'ws_user_48291';
const startTime: number = Date.now() - 86_400_000;
const endTime: number = Date.now();
const result: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

getGlobalEventLog

req tenantId urlId userIdWS

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
userIdWS	string	Evet
startTime	number	Evet
endTime	number	Hayır

Yanıt

Döndürür: GetEventLog200Response

Örnek

getGlobalEventLog Örneği

Copy

const tenantId: string = "tenant_639b7f12";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/important-update-987";
const userIdWS: string = "user_ws_42b7";
const startTime: number = new Date("2026-06-14T00:00:00Z").getTime();
const endTime: number = Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

Yanıt

Döndürür: CreateFeedPost200Response

Örnek

createFeedPost Örneği

Copy

const tenantId: string = 'tenant_4f2b1c';
const createFeedPostParams: CreateFeedPostParams = {
  content: 'Launching our summer collection today — check it out!',
  authorId: 'user_879',
  media: [
    {
      type: 'image',
      assets: [
        { url: 'https://cdn.myshop.com/uploads/summer-look.jpg', width: 1200, height: 800 } as FeedPostMediaItemAsset
      ]
    } as FeedPostMediaItem
  ],
  links: [
    { url: 'https://myshop.com/new-arrival', title: 'Summer Collection' } as FeedPostLink
  ],
  allowComments: true
};
const broadcastId: string = 'broadcast-2026-06-15-001';
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const response: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

createFeedPostPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
createFeedPostParams	CreateFeedPostParams	Evet
broadcastId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: CreateFeedPostPublic200Response

Örnek

createFeedPostPublic Örneği

Copy

(async () => {
  const tenantId: string = "tenant_9f8b7c";
  const media: FeedPostMediaItem[] = [{ type: "image", assets: [{ url: "https://cdn.example.com/roadmap.jpg", mimeType: "image/jpeg" }] }];
  const links: FeedPostLink[] = [{ url: "https://company.example.com/roadmap", title: "Full roadmap" }];
  const createFeedPostParams: CreateFeedPostParams = {
    title: "Weekly Product Roadmap Update",
    body: "This week we shipped enhancements to search relevance and fixed top customer bugs.",
    authorId: "user_8321",
    media,
    links,
    visibility: "public"
  };
  const broadcastId: string = "broadcast_2026_06_15";
  const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload";
  const response: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);
  console.log(response);
})();

deleteFeedPostPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
postId	string	Evet
broadcastId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: DeleteFeedPostPublic200Response

Örnek

deleteFeedPostPublic Örneği

Copy

const tenantId: string = 'acme-tenant-42';
const postId: string = 'post_8f3d2a7c';
const broadcastId: string = 'broadcast_2026-06-15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

getFeedPosts

req tenantId afterId

Parameters

Name	Type	Required
tenantId	string	Evet
afterId	string	Hayır
limit	number	Hayır
tags	Array	Hayır

Yanıt

Döndürür: GetFeedPosts200Response

Örnek

getFeedPosts Örneği

Copy

const tenantId: string = "tenant_74321";
const afterId: string = "post_20250610_9b2f3";
const limit: number = 25;
const tags: Array<string> = ["product-updates", "announcements"];
const response: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);

getFeedPostsPublic

req tenantId afterId

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
afterId	string	Hayır
limit	number	Hayır
tags	Array	Hayır
sso	string	Hayır
isCrawler	boolean	Hayır
includeUserInfo	boolean	Hayır

Yanıt

Döndürür: GetFeedPostsPublic200Response

Örnek

getFeedPostsPublic Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const afterId: string = 'post_20250610_842';
  const limit: number = 25;
  const tags: string[] = ['news', 'technology'];
  const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1Ni';
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
  console.log(response);
})();

getFeedPostsStats

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
postIds	Array	Evet
sso	string	Hayır

Yanıt

Döndürür: GetFeedPostsStats200Response

Örnek

getFeedPostsStats Örneği

Copy

const tenantId: string = "tenant_98765";
const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
const ssoToken: string = "sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, ssoToken);

getUserReactsPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
postIds	Array	Hayır
sso	string	Hayır

Yanıt

Döndürür: GetUserReactsPublic200Response

Örnek

getUserReactsPublic Örneği

Copy

const tenantId: string = 'fastcomments-tenant-4f2b9c';
const postIds: Array<string> = ['post_7a1f9e', 'post_2b3c88'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTYwOTQ0MDAwMH0.signature';
const response: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

reactFeedPostPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
postId	string	Evet
reactBodyParams	ReactBodyParams	Evet
isUndo	boolean	Hayır
broadcastId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: ReactFeedPostPublic200Response

Örnek

reactFeedPostPublic Örneği

Copy

const tenantId: string = 'acme-tenant-001';
const postId: string = 'feedpost_78901';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast_2026_06_15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const response: ReactFeedPostPublic200Response = await reactFeedPostPublic(
  tenantId,
  postId,
  reactBodyParams,
  isUndo,
  broadcastId,
  sso
);

updateFeedPost

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
feedPost	FeedPost	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateFeedPost Örneği

Copy

const tenantId: string = "tenant_72f3b4c9";
const id: string = "post_ba4f6e18-2d3c-4b7a-91f2-8c0e3a6b5d4f";
const feedPost: FeedPost = {
  title: "June feature rollout",
  body: "Announcing performance improvements and moderation updates available to all sites.",
  authorName: "Platform Team",
  mediaItems: [
    {
      type: "image",
      caption: "Release banner",
      asset: { url: "https://cdn.fastcomments.com/assets/june-banner.jpg", mimeType: "image/jpeg", width: 1200, height: 600 }
    }
  ],
  links: [{ title: "Release notes", url: "https://docs.fastcomments.com/releases/june-2026" }]
} as FeedPost;
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

updateFeedPostPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
postId	string	Evet
updateFeedPostParams	UpdateFeedPostParams	Evet
broadcastId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: CreateFeedPostPublic200Response

Örnek

updateFeedPostPublic Örneği

Copy

const tenantId: string = 'tenant_acme_01';
const postId: string = 'post_20260615_001';
const updateFeedPostParams: UpdateFeedPostParams = {
  title: 'Weekly Update: Product Launch',
  content: 'We shipped the 2.0 release today — highlights and links below.',
  media: [{ url: 'https://cdn.acme.com/releases/launch.jpg', type: 'image' }],
  tags: ['release', 'product'],
  isPublic: true
};
const broadcastId: string = 'broadcast_live_42';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

flagCommentPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
isFlagged	boolean	Evet
sso	string	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

flagCommentPublic Örnek

Copy

const tenantId: string = "tenant_4f1b2a9c";
const commentId: string = "comment_8d3e6f12";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

getGifLarge

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
largeInternalURLSanitized	string	Evet

Yanıt

Döndürür: GetGifLarge200Response

Örnek

getGifLarge Örneği

Copy

const tenantId: string = "tenant_9f8b7c";
const largeInternalURLSanitized: string = "https://cdn.fastcomments.com/gifs/07d3f6_large.gif";
const preferWebP: boolean | undefined = true; // isteğe bağlı tercih
const urlToUse: string = preferWebP ? largeInternalURLSanitized.replace(".gif", ".webp") : largeInternalURLSanitized;
const response: GetGifLarge200Response = await getGifLarge(tenantId, urlToUse);

getGifsSearch

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
search	string	Evet
locale	string	Hayır
rating	string	Hayır
page	number	Hayır

Yanıt

Dönüş: GetGifsSearch200Response

Örnek

getGifsSearch Örneği

Copy

const tenantId: string = "tenant_acme_9876";
const search: string = "cat playing piano";
const locale: string = "en-US";
const rating: string = "pg";
const page: number = 1;
const result: GetGifsSearch200Response = await getGifsSearch(tenantId, search, locale, rating, page);

getGifsTrending

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
locale	string	Hayır
rating	string	Hayır
page	number	Hayır

Yanıt

Döndürür: GetGifsTrending200Response

Örnek

getGifsTrending Örneği

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_8b3f2c';
  const locale: string = 'en-US';
  const rating: string = 'pg';
  const page: number = 1;
  const result: GetGifsTrending200Response = await getGifsTrending(tenantId, locale, rating, page);
  console.log(result);
}
main();

addHashTag

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Hayır
createHashTagBody	CreateHashTagBody	Hayır

Yanıt

Döndürür: AddHashTag200Response

Örnek

addHashTag Örneği

Copy

const tenantId: string | undefined = "tenant_3c9f7b";
const createHashTagBody: CreateHashTagBody = {
  name: "support",
  title: "Support",
  description: "Questions about product usage, bugs, and account issues",
  color: "#0066CC",
  isActive: true,
  aliases: ["help", "customer-service"]
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

addHashTagsBulk

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Hayır
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Hayır

Yanıt

Döndürür: AddHashTagsBulk200Response

Örnek

addHashTagsBulk Örneği

Copy

const tenantId: string = "tenant_acme_corp_987";
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: "product-update", description: "Announcements about new product releases", visible: true },
    { name: "customer-support", description: "Customer support related discussions", visible: false }
  ],
  createdBy: "moderator_jane"
};
const resultWithTenant: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const resultWithoutTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

deleteHashTag

Parametreler

Ad	Tür	Gerekli
tag	string	Evet
tenantId	string	Hayır
deleteHashTagRequest	DeleteHashTagRequest	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteHashTag Örneği

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_72a1";
const deleteHashTagRequest: DeleteHashTagRequest = {
  reason: "consolidate-duplicates",
  requestedBy: "moderator@dailypress.com",
  forceDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

getHashTags

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
page	number	Hayır

Yanıt

Dönüş: GetHashTags200Response

Örnek

getHashTags Örneği

Copy

const tenantId: string = 'tenant_7f4b2c3a';
const tagsFirstPage: GetHashTags200Response = await getHashTags(tenantId);
const tagsSecondPage: GetHashTags200Response = await getHashTags(tenantId, 2);
console.log(tagsFirstPage, tagsSecondPage);

patchHashTag

Parametreler

Ad	Tür	Gerekli
tag	string	Evet
tenantId	string	Hayır
updateHashTagBody	UpdateHashTagBody	Hayır

Yanıt

Döndürür: PatchHashTag200Response

Örnek

patchHashTag Örneği

Copy

const tag: string = "feature-request";
const tenantId: string = "tenant_8f7a3b2c";
const updateHashTagBody: UpdateHashTagBody = {
  displayName: "Feature Request",
  description: "Use this tag for requests to add new features to the product",
  enabled: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createModeratorBody	CreateModeratorBody	Evet

Yanıt

Döndürür: CreateModerator200Response

Örnek

createModerator Örneği

Copy

const tenantId: string = 'tenant_9f3b21';
const createModeratorBody: CreateModeratorBody = {
  moderator: {
    name: 'Alex Rivera',
    email: 'alex.rivera@fastcomments.io',
    role: 'global_moderator',
    enabled: true,
  },
  // isteğe bağlı parametreler gösteriliyor:
  notifyUser: true,
  permissions: ['delete_comment', 'edit_comment', 'ban_user'],
  customConfig: { dashboardTheme: 'dark' } as unknown as CustomConfigParameters
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
sendEmail	string	Hayır

Yanıt

Dönüş: FlagCommentPublic200Response

Örnek

deleteModerator Örneği

Copy

const tenantId: string = 'tenant_4f3b2c9a';
const id: string = 'mod_9c2d1f7b';
const sendEmail: string = 'true';
const response: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);
console.log(response);

getModerator

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetModerator200Response

Örnek

getModerator Örneği

Copy

const tenantId: string = 'acme-media-58';
const id: string = 'mod-82f3b9c1';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

getModerators

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
skip	number	Hayır

Yanıt

Döndürür: GetModerators200Response

Örnek

getModerators Örneği

Copy

const tenantId: string = 'tenant_0a1b2c3d';
const moderators: GetModerators200Response = await getModerators(tenantId);
const skip: number = 20;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

sendInvite

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
fromName	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

sendInvite Örneği

Copy

(async () => {
  const tenantId: string = "tenant_acme_42";
  const id: string = "cmt_8f3b21";
  const fromName: string = "Ava Thompson";
  const inviteResult: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);
  console.log(inviteResult);
})();

updateModerator

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateModeratorBody	UpdateModeratorBody	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateModerator Örneği

Copy

const tenantId: string = 'acme-tenant-81';
const id: string = 'mod_7f3a2b';
const updateModeratorBody: UpdateModeratorBody = {
  email: 'j.reyes@acme-corp.com',
  displayName: 'Jordan Reyes',
  roles: ['moderator', 'content_reviewer'],
  active: true,
  notes: 'Promoted to senior moderator; monitor flagged content weekly'
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

deleteNotificationCount

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteNotificationCount Örneği

Copy

const tenantId: string = 'tenant_5f3d2e1b';
const id: string = 'notification_9a4b1c2';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);

getCachedNotificationCount

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetCachedNotificationCount200Response

Örnek

getCachedNotificationCount Örneği

Copy

const tenantId: string = 'fastcomments-tenant-23';
const id: string = 'user_987654';
const cachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);
const maybeId: string | undefined = Math.random() > 0.5 ? 'user_123456' : undefined;
if (maybeId) {
  const optionalCachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, maybeId);
}

getNotificationCount

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
userId	string	Hayır
urlId	string	Hayır
fromCommentId	string	Hayır
viewed	boolean	Hayır
type	string	Hayır

Yanıt

Dönüş: GetNotificationCount200Response

Örnek

getNotificationCount Örneği

Copy

const tenantId: string = 'tenant_82a3b9f';
const userId: string = 'user_43721';
const urlId: string = 'https://news.example.com/articles/2026/06/15/coverage-123';
const fromCommentId: string = 'comment_98765';
const viewed: boolean = false;
const notificationType: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, notificationType);

getNotifications

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

Yanıt

Döndürür: GetNotifications200Response

Örnek

getNotifications Örneği

Copy

const tenantId: string = 'tenant_9f8b7c6a';
const userId: string = 'user_5a4b3c2d';
const urlId: string = 'post_84f2a1b9';
const fromCommentId: string = 'cmt_0a1b2c3d';
const viewed: boolean = false;
const type: string = 'reply';
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(
  tenantId,
  userId,
  urlId,
  fromCommentId,
  viewed,
  type,
  skip
);

updateNotification

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateNotificationBody	UpdateNotificationBody	Evet
userId	string	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateNotification Örneği

Copy

const tenantId: string = 'tenant_9f3b2c';
const id: string = 'notification_4a1d2e';
const updateNotificationBody: UpdateNotificationBody = {
  enabled: true,
  channels: ['email', 'push'],
  frequency: 'immediate',
  templateId: 'tmpl_77aa'
} as UpdateNotificationBody;
const userId: string = 'user_2468';
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

createV1PageReact

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
title	string	Hayır

Yanıt

Döndürür: CreateV1PageReact200Response

Örnek

createV1PageReact Örneği

Copy

(async () => {
  const tenantId: string = 'b12f3c4d-5678-90ab-cdef-1234567890ab';
  const urlId: string = 'https://www.news-site.com/world/2026/election-results';
  const title: string = 'Election results: key takeaways and analysis';
  const responseWithTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId, title);
  const responseWithoutTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId);
  console.log(responseWithTitle, responseWithoutTitle);
})();

createV2PageReact

Parameters

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
id	string	Evet
title	string	Hayır

Yanıt

Döndürür: CreateV2PageReact200Response

Örnek

createV2PageReact Örneği

Copy

const tenantId: string = "fastcomments-tenant-72";
const urlId: string = "articles/2026/06/15/product-update";
const id: string = "page-8f3b2a";
const title: string = "Product Update: June 15, 2026";
(async function run(): Promise<void> {
  const response: CreateV2PageReact200Response = await createV2PageReact(tenantId, urlId, id, title);
  console.log(response);
})();

deleteV1PageReact

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
urlId	string	Evet

Yanıt

Döndürür: DeleteV1PageReact200Response

Örnek

deleteV1PageReact Örneği

Copy

const tenantId: string = process.env.TENANT_ID ?? 'd3b07384-9f6a-4c2b-8c3e-0a1b2c3d4e5f';
const urlId: string = 'https://acme.com/articles/2026/06/fastcomments-integration';
const result: DeleteV1PageReact200Response = await deleteV1PageReact(tenantId, urlId);

deleteV2PageReact

Parametreler

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Yanıt

Döndürür: DeleteV2PageReact200Response

Örnek

deleteV2PageReact Örneği

Copy

const tenantId: string = "tenant_79021";
const urlId: string = "blog/my-first-post";
const id: string = "reaction_9f8b7c";
let includeHistory: boolean | undefined = undefined; // isteğe bağlı bayrak, bazı çağrılarda kullanılır
const result: DeleteV2PageReact200Response = await deleteV2PageReact(tenantId, urlId, id);
console.log(result);

getV1PageLikes

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
urlId	string	Evet

Yanıt

Döndürür: GetV1PageLikes200Response

Örnek

getV1PageLikes Örneği

Copy

const tenantId: string = 'fastcomments-742';
const urlId: string = 'sports/2026/06/15/world-cup-preview';
const pageLikes: GetV1PageLikes200Response = await getV1PageLikes(tenantId, urlId);

getV2PageReacts

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
urlId	string	Evet

Yanıt

Döndürür: GetV2PageReacts200Response

Örnek

getV2PageReacts Örneği

Copy

const tenantId: string = "tenant_82f4b3a9";
const urlId: string = "https://news.site.com/articles/2026/06/15/product-launch";
const response: GetV2PageReacts200Response = await getV2PageReacts(tenantId, urlId);
console.log(response);

getV2PageReactUsers

Parametreler

Name	Tür	Gerekli
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Dönüş

Döndürür: GetV2PageReactUsers200Response

Örnek

getV2PageReactUsers Örneği

Copy

const tenantId: string = "7421";
const urlId: string = "sports/london-marathon";
const id: string = "reactUser-3fa85f64-5717-4562-b3fc-2c963f66afa6";
const includeDeleted: boolean | undefined = undefined; // isteğe bağlı bayrak (örnek amaçlı)
const result: GetV2PageReactUsers200Response = await getV2PageReactUsers(tenantId, urlId, id);

addPage

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createAPIPageData	CreateAPIPageData	Evet

Yanıt

Döndürür: AddPageAPIResponse

deletePage

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: DeletePageAPIResponse

getOfflineUsers

Sayfadaki, şu anda çevrimiçi olmayan önceki yorum yapan kullanıcılar. displayName'e göre sıralanır. Bu, /users/online tükendikten sonra "Members" bölümünü göstermek için kullanılır. commenterName üzerinde cursor sayfalaması: sunucu, kısmi {tenantId, urlId, commenterName} indeksinde afterName'den başlayıp ileriye doğru $gt ile yürür, $skip maliyeti yok.

Parametreler

Name	Type	Required
tenantId	string	Evet
urlId	string	Evet
afterName	string	Hayır
afterUserId	string	Hayır

Yanıt

Döndürür: GetOfflineUsers200Response

Örnek

getOfflineUsers Örneği

Copy

const tenantId: string = 'tenant_prod_001';
const urlId: string = 'article-2026-06-15-how-ai-impacts';
const afterName: string = 'michael.smith';
const afterUserId: string = 'user_72b9';
const response: GetOfflineUsers200Response = await getOfflineUsers(tenantId, urlId, afterName, afterUserId);

getOnlineUsers

Bir sayfanın şu anda çevrimiçi izleyicileri: websocket oturumu şu anda sayfaya abone olan kişiler. Returns anonCount + totalCount (oda genelindeki aboneler; saymadığımız anonim izleyiciler dahil).

Parametreler

Ad	Tip	Gerekli
tenantId	string	Evet
urlId	string	Evet
afterName	string	Hayır
afterUserId	string	Hayır

Yanıt

Döndürür: GetOnlineUsers200Response

Örnek

getOnlineUsers Örneği

Copy

const tenantId: string = 'tenant_14f9c3';
const urlId: string = 'article_20250615';
const afterName: string = 'marie.curie';
const afterUserId: string = 'u_92b7';
const result: GetOnlineUsers200Response = await getOnlineUsers(tenantId, urlId, afterName, afterUserId);

getPageByURLId

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
urlId	string	Evet

Yanıt

Döndürür: GetPageByURLIdAPIResponse

getPages

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet

Yanıt

Döndürür: GetPagesAPIResponse

getPagesPublic

Kiracı için sayfaları listeler. FChat masaüstü istemcisi tarafından oda listesini doldurmak için kullanılır. Her sayfa için çözümlenen özel yapılandırmada enableFChat değerinin true olması gerekir. SSO gerektiren sayfalar, istekte bulunan kullanıcının grup erişimine göre filtrelenir.

Parametreler

Adı	Tür	Gerekli
tenantId	string	Evet
cursor	string	Hayır
limit	number	Hayır
q	string	Hayır
sortBy	PagesSortBy	Hayır
hasComments	boolean	Hayır

Yanıt

Döndürür: GetPagesPublic200Response

Örnek

getPagesPublic Örneği

Copy

const tenantId: string = 'tenant_8f3b2c';
const cursor: string = 'eyJwYWdlIjoiMTIwIn0';
const limit: number = 25;
const q: string = 'homepage hero';
const hasComments: boolean = true;
const response: GetPagesPublic200Response = await getPagesPublic(
  tenantId,
  cursor,
  limit,
  q,
  undefined,
  hasComments
);

getUsersInfo

Bir kiracı için toplu kullanıcı bilgisi. Belirtilen userIds'e göre User / SSOUser'dan görüntüleme bilgilerini döndürür. Yorum widget'ı tarafından, presence olayı ile yeni görünen kullanıcıları zenginleştirmek için kullanılır. Sayfa bağlamı yok: gizlilik tutarlı şekilde uygulanır (özel profiller maskelenir).

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
ids	string	Evet

Yanıt

Döndürür: GetUsersInfo200Response

Örnek

getUsersInfo Örneği

Copy

const tenantId: string = 'acme-tenant-007';
const userIdsList: string[] = ['user_12a', 'user_34b', 'user_56c'];
const separator: string | undefined = undefined; // isteğe bağlı; undefined ise varsayılan olarak virgül kullanılır
const ids: string = userIdsList.join(separator ?? ',');
const usersInfo: GetUsersInfo200Response = await getUsersInfo(tenantId, ids);

patchPage

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateAPIPageData	UpdateAPIPageData	Evet

Yanıt

Döndürür: PatchPageAPIResponse

deletePendingWebhookEvent

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deletePendingWebhookEvent Örneği

Copy

const tenantId: string = "tenant_5f8d7a34";
const id: string = "webhook_evt_987654321";
const requestNote: string | undefined = undefined;
const response: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);

getPendingWebhookEventCount

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Hayır
externalId	string	Hayır
eventType	string	Hayır
type	string	Hayır
domain	string	Hayır
attemptCountGT	number	Hayır

Yanıt

Döndürür: GetPendingWebhookEventCount200Response

Örnek

getPendingWebhookEventCount Örneği

Copy

const tenantId: string = 'tenant_9f8b3b';
const commentId: string = 'cmt_1a2b3c';
const eventType: string = 'comment.created';
const domain: string = 'news-site.com';
const attemptCountGT: number = 2;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined, // externalId dahil edilmedi
  eventType,
  undefined, // type dahil edilmedi
  domain,
  attemptCountGT
);

getPendingWebhookEvents

Parametreler

Name	Type	Required
tenantId	string	Evet
commentId	string	Hayır
externalId	string	Hayır
eventType	string	Hayır
type	string	Hayır
domain	string	Hayır
attemptCountGT	number	Hayır
skip	number	Hayır

Yanıt

Döndürür: GetPendingWebhookEvents200Response

Örnek

getPendingWebhookEvents Örneği

Copy

const tenantId: string = 'tenant_9f3b2a';
const commentId: string = 'cmt_8a7d1';
const eventType: string = 'comment.created';
const domain: string = 'reviews.myshop.com';
const attemptCountGT: number = 1;
const skip: number = 0;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createQuestionConfigBody	CreateQuestionConfigBody	Evet

Yanıt

Döndürür: CreateQuestionConfig200Response

Örnek

createQuestionConfig Örneği

Copy

const tenantId: string = "tenant_9f3b1c2a";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  name: "Product feedback",
  key: "product_quality",
  description: "Short survey question shown after posting a comment",
  required: true,
  renderingType: "singleChoice",
  customOptions: [
    { label: "Excellent", value: "5" },
    { label: "Good", value: "4" },
    { label: "Fair", value: "3" }
  ] as QuestionConfigCustomOptionsInner[],
  notifyModerators: false // isteğe bağlı parametre örneği
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteQuestionConfig Örneği

Copy

const tenantId: string = 'acme-corp-47a9';
const id: string = 'qcfg_20260615_001';
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

getQuestionConfig

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetQuestionConfig200Response

Örnek

getQuestionConfig Örneği

Copy

const tenantId: string = "acme-corp-47";
const questionId: string = "q-4f2b9a";
const includeDrafts: boolean | undefined = undefined; // isteğe bağlı parametre yer tutucu
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
console.log(result);

getQuestionConfigs

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
skip	number	Hayır

Yanıt

Döndürür: GetQuestionConfigs200Response

Örnek

getQuestionConfigs Örneği

Copy

const tenantId: string = "tenant_4c9f2b";
const responseWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const skip: number = 50;
const responseWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, skip);

updateQuestionConfig

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateQuestionConfigBody	UpdateQuestionConfigBody	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateQuestionConfig Örneği

Copy

const tenantId: string = "tenant_9f3b8a2e-4c6d-4b4f-a1b2-9e8f7d6c5b3a";
const id: string = "q_7c2e1b4a-5d6f-4a8b-9c3d-2e1f0b9a4c5d";
const options: QuestionConfigCustomOptionsInner[] = [
  { value: "1", label: "Very dissatisfied" },
  { value: "2", label: "Dissatisfied" },
  { value: "3", label: "Neutral" },
  { value: "4", label: "Satisfied" },
  { value: "5", label: "Very satisfied" }
];
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  label: "How satisfied are you with the article?",
  enabled: true,
  required: false, // isteğe bağlı parametre gösterimi
  options
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createQuestionResultBody	CreateQuestionResultBody	Evet

Yanıt

Döndürür: CreateQuestionResult200Response

Örnek

createQuestionResult Örneği

Copy

const tenantId: string = 'fc-tenant-512';
const meta: MetaItem[] = [{ key: 'source', value: 'article' }];
const body: CreateQuestionResultBody = {
  questionId: 'q-94',
  userId: 'user_332',
  answers: [{ optionId: 'opt_a', score: 1 }],
  meta, // sağlanan isteğe bağlı meta verisi
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, body);

deleteQuestionResult

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteQuestionResult Örneği

Copy

const tenantId: string = "acme-corp-tenant-01";
const id: string = "qres_9f8b7c3a";
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);
const optionalResponse: FlagCommentPublic200Response | undefined = response;

getQuestionResult

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetQuestionResult200Response

Örnek

getQuestionResult Örneği

Copy

const tenantId: string = 'tenant_9f3b2a7c9';
const questionId: string = 'q_8d4f1b2c3a';
const options: { includeMeta?: boolean } = { includeMeta: true }; // isteğe bağlı parametre gösterimi
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
const apiStatus: APIStatus | undefined = (result as unknown as { apiStatus?: APIStatus }).apiStatus;
const question: QuestionResult | undefined = (result as unknown as { question?: QuestionResult }).question;

getQuestionResults

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Hayır
userId	string	Hayır
startDate	string	Hayır
questionId	string	Hayır
questionIds	string	Hayır
skip	number	Hayır

Yanıt

Döndürür: GetQuestionResults200Response

Örnek

getQuestionResults Örneği

Copy

const tenantId: string = 'fc-tenant-7a9c';
const urlId: string = 'news/article-2026-06-15';
const userId: string = 'user-8421';
const startDate: string = '2026-05-01T00:00:00Z';
const questionId: string = 'q-13';
const questionIds: string = 'q-13,q-14';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

updateQuestionResult

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
updateQuestionResultBody	UpdateQuestionResultBody	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateQuestionResult Örneği

Copy

const tenantId: string = "tenant_prod_84b2";
const id: string = "question_9f3a";
const updateQuestionResultBody: UpdateQuestionResultBody = {
  outcome: "accepted",
  confidence: 0.88,
  moderatorId: "moderator_17",
  notes: "Validated by automated review" // isteğe bağlı alan dahil edildi
};
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parametreler

İsim	Tür	Gerekli
tenantId	string	Evet
questionId	string	Hayır
questionIds	Array	Hayır
urlId	string	Hayır
timeBucket	AggregateTimeBucket	Hayır
startDate	Date	Hayır
forceRecalculate	boolean	Hayır

Yanıt

Döndürür: AggregateQuestionResults200Response

Örnek

aggregateQuestionResults Örneği

Copy

const tenantId: string = 'tenant_6f2b3c';
const questionIds: Array<string> = ['q-7a1b2c', 'q-8d3e4f'];
const urlId: string = 'url_9f8e7d';
const startDate: Date = new Date('2025-01-01T00:00:00Z');
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(tenantId, undefined, questionIds, urlId, undefined, startDate, true);

bulkAggregateQuestionResults

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Evet
forceRecalculate	boolean	Hayır

Yanıt

Döndürür: BulkAggregateQuestionResults200Response

Örnek

bulkAggregateQuestionResults Örneği

Copy

const tenantId: string = "tenant_0012";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    {
      questionId: "quality_score",
      startTime: "2026-06-01T00:00:00Z",
      endTime: "2026-06-14T00:00:00Z",
      timeBucket: "day",
      dimensions: ["threadId"]
    }
  ],
  includeTotals: true
};
const forceRecalculate: boolean = false;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

combineCommentsWithQuestionResults

Parametreler

Ad	Tür	Zorunlu
tenantId	string	Evet
questionId	string	Hayır
questionIds	Array	Hayır
urlId	string	Hayır
startDate	Date	Hayır
forceRecalculate	boolean	Hayır
minValue	number	Hayır
maxValue	number	Hayır
limit	number	Hayır

Yanıt

Döndürür: CombineCommentsWithQuestionResults200Response

Örnek

combineCommentsWithQuestionResults Örneği

Copy

const tenantId: string = 'tenant_12345';
const questionId: string = 'q_98765';
const questionIds: string[] = ['q_98765', 'q_12345'];
const urlId: string = 'url_abc123';
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 0;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

addSSOUser

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createAPISSOUserData	CreateAPISSOUserData	Evet

Yanıt

Döndürür: AddSSOUserAPIResponse

deleteSSOUser

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
deleteComments	boolean	Hayır
commentDeleteMode	string	Hayır

Yanıt

Döndürür: DeleteSSOUserAPIResponse

getSSOUserByEmail

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
email	string	Evet

Yanıt

Döndürür: GetSSOUserByEmailAPIResponse

getSSOUserById

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Dönüş: GetSSOUserByIdAPIResponse

getSSOUsers

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
skip	number	Hayır

Yanıt

Döndürür: GetSSOUsers200Response

patchSSOUser

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateAPISSOUserData	UpdateAPISSOUserData	Evet
updateComments	boolean	Hayır

Yanıt

Döndürür: PatchSSOUserAPIResponse

putSSOUser

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateAPISSOUserData	UpdateAPISSOUserData	Evet
updateComments	boolean	Hayır

Yanıt

Döndürür: PutSSOUserAPIResponse

Örnek

putSSOUser Örneği

Copy

const tenantId: string = 'acme-enterprises-42';
const id: string = 'usr-73a1b2';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'marcus.ingram@acme.com',
  givenName: 'Marcus',
  familyName: 'Ingram',
  roles: ['editor', 'project_owner'],
  enabled: true
};
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, true);

createSubscription

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Evet

Yanıt

Döndürür: CreateSubscriptionAPIResponse

Örnek

createSubscription Örneği

Copy

const tenantId: string = "acme-corp-tenant-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "user_98765",
  planId: "pro_monthly",
  paymentMethod: { type: "card", cardId: "card_abc123" },
  autoRenew: true,
  trialDays: 14, // isteğe bağlı parametre örneği
  metadata: { campaign: "spring_launch" } // isteğe bağlı parametre örneği
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

deleteSubscription

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
userId	string	Hayır

Yanıt

Döndürür: DeleteSubscriptionAPIResponse

getSubscriptions

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
userId	string	Hayır

Yanıt

Döndürür: GetSubscriptionsAPIResponse

Örnek

getSubscriptions Örneği

Copy

const tenantId: string = "contoso-9a1b2c";
const userId: string = "u-482f6";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

updateSubscription

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Evet
userId	string	Hayır

Yanıt

Döndürür: UpdateSubscriptionAPIResponse

Örnek

updateSubscription Örneği

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

getTenantDailyUsages

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
yearNumber	number	Hayır
monthNumber	number	Hayır
dayNumber	number	Hayır
skip	number	Hayır

Yanıt

Döndürür: GetTenantDailyUsages200Response

Örnek

getTenantDailyUsages Örneği

Copy

const tenantId: string = 'tenant_7a3c2e';
const dailyUsages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, 2026, 6, undefined, 0);

createTenantPackage

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createTenantPackageBody	CreateTenantPackageBody	Evet

Yanıt

Döndürür: CreateTenantPackage200Response

Örnek

createTenantPackage Örneği

Copy

const tenantId: string = "tenant_7890";
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Growth Plan",
  maxSeats: 2500,
  features: {
    moderation: true,
    analytics: true,
    sso: { enabled: true, provider: "saml" }
  },
  billing: { interval: "monthly", priceCents: 19900 },
  // isteğe bağlı parametre gösterimi: notes gerekli değil ama sağlandı
  notes: "Onboarding bundle with priority support"
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

deleteTenantPackage

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteTenantPackage Örneği

Copy

const tenantId: string = 'acme-corp-tenant-01';
const packageId: string = 'pkg-2026-06-15-001';
const dryRun: boolean | undefined = undefined; // isteğe bağlı bayrak örneği (fonksiyon tarafından gerekli değil)
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetTenantPackage200Response

Örnek

getTenantPackage Örneği

Copy

const tenantId: string = 'tenant_4b8c2a9f';
const packageId: string = 'pkg_7d3e1b5c';
const includeMetadata: boolean | undefined = true;
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
skip	number	Hayır

Yanıt

Döndürür: GetTenantPackages200Response

Örnek

getTenantPackages Örneği

Copy

const tenantId: string = 'tenant_8421';
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, 25);
const packagesWithoutSkip: GetTenantPackages200Response = await getTenantPackages(tenantId);

replaceTenantPackage

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
replaceTenantPackageBody	ReplaceTenantPackageBody	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

replaceTenantPackage Örneği

Copy

const tenantId: string = "fastcomments-tenant-114";
const id: string = "pkg-enterprise-2026-06";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: "EnterpriseModeration",
  version: "2.4.7",
  enabled: true,
  apiStatus: { state: "active", lastUpdated: "2026-06-10T12:00:00Z" },
  customConfigParameters: { maxCommentLength: 1200, allowImages: true }, // isteğe bağlı ayarlar dahil
  voteStyle: { style: "updown" }
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

updateTenantPackage

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateTenantPackageBody	UpdateTenantPackageBody	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateTenantPackage Örneği

Copy

const tenantId: string = 'tenant_9f3b2a';
const id: string = 'pkg_pro_2026';
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Pro Plan',
  monthlyPriceUsd: 49,
  isActive: true,
  features: ['moderation', 'analytics', 'sso'],
  trialDays: 14 // isteğe bağlı parametre örneği
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
createTenantUserBody	CreateTenantUserBody	Evet

Yanıt

Döndürür: CreateTenantUser200Response

Örnek

createTenantUser Örneği

Copy

const tenantId: string = "tenant_7f4a2b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "commenter",
  approved: true,
  displayName: "Jane D." // isteğe bağlı: kullanıcı dostu bir ad sağlama
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);
console.log(result);

deleteTenantUser

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
deleteComments	string	Hayır
commentDeleteMode	string	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteTenantUser Örneği

Copy

const tenantId: string = "tenant_8f3a2b1c4d";
const id: string = "user_62a4f9e0b7";
const deleteComments: string = "true";
const commentDeleteMode: string = "permanent";
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

getTenantUser

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetTenantUser200Response

Örnek

getTenantUser Örneği

Copy

const tenantId: string = 'tenant_ab12c3';
const id: string = 'user_9f8e7d';
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log(response);

getTenantUsers

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
skip	number	Hayır

Yanıt

Döndürür: GetTenantUsers200Response

Örnek

getTenantUsers Örneği

Copy

const tenantId: string = 'tenant_7b8f3a2c-9e4d-4f1a';
const skip: number = 50;
const usersResponseDefault: GetTenantUsers200Response = await getTenantUsers(tenantId);
const usersResponsePaged: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

replaceTenantUser

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
replaceTenantUserBody	ReplaceTenantUserBody	Evet
updateComments	string	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

replaceTenantUser Örneği

Copy

const tenantId: string = "f3b9a2d1-8b4e-4c6a-9f2b-1d5c4e6a7b8c";
const id: string = "user_92f7c3b1";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: "auth0|1234567890",
  email: "jane.doe@company.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  metadata: { department: "support" }
};
const updateComments: string = "reassign-comments-to-new-user";
const response: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
redirectURL	string	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

sendLoginLink Örneği

Copy

const tenantId: string = "tenant_0a1b2c3d";
const id: string = "user_984321";
const redirectURL: string = "https://app.acme-corp.com/welcome";
const responseWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);
const responseWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);

updateTenantUser

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
updateTenantUserBody	UpdateTenantUserBody	Evet
updateComments	string	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateTenantUser Örneği

Copy

const tenantId: string = 'acme-corp';
const userId: string = 'u_72b9f4';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  suspended: false
};
const updateComments: string = 'Promoted to moderator after review of activity and community feedback';
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, userId, updateTenantUserBody, updateComments);

createTenant

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createTenantBody	CreateTenantBody	Evet

Yanıt

Döndürür: CreateTenant200Response

Örnek

createTenant Örneği

Copy

const tenantId: string = 'acme-news-01';
const createTenantBody: CreateTenantBody = {
  name: 'Acme News',
  domainConfiguration: { primaryDomain: 'news.acme.com', redirectHttps: true } as APIDomainConfiguration,
  importedSites: [{ siteId: 'site-92', url: 'https://news.acme.com' }] as ImportedSiteType[],
  billingInfo: { planId: 'business_monthly', contactEmail: 'billing@acme.com' } as BillingInfo
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

deleteTenant

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
sure	string	Hayır

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteTenant Örneği

Copy

const tenantId: string = 'tenant_742b9c';
const flagId: string = 'flag_1a2b3c';
const resultWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId);
const sureConfirmation: string = 'confirmed';
const resultWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId, sureConfirmation);

getTenant

Parametreler

Ad	Tür	Zorunlu	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetTenant200Response

Örnek

getTenant Örneği

Copy

const tenantId: string = 'fc_tenant_6b3e2a';
const id: string = 'site_42f1';
const tenantResponse: GetTenant200Response = await getTenant(tenantId, id);
const tenant: APITenant | undefined = tenantResponse.tenant;
const primaryDomain: APIDomainConfiguration | undefined = tenant?.domainConfiguration?.[0];

getTenants

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
meta	string	Hayır
skip	number	Hayır

Yanıt

Döndürür: GetTenants200Response

Örnek

getTenants Örneği

Copy

const tenantId: string = "fcom-tenant-8b4f2a1c";
const meta: string = "include=domains,billing&status=active";
const skip: number = 20;
const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
console.log(response);

updateTenant

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateTenantBody	UpdateTenantBody	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateTenant Örneği

Copy

const tenantId: string = 'tenant_84f12';
const id: string = 'flag_192b';
const updateTenantBody: UpdateTenantBody = {
  name: 'Acme Media',
  billingInfo: { plan: 'enterprise', seats: 25, nextBillingDate: '2026-07-01' },
  apiDomainConfiguration: { primaryDomain: 'comments.acme.com', additionalDomains: ['acme.com'] },
  importedSites: [{ siteUrl: 'https://blog.acme.com', archived: false }], // isteğe bağlı
  commentSettings: { htmlRenderingMode: 'sanitized', deletionMode: 'soft' } // isteğe bağlı
} as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parametreler

Name	Type	Required
tenantId	string	Evet
userId	string	Evet
id	string	Evet
changeTicketStateBody	ChangeTicketStateBody	Evet

Yanıt

Döndürür: ChangeTicketState200Response

Örnek

changeTicketState Örneği

Copy

const tenantId: string = 'tenant_8a7d3f4b';
const userId: string = 'user_5d1a9b2c';
const id: string = 'ticket_1024';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'closed',
  notifyParticipants: true, // isteğe bağlı parametre örneği
  comment: 'Resolved by support — follow-up not required.'
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

createTicket

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
userId	string	Evet
createTicketBody	CreateTicketBody	Evet

Yanıt

Döndürür: CreateTicket200Response

Örnek

createTicket Örneği

Copy

const tenantId: string = 'tenant_acme_corp';
const userId: string = 'moderator_jane';
const createTicketBody: CreateTicketBody = {
  subject: 'Mass spam reports on article 789',
  description: 'Multiple identical spam comments posted under article 789. Needs moderation and bulk removal.',
  priority: 'high',
  contactEmail: 'jane@acme-corp.com',
  metadata: { articleId: '789', reportedCount: 12 } // isteğe bağlı metadata gösterimi
};
const ticket: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

getTicket

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
userId	string	Hayır

Yanıt

Döndürür: GetTicket200Response

Örnek

getTicket Örneği

Copy

const tenantId: string = 'acme-corp';
const ticketId: string = 'TCKT-20250615-42';
const userId: string = 'user_84b2';
const ticketWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);
console.log(ticketWithUser.id, ticketWithoutUser.id);

getTickets

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
userId	string	Hayır
state	number	Hayır
skip	number	Hayır
limit	number	Hayır

Yanıt

Döndürür: GetTickets200Response

Örnek

getTickets Örneği

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_87b3';
const state: number = 2;
const skip: number = 0;
const limit: number = 50;
const tickets: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);

getTranslations

Parametreler

Ad	Tür	Gerekli
namespace	string	Evet
component	string	Evet
locale	string	Hayır
useFullTranslationIds	boolean	Hayır

Yanıt

Döndürür: GetTranslations200Response

Örnek

getTranslations Örneği

Copy

const namespaceName: string = 'site-ui';
const componentName: string = 'comment-widget';
const locale: string = 'fr-FR';
const useFullTranslationIds: boolean = true;
const translationsWithLocale: GetTranslations200Response = await getTranslations(namespaceName, componentName, locale, useFullTranslationIds);
const translationsDefault: GetTranslations200Response = await getTranslations(namespaceName, componentName);

uploadImage

Bir resmi yükle ve yeniden boyutlandır

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
file	Blob	Evet
sizePreset	SizePreset	Hayır
urlId	string	Hayır

Yanıt

Döndürür: UploadImageResponse

getUserBadgeProgressById

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetUserBadgeProgressById200Response

Örnek

getUserBadgeProgressById Örneği

Copy

const tenantId: string = 'fastcomments-tenant-241';
const badgeId: string = 'user-78b3d-badge-3';
const response: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, badgeId);
const progress: UserBadgeProgress | undefined = (response as unknown as { progress?: UserBadgeProgress }).progress;
const percentComplete: number | undefined = progress?.percentage;
console.log('Badge progress percent complete:', percentComplete);

getUserBadgeProgressByUserId

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Yes
userId	string	Yes

Yanıt

Döndürür: GetUserBadgeProgressById200Response

Örnek

getUserBadgeProgressByUserId Örneği

Copy

const tenantId: string = 'acme-inc-tenant-01';
const userId: string = 'user_73c9b2';
const progress: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
async function maybeFetchProgress(tenant: string, user?: string): Promise<GetUserBadgeProgressById200Response | null> {
  if (!user) return null;
  return await getUserBadgeProgressByUserId(tenant, user);
}
const optionalResult: GetUserBadgeProgressById200Response | null = await maybeFetchProgress(tenantId, userId);

getUserBadgeProgressList

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
userId	string	Hayır
limit	number	Hayır
skip	number	Hayır

Yanıt

Döndürür: GetUserBadgeProgressList200Response

Örnek

getUserBadgeProgressList Örneği

Copy

const tenantId: string = 'tenant_4f3a2b9c';
const userId: string = 'user_7721d';
const limit: number = 20;
const skip: number = 0;
const result: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);

createUserBadge

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
createUserBadgeParams	CreateUserBadgeParams	Evet

Yanıt

Döndürür: CreateUserBadge200Response

Örnek

createUserBadge Örneği

Copy

const tenantId: string = "tenant_7f4b2a";
const createUserBadgeParams: CreateUserBadgeParams = {
  code: "top_contributor",
  title: "Top Contributor",
  description: "Awarded for 100 high-quality comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top_contributor.svg",
  isActive: true,
  criteria: { commentsRequired: 100 },
  customConfig: { displayOnProfile: true } // isteğe bağlı parametre gösterimi
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

deleteUserBadge

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: UpdateUserBadge200Response

Örnek

deleteUserBadge Örneği

Copy

const tenantId: string = "tenant_8b3f2c7a";
const badgeIdOptional: string | undefined = Math.random() > 0.5 ? "badge_4f9a21" : undefined;
const id: string = badgeIdOptional ?? "badge_backup_01";
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

getUserBadge

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetUserBadge200Response

Örnek

getUserBadge Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_6b8f2a1c';
  const id: string = 'badge_9f3d4b2a';
  const response: GetUserBadge200Response = await getUserBadge(tenantId, id);
  const badge: UserBadge | undefined = response.userBadge;
  const badgeName: string | undefined = badge?.name;
  console.log('Retrieved badge name:', badgeName);
})();

getUserBadges

Parametreler

İsim	Tür	Gerekli
tenantId	string	Evet
userId	string	Hayır
badgeId	string	Hayır
type	number	Hayır
displayedOnComments	boolean	Hayır
limit	number	Hayır
skip	number	Hayır

Yanıt

Dönen Değer: GetUserBadges200Response

Örnek

getUserBadges Örneği

Copy

const tenantId: string = 'tenant_7f9a12';
const userId: string = 'user_42b7';
const badgeId: string = 'badge_top_contributor';
const type: number = 2;
const displayedOnComments: boolean = true;
const limit: number = 25;
const skip: number = 0;
const badges: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

updateUserBadge

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
id	string	Evet
updateUserBadgeParams	UpdateUserBadgeParams	Evet

Yanıt

Döndürür: UpdateUserBadge200Response

Örnek

updateUserBadge Örneği

Copy

const tenantId: string = "tenant_9a8b7c";
const id: string = "badge_a1b2c3";
const updateUserBadgeParams: UpdateUserBadgeParams = {
  title: "Community Helper",
  description: "Awarded for providing 50 helpful answers",
  iconUrl: "https://cdn.fastcomments.com/badges/community-helper.png",
  isActive: true,
  expiryDate: undefined
};
const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);

getUserNotificationCount

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Yes
sso	string	No

Yanıt

Döndürür: GetUserNotificationCount200Response

Örnek

getUserNotificationCount Örneği

Copy

const tenantId: string = 'tenant_acme_01';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const notificationCountNoSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
const notificationCountWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);

getUserNotifications

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Hayır
pageSize	number	Hayır
afterId	string	Hayır
includeContext	boolean	Hayır
afterCreatedAt	number	Hayır
unreadOnly	boolean	Hayır
dmOnly	boolean	Hayır
noDm	boolean	Hayır
includeTranslations	boolean	Hayır
includeTenantNotifications	boolean	Hayır
sso	string	Hayır

Yanıt

Dönüş: GetUserNotifications200Response

Örnek

getUserNotifications Örneği

Copy

const tenantId: string = "tenant_8271";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/ai-updates";
const pageSize: number = 25;
const afterId: string = "notif_abc123";
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 86_400_000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const includeTenantNotifications: boolean = true;
const sso: string = "sso_token_xyz_987";
const notifications: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  urlId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  includeTenantNotifications,
  sso
);

resetUserNotificationCount

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
sso	string	Hayır

Yanıt

Döndürür: ResetUserNotifications200Response

Örnek

resetUserNotificationCount Örneği

Copy

const tenantId: string = "tenant_8a3f2b6c";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyX2QxMjM0IiwiaWF0IjoxNjI1MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resetResponseWithSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
const resetResponseWithoutSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);

resetUserNotifications

Parametreler

Name	Tür	Gerekli
tenantId	string	Evet
afterId	string	Hayır
afterCreatedAt	number	Hayır
unreadOnly	boolean	Hayır
dmOnly	boolean	Hayır
noDm	boolean	Hayır
sso	string	Hayır

Yanıt

Döndürür: ResetUserNotifications200Response

Örnek

resetUserNotifications Örneği

Copy

const tenantId: string = "tenant_9b1f2";
const afterId: string = "notification_0001";
const afterCreatedAt: number = Date.now() - 60 * 60 * 1000; // bir saat önce
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const sso: string = "sso_session_7f2d";
const result: ResetUserNotifications200Response = await resetUserNotifications(
  tenantId,
  afterId,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  sso
);

updateUserNotificationCommentSubscriptionStatus

Belirli bir yorum için bildirimleri etkinleştirin veya devre dışı bırakın.

Parametreler

Name	Type	Required
tenantId	string	Evet
notificationId	string	Evet
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Evet
commentId	string	Evet
sso	string	Hayır

Yanıt

Döndürür: UpdateUserNotificationStatus200Response

Örnek

updateUserNotificationCommentSubscriptionStatus Örneği

Copy

const tenantId: string = 'f3a9c8b0-4d2e-4f8a-9c3b-1234567890ab';
const notificationId: string = '62a1f4d2-8c7b-4e1a-aaa1-abcdef123456';
const commentId: string = '7e4a2b1c-1234-5678-90ab-cdef12345678';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptedIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

updateUserNotificationPageSubscriptionStatus

Bir sayfa için bildirimleri etkinleştirin veya devre dışı bırakın. Kullanıcılar bir sayfaya abone olduğunda, yeni ana yorumlar için bildirimler oluşturulur ve ayrıca

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
url	string	Evet
pageTitle	string	Evet
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Evet
sso	string	Hayır

Yanıt

Döndürür: UpdateUserNotificationStatus200Response

Örnek

updateUserNotificationPageSubscriptionStatus Örneği

Copy

const tenantId: string = 'tenant_7f3b2';
const urlId: string = 'article_987';
const url: string = 'https://www.news-site.com/articles/2026/pasta-guide';
const pageTitle: string = 'The Definitive Guide to Cooking Pasta';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso-token-62b9f1';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

updateUserNotificationStatus

Parametreler

Name	Type	Required
tenantId	string	Evet
notificationId	string	Evet
newStatus	UpdateUserNotificationStatusNewStatusEnum	Evet
sso	string	Hayır

Yanıt

Döndürür: UpdateUserNotificationStatus200Response

Örnek

updateUserNotificationStatus Örneği

Copy

const tenantId: string = 'tenant_5f2a8b9c';
const notificationId: string = 'notif_987654321';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

getUserPresenceStatuses

Parametreler

Name	Type	Required
tenantId	string	Evet
urlIdWS	string	Evet
userIds	string	Evet

Yanıt

Döndürür: GetUserPresenceStatuses200Response

Örnek

getUserPresenceStatuses Örneği

Copy

const tenantId: string = 'tenant_42';
const urlIdWS: string = 'wss://comments.fastsite.com/ws/tenant_42';
const userIds: string = 'user_9012,user_3478';
const includePresenceMetadata: boolean | undefined = true; // isteğe bağlı parametre örneği
const presenceStatuses: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

searchUsers

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
usernameStartsWith	string	Hayır
mentionGroupIds	Array	Hayır
sso	string	Hayır
searchSection	SearchUsersSearchSectionEnum	Hayır

Yanıt

Döndürür: SearchUsers200Response

Örnek

searchUsers Örneği

Copy

const tenantId: string = 'tenant_7890';
const urlId: string = 'news/2026-06-15-world-cup-final';
const usernameStartsWith: string = 'mar';
const mentionGroupIds: string[] = ['staff', 'trusted-commenters'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0NTY3OCJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Commenters;
const response: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

getUser

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetUser200Response

Örnek

getUser Örneği

Copy

const tenantId: string = 'fastcomments_corp';
const id: string = 'user_9f8b7c6d-5e4a-3b2c-1f0e-123456789abc';
const response: GetUser200Response = await getUser(tenantId, id);
const userEmail: string | undefined = response.user?.email;
const displayName: string | undefined = response.user?.displayName

createVote

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
direction	CreateVoteDirectionEnum	Evet
userId	string	Hayır
anonUserId	string	Hayır

Yanıt

Dönüş Değeri: VoteComment200Response

Örnek

createVote Örneği

Copy

const tenantId: string = 'fastcomments-tenant-001';
const commentId: string = 'cmt_8f3b2a9d';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const userId: string = 'user_5021';
const anonUserId: string = 'anon_7a9c';
const voteResponse: VoteComment200Response = await createVote(tenantId, commentId, direction, userId, anonUserId);

deleteVote

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
editKey	string	Hayır

Yanıt

Döndürür: DeleteCommentVote200Response

Örnek

deleteVote Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_8421';
  const id: string = 'vote_3f9b7c2a';
  const editKey: string = 'edit_7Xk9LpQ';
  const responseWithoutEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id);
  const responseWithEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
  console.log(responseWithoutEdit, responseWithEdit);
})();

getVotes

Parametreler

Ad	Tür	Gerekli	Açıklama
tenantId	string	Evet
urlId	string	Evet

Yanıt

Döndürür: GetVotes200Response

Örnek

getVotes Örneği

Copy

const tenantId: string = 'tenant_7f8e91c2';
const urlId: string = 'https://www.sportsdaily.com/news/2026/06/15/championship-game-recap';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
console.log(votes);

getVotesForUser

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
userId	string	Hayır
anonUserId	string	Hayır

Yanıt

Dönüş değeri: GetVotesForUser200Response

Örnek

getVotesForUser Örneği

Copy

const tenantId: string = 'tenant_9b8f7c6d';
const urlId: string = 'articles/product-update-2026';
const userId: string = 'user_c12345';
const anonUserId: string = 'anon_7f4e2a';
const votes: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);

Yardıma mı ihtiyacınız var?

JavaScript/TypeScript SDK hakkında herhangi bir sorunla karşılaşırsanız veya sorularınız olursa lütfen:

Katkıda Bulunma

Katkılar memnuniyetle karşılanır! Katkı yönergeleri için lütfen GitHub deposunu ziyaret edin.

Dil 🇹🇷 Türkçe

Başlarken

API Referansı

Dokümantasyon

Kullanım

Toplama

Denetim Kayıtları

Yorumdan Engelleme

Engellenen Yorumları Kontrol Et

Yorumlar

Kullanıcı İçin Yorumlar

Alan Adı Yapılandırmaları

E-posta Şablonları

Olay Günlüğü

Akış Gönderileri

Yorumu İşaretle

GIF'ler

Hashtag'ler

Moderatörler

Bildirim Sayısı

Bildirimler

Sayfa Tepkileri

Sayfalar

Bekleyen Webhook Olayları

Soru Yapılandırmaları

Soru Sonuçları

Soru Sonuçları Toplama

SSO Kullanıcıları

Abonelikler

Tenant Günlük Kullanımı

Tenant Paketleri

Tenant Kullanıcıları

Tenantlar

Destek Talepleri

Çeviriler

Resim Yükle

Kullanıcı Rozet İlerlemesi

Kullanıcı Rozetleri

Kullanıcı Bildirimleri

Kullanıcı Varlık Durumu

Kullanıcı Arama

Kullanıcılar

Oylar

FastComments JavaScript/TypeScript SDK

Depo

Kurulum

API Dokümantasyonu

Tam API referansı: docs/api/README.md

Tarayıcı vs Sunucu Uyumluluğu

Kullanım

Tarayıcı Kullanımı (İstemci Tarafı)

Sunucu Kullanımı (Node.js)

Sadece Tip İçe Aktarımı

Bireysel API Sınıflarını Kullanma

Tarayıcı Ortamı

Sunucu Ortamı

Genel vs Güvenli API'ler

Örnek: Public API Kullanımı (tarayıcı için güvenli)

Örnek: Default API Kullanımı (yalnızca sunucu tarafı)

SSO (Tekli Oturum Açma) Entegrasyonu

Simple SSO (Server-Side Only)

Secure SSO (Server-Side, Recommended)

Using SSO from Browser (with Server-Generated Token)

SSO with Comment Creation

Yaygın Kullanım Senaryoları

Bir Sayfa İçin Yorumları Alma

Yorum Oluşturma

Bir Yorum İçin Oy Verme

Kullanıcı Yönetimi (API Anahtarı Gerekir)

Canlı Etkinlikler (Gerçek Zamanlı Güncellemeler)

Sayfa Düzeyi Etkinlikleri

Kullanıcı Etkinliklerine Abone Olma

userIdWS'i Alma

Yayın Kimlikleri

Hata Yönetimi

aggregate

Parametreler

Response

Örnek

getAuditLogs