FastComments JavaScript/TypeScript SDK

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

FastComments API'si için resmi JavaScript/TypeScript SDK

Depo

Kurulum

npm install fastcomments-sdk

API Dokümantasyonu

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

Tarayıcı ve 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);

Açık ve 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 (Tek 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, (groupBy sağlanmışsa) gruplayarak ve birden çok işlem uygulayarak toplar. Farklı işlemler (ör. sum, countDistinct, avg vb.) desteklenir.

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
aggregationRequest	AggregationRequest	Evet
parentTenantId	string	Hayır
includeStats	boolean	Hayır

Yanıt

Döndürür: AggregationResponse

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

async function main(): Promise<void> {
  const tenantId: string = 'tenant_9b8f6c';
  const limit: number = 50;
  const skip: number = 0;
  const order: SORTDIR = 'desc';
  const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000;
  const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after);
  console.log(response);
}
main();

blockFromCommentPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

Yanıt

Döndürür: BlockFromCommentPublic200Response

Örnek

blockFromCommentPublic Örneği

Copy

const tenantId: string = "site_7f9b2e";
const commentId: string = "comment_2026-03-25_001";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "Repeated harassment and targeted abuse",
  blockDurationDays: 90,
  includeHistory: true,
  notifyModeratorTeam: true
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";
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_42e8a1';
const commentId: string = 'cmt_9b3f2d';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive_language',
  blockedByModeratorId: 'mod_17',
  note: 'Targeted harassment; review complete',
  unblockRequestedAt: new Date().toISOString()
};
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
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

const tenantId: string = 'tenant_4f3b2a1e';
const commentIds: string = 'c_1001,c_1002,c_1003';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

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_12345";
const id: string = "comment_67890";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated abusive language",
  blockDurationHours: 168,
  blockReplies: true,
  notifyAuthor: true
};
const userId: string = "user_abc123";
const anonUserId: string = "anon_xyz789";
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

createCommentPublic

Parametreler

Adı	Tür	Zorunlu
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_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

deleteComment

Parametreler

Ad	Tür	Gerekli
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_7b3f2a';
const commentId: string = 'cmt_8a1f4d2b';
const contextUserId: string = 'user_102';
const isLive: boolean = true;
const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, isLive);

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_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
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 = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: 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_acme_001';
const id: string = 'comment_7f3a2b9e';
const userId: string = 'user_jdoe_1001';
const anonUserId: string = 'anon_3f2b_visitor';
const result: FlagComment200Response = await flagComment(tenantId, id, userId, anonUserId);

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 = "acme-publishing-001";
const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";
const result: GetComment200Response = await getComment(tenantId, commentId);
const wrapper: GetComment200Response & { comment?: APIComment } = result;
const comment: APIComment | undefined = wrapper.comment;
const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;
const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

getComments

Parametreler

Ad	Tür	Gerekli
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

Yanıt

Döndürür: GetComments200Response

Örnek

getComments Örneği

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // page
  20, // limit
  0, // skip
  true, // asTree
  1, // skipChildren
  3, // limitChildren
  4, // maxTreeDepth
  'articles/2026/new-product-launch', // urlId
  'user_7890', // userId
  'anon_4f3b2', // anonUserId
  undefined, // contextUserId
  '#launch', // hashTag
  undefined // parentId
);

getCommentsPublic

req tenantId urlId

Parametreler

Ad	Tür	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 = 'tenant_eu-west_01';
const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  2,
  undefined,
  'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',
  undefined,
  0,
  50,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'reactions,moderation',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'performance',
  ['feature','fastcomments'],
  'user_9876',
  undefined,
  undefined,
  undefined
);

getCommentText

Parametreler

Name	Type	Required
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_acme_001';
const commentId: string = 'cmt_7890b';
const editKey: string = 'edit_4f2d9b7c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
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öndürür: GetCommentVoteUserNames200Response

Örnek

getCommentVoteUserNames Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_4f2c1e';
  const commentId: string = 'cmt_9a7b3d';
  const dir: number = 1;
  const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';
  const dirDown: number = -1;
  const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);
  console.log(resultUpvotes, resultDownvotes);
})();

lockComment

Parametreler

Ad	Tür	Gerekli
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_prod_8f3a2b";
const commentId: string = "cmt_5d7e9a92";
const broadcastId: string = "broadcast_2026_03_25_1400";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

pinComment

Parametreler

Adı	Tür	Gerekli
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 = "tenant_4f2b9a";
const commentId: string = "cmt_9f8e7d6c";
const broadcastId: string = "brd_live_concert_2026-03-25";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

saveComment

Parametreler

Ad	Tür	Gerekli
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 = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
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

Name	Type	Required
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 = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

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öndürür: SetCommentText200Response

Örnek

setCommentText Örneği

Copy

const tenantId: string = 'tenant_6721f4';
const commentId: string = 'cmt_9a3b2d';
const broadcastId: string = 'live_2026_03_25';
const editKey: string = 'edit_k_4f7b9';
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Updated to clarify the timeline and link the relevant docs.',
  mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],
  hashtags: [{ tag: 'product-update' }]
};
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

unBlockUserFromComment

Parametreler

Ad	Tür	Zorunlu
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_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

unFlagComment

Parametreler

Name	Type	Gerekli
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 = 'acme-tenant-001';
const commentId: string = 'cmt_9f8e7d6c';
const userId: string = 'user_72b4a1c9';
const anonUserId: string = 'anon_3d2c1b0a';
const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

unLockComment

Parametreler

İsim	Tip	Gerekli
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_9d4f2b';
const commentId: string = 'cmt_8a3e1f';
const broadcastId: string = 'broadcast_2026_03_25';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

unPinComment

Parametreler

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

Yanıt

Döndürür: PinComment200Response

Örnek

unPinComment Örneği

Copy

const tenantId: string = 'tenant_7f9d2a3b';
const commentId: string = 'comment_842b9c1f';
const broadcastId: string = 'bcast_frontpage_202603';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

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 Örnek

Copy

const tenantId: string = "tenant_acme_corp_01";
const id: string = "comment_20260325_4592";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Updated the response to include a link to the RFC and fixed a typo in the second paragraph.",
  editedByUserId: "user_8721",
  isVisible: true
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

voteComment

Parametreler

Name	Type	Required
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öndürür: VoteComment200Response

Örnek

voteComment Örneği

Copy

const tenantId: string = 'tenant_9f8b7c';
const commentId: string = 'cmt_42f3a1';
const urlId: string = 'articles/ai-trends-2026';
const broadcastId: string = 'web';
const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };
const sessionId: string = 'sess_6d2b4c9e';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

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_7a9f3c2b";
const customConfig: CustomConfigParameters = { smtpHost: "smtp.fastmail.com", smtpPort: 587, useTLS: true };
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Account Notification",
  subject: "Your ACME account was updated",
  fromEmail: "no-reply@acme-corp.com",
  replyTo: "support@acme-corp.com",
  html: "<p>Hi {{user.firstName}}, your account settings were changed.</p>",
  text: "Hi {{user.firstName}}, your account settings were changed.",
  isActive: true,
  description: "Used for transactional account update emails",
  customConfig
};
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_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // isteğe bağlı parametre örneği
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

deleteEmailTemplateRenderError

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
errorId	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteEmailTemplateRenderError Örneği

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // isteğe bağlı ortam seçici
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

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 = "acme-marketing-042";
const templateId: string = "tpl_welcome_2026";
const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);
const template: CustomEmailTemplate | undefined = result.template;
const subject: string | undefined = template?.subject;
const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

getEmailTemplateDefinitions

Parametreler

Name	Type	Required	Description
tenantId	string	Evet

Dönüş

Dönüş: GetEmailTemplateDefinitions200Response

Örnek

getEmailTemplateDefinitions Örneği

Copy

const tenantId: string = 'tenant_acme_eu_01';
const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
console.log('Email template definitions loaded for', tenantId, templates);

getEmailTemplateRenderErrors

Parametreler

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

Yanıt

Döndürür: GetEmailTemplateRenderErrors200Response

Örnek

getEmailTemplateRenderErrors Örneği

Copy

(async () => {
  const tenantId: string = 'acme-tenant-42';
  const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';
  const skip: number = 20;
  const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
  console.log(result);
})();

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 main(): Promise<void> {
  const tenantId: string = 'tenant_5f3a9c2b';
  const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const skip: number = 20;
  const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
  console.log(templates, pagedTemplates);
}
main();

renderEmailTemplate

Parametreler

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

Yanıt

Döndürür: RenderEmailTemplate200Response

Örnek

renderEmailTemplate Örneği

Copy

const tenantId: string = 'tenant_b6f3c2';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'comment-notification',
  recipient: { name: 'Ava Thompson', email: 'ava.thompson@publisher.com' },
  context: {
    siteName: 'City Gazette',
    commentText: 'Thanks for the in-depth coverage — very helpful.',
    articleTitle: 'Downtown Redevelopment Plan Advances',
    threadUrl: 'https://citygazette.example/articles/2026/redevelopment#comments'
  }
};
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 = "tenant_76a4b2";
const id: string = "template_9f3c1e";
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: "Comment Flag Notification",
  subject: "A comment was flagged on your-site.com",
  bodyHtml: "<p>Admin,</p><p>User {{commenterName}} flagged a comment: “{{commentText}}”</p>",
  isEnabled: true,
  description: "Email sent to moderators when a comment is flagged (optional field included)"
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Parametreler

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

Yanıt

Döndürür: GetEventLog200Response

Örnek

getEventLog Örneği

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // isteğe bağlı üst akış değeri
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  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	Evet

Yanıt

Döndürür: GetEventLog200Response

Örnek

getGlobalEventLog Örneği

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 gün önce
const endTimeOptional: number | undefined = undefined; // isteğe bağlı zaman aralığı sonu
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
createFeedPostParams	CreateFeedPostParams	Evet
broadcastId	string	Hayır
isLive	boolean	Hayır
doSpamCheck	boolean	Hayır
skipDupCheck	boolean	Hayır

Yanıt

Döndürür: CreateFeedPost200Response

Örnek

createFeedPost Örneği

Copy

const tenantId: string = "tenant_7f3b9a";
const createFeedPostParams: CreateFeedPostParams = {
  title: "Weekly Product Update — March 2026",
  body: "We've shipped performance improvements and bug fixes across the web client. See the release notes for details.",
  authorId: "user_86fa2b",
  allowComments: true,
  media: [
    {
      url: "https://cdn.example.com/images/update-march.png",
      mimeType: "image/png",
      caption: "Performance graph",
      assets: [{ url: "https://cdn.example.com/images/update-march@2x.png", width: 1600, height: 900 }]
    }
  ],
  links: [{ url: "https://www.example.com/release-notes/march-2026", title: "Release notes" }]
};
const broadcastId: string = "broadcast_prod_updates_202603";
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: 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

const tenantId: string = "tenant_987654321";
const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };
const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };
const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };
const createFeedPostParams: CreateFeedPostParams = {
  title: "Product update — March 2026",
  content: "<p>We shipped performance improvements and two new integrations.</p>",
  media: [mediaItem],
  link,
  visibility: "public",
  tags: ["product","release","march-2026"],
  customConfig: { allowComments: true, requireTOS: false }
};
const broadcastId: string = "broadcast_2026_03_25_live";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

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 = "tenant_5f8a9b3c";
const postId: string = "post_a1b2c3d4";
const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

getFeedPosts

req tenantId afterId

Parametreler

Ad	Tür	Gerekli
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 initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);
const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

getFeedPostsPublic

req tenantId afterId

Parametreler

İsim	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

const tenantId: string = 'tenant_acme_01';
const afterId: string = 'fp_20260301_042';
const limit: number = 25;
const tags: Array<string> = ['technology', 'announcement'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

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_9b2f1c4a';
const postIds: Array<string> = [
  '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',
  'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'
];
const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

getUserReactsPublic

Parametreler

Name	Type	Required
tenantId	string	Yes
postIds	Array	No
sso	string	No

Yanıt

Döndürür: GetUserReactsPublic200Response

Örnek

getUserReactsPublic Örneği

Copy

const tenantId: string = "acme-tenant-8a4d2c";
const postIds: string[] = ["post-645a2f", "post-645a30"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

reactFeedPostPublic

Parametreler

Name	Type	Required
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 = 'd290f1ee-6c54-4b01-90e6-d701748f0851';
const postId: string = 'c1a2b3d4-5678-90ab-cdef-1234567890ab';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍', source: 'web' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast-2026-03-25-001';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const result: 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önüş Değeri: FlagCommentPublic200Response

Örnek

updateFeedPost Örneği

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // isteğe bağlı dizi dahil edildi
  links: [link],          // isteğe bağlı bağlantılar dahil edildi
  isPublished: true       // burada kullanılan isteğe bağlı yayınlama bayrağı
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

updateFeedPostPublic

Parametreler

Name	Type	Required
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_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
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 Örneği

Copy

const tenantId: string = "tenant_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

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 = 'tenant_acme_01';
const createHashTagBody: CreateHashTagBody = {
  name: 'feature-request',
  label: 'Feature Request',
  color: '#FF5722',
  enabled: true
};
const response: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);
const responseWithoutTenant: AddHashTag200Response = await addHashTag(undefined, createHashTagBody);

addHashTagsBulk

Parametreler

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

Yanıt

Döndürür: AddHashTagsBulk200Response

Örnek

addHashTagsBulk Örneği

Copy

// Kiracı tanımlayıcısı oluştur (isteğe bağlı parametre)
const tenantId: string = "tenant_9f8c2b7a";
// Bireysel etiket girdilerini hazırla
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Toplu oluşturma gövdesi (isteğe bağlı parametre)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Global eşzamansız fonksiyonu çağır ve tiplenmiş sonucu ata
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, 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_12345";
const deleteRequest: DeleteHashTagRequest = { initiatedBy: "moderator@newsorg.com", purgeAllOccurrences: true };
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteRequest);

getHashTags

Parametreler

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

Yanıt

Döndürür: GetHashTags200Response

Örnek

getHashTags Örneği

Copy

const tenantId: string = 'acme-tenant-42';
const pageNumber: number = 2;
const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);
const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

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-ux-refresh";
const tenantId: string = "tenant_4f92c1";
const updateHashTagBody: UpdateHashTagBody = {
  label: "UX Refresh",
  description: "Track comments related to the 2026 UX redesign",
  isActive: true,
  metadata: { owner: "product-design", rolloutPhase: "phase-2" }
};
const response: 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_7d9f2b4a';
const customConfig: CustomConfigParameters = { timezone: 'UTC', moderationQueueEnabled: true };
const createModeratorBody: CreateModeratorBody = {
  email: 'jane.martin@publisher.com',
  displayName: 'Jane Martin',
  roles: ['moderator'],
  sendWelcomeEmail: true,
  customConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Parametreler

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

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteModerator Örneği

Copy

const tenantId: string = 'tenant_9f3b2d4a6c';
const moderatorId: string = 'moderator_84a1b9c2';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

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-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

getModerators

Parametreler

Ad	Type	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-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

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

const tenantId: string = 'tenant_acme-42';
const id: string = 'comment_8f3b21a7';
const fromName: string = 'Elena Morales';
const replyToEmail: string | undefined = undefined;
const result: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName, replyToEmail);

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-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // isteğe bağlı alan örneği
};
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 tenantSuffix: string | undefined = undefined;
const tenantId: string = tenantSuffix ? `tenant-${tenantSuffix}` : 'tenant-9142a7';
const id: string = '3f9b2a44-1c2e-4d3b-9f6a-8e7c6d5b2a1f';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

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 = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // isteğe bağlı parametre bayrağı (örnek olarak gösterildi)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

getNotificationCount

Parametreler

Name	Type	Required
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öndürür: GetNotificationCount200Response

Örnek

getNotificationCount Örneği

Copy

const tenantId: string = 'tenant_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, viewed, type);

getNotifications

Parametreler

İsim	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
skip	number	Hayır

Yanıt

Döndürür: GetNotifications200Response

Örnek

getNotifications Örneği

Copy

const tenantId: string = "tenant_84b3f2";
const userId: string = "user_1279";
const urlId: string = "https://www.example.com/articles/2026/03/25/new-feature";
const fromCommentId: string = "cmt_5421";
const viewed: boolean = false;
const type: string = "mention";
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_prod_8f4b2c';
const id: string = 'notification_61a2e9';
const userId: string = 'moderator_107';
const updateNotificationBody: UpdateNotificationBody = {
  name: 'Flagged Comment Notification',
  enabled: true,
  channels: ['email', 'inbox'],
  templateId: 'tmpl_mod_alerts_01',
  severity: 'high'
};
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

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

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

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

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // isteğe bağlı parametre örneği (fonksiyon tarafından gerekli değildir)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

getPendingWebhookEventCount

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

Yanıt

Döndürür: GetPendingWebhookEventCount200Response

Örnek

getPendingWebhookEventCount Örneği

Copy

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT
);

getPendingWebhookEvents

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
skip	number	Hayır

Yanıt

Döndürür: GetPendingWebhookEvents200Response

Örnek

getPendingWebhookEvents Örneği

Copy

const tenantId: string = 'tenant_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
createQuestionConfigBody	CreateQuestionConfigBody	Evet

Yanıt

Döndürür: CreateQuestionConfig200Response

Örnek

createQuestionConfig Örneği

Copy

const tenantId: string = "tenant_9f8b2c";
const option: QuestionConfigCustomOptionsInner = { id: "opt_yes", label: "Yes, helpful", value: "yes" };
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Article usefulness",
  prompt: "Was this article helpful?",
  type: "singleChoice",
  required: false, // isteğe bağlı parametre gösterildi
  options: [option],
  saveBehavior: "immediate"
};
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-enterprises-01";
const idOptional: string | undefined = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const id: string = idOptional ?? "11111111-1111-1111-1111-111111111111";
const response: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

getQuestionConfig

Parametreler

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

Yanıt

Döndürür: GetQuestionConfig200Response

Örnek

getQuestionConfig Örneği

Copy

const tenantId: string = 'acme-tenant-92';
const id: string = 'question-2026-07-42';
const response: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
function summarize(cfg: GetQuestionConfig200Response, includeDetails?: boolean): string {
  return includeDetails ? 'Question config (detailed)' : 'Question config (summary)';
}
const summary: string = summarize(response);

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_acme_9876";
const configsWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const configsWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 20);

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_42e8b';
const id: string = 'question_9f4a2';
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  questionText: 'How helpful was this article?',
  description: 'Shown to users below the question (optional)',
  required: true,
  renderingType: 'Likert' as QuestionRenderingType,
  customOptions: [
    { label: 'Very helpful', value: '5' } as QuestionConfigCustomOptionsInner,
    { label: 'Somewhat helpful', value: '3' } as QuestionConfigCustomOptionsInner,
    { label: 'Not helpful', value: '1' } as QuestionConfigCustomOptionsInner
  ],
  whenSave: 'notify' as QuestionWhenSave
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
createQuestionResultBody	CreateQuestionResultBody	Evet

Yanıt

Döndürür: CreateQuestionResult200Response

Örnek

createQuestionResult Örneği

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // isteğe bağlı meta verisi
  note: "Follow-up requested" // gösterilen isteğe bağlı parametre
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

deleteQuestionResult

Parametreler

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

Yanıt

Dönüş Değeri: FlagCommentPublic200Response

Örnek

deleteQuestionResult Örneği

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // alternatif hedef seçimini gösteren isteğe bağlı parametre
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

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 post: { title: string; questionId?: string } = { title: 'Product feedback' };
const tenantId: string = 'acme-corp-tenant-01';
const id: string = post.questionId ?? 'q-8f3a7b2c4d9e';
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);

getQuestionResults

Parametreler

Name	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 = "tenant_acme_001";
const urlId: string = "articles/product-launch-2026";
const userId: string = "user_2048";
const startDate: string = "2026-03-01T00:00:00Z";
const questionId: string | undefined = undefined;
const questionIds: string | undefined = "q_101,q_102";
const skip: number | undefined = 0;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

updateQuestionResult

Parametreler

Ad	Tür	Gerekli
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_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // isteğe bağlı meta veri
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parametreler

Ad	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_acme_98765';
const questionIds: Array<string> = ['q-102', 'q-103'];
const urlId: string = 'url_55b3';
const timeBucket: AggregateTimeBucket = { unit: 'day', size: 7 };
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined, // questionId atlandı, bunun yerine questionIds kullanılıyor
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

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_live_7c9d";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    { questionId: "q_feedback_rating", includeSubQuestions: false, filters: { locale: "en-US" } }
  ],
  timeBuckets: [
    { granularity: "day", startUtc: "2026-03-01T00:00:00Z", endUtc: "2026-03-15T00:00:00Z" }
  ]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

combineCommentsWithQuestionResults

Parametreler

Ad	Tür	Gerekli
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_9f3a2';
const questionIds: string[] = ['question-42', 'question-43'];
const urlId: string = 'url_5d7b';
const startDate: Date = new Date('2026-02-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  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

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-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "u_987654",
  planId: "pro_monthly",
  startDate: new Date().toISOString(),
  trialDays: 14, // isteğe bağlı parametre örneği
  metadata: { source: "marketing-email" } // isteğe bağlı parametre örneği
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);
const subscription: APIUserSubscription = result.subscription;

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 = 'tenant_acme_corp_01';
const userId: string = 'user_76a3b9f2';
const subscriptionsForUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
const subscriptionsForTenant: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);

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_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

createTenantPackage

Parametreler

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

Yanıt

Döndürür: CreateTenantPackage200Response

Örnek

createTenantPackage Örneği

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // isteğe bağlı parametre sağlandı
  // isteğe bağlı alanlar dahil edilmedi: örn., gelişmiş moderasyon kuralları, özel CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // örnek değer; CustomConfigParameters yapısını kullanır
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

deleteTenantPackage

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

deleteTenantPackage Örneği

Copy

const tenantId: string = 'tenant_acme_corp_987';
const packageId: string = 'pkg_pro_2026_01';
type DeleteOptions = { force?: boolean; notify?: boolean };
const options: DeleteOptions = { force: true }; // optional parameters demonstrated
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_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parametreler

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

Yanıt

Döndürür: GetTenantPackages200Response

Örnek

getTenantPackages Örneği

Copy

const tenantId: string = "tenant_7f8e3b4c";
const skip: number = 20;
const packagesDefault: GetTenantPackages200Response = await getTenantPackages(tenantId);
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

replaceTenantPackage

Parameters

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

Response

Döndürür: FlagCommentPublic200Response

Example

replaceTenantPackage Örneği

Copy

const tenantId: string = "tenant-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
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_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // isteğe bağlı alanlar kasıtlı olarak atlanmıştır (ör. description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parametreler

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

Yanıt

Döndürür: CreateTenantUser200Response

Örnek

createTenantUser Örneği

Copy

const tenantId: string = 'tenant_6f4b2c';
const createTenantUserBody: CreateTenantUserBody = {
  email: 'sara.kim@example.com',
  displayName: 'Sara Kim',
  role: 'moderator',
  notifyOnMentions: true
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

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 = '4f3a9b2e-1c6a-4f7b-9e2a-0b8d6f1c2a3e';
const userId: string = '9d2f7b3a-5c4e-48a2-b1f0-6c7d8e9f0a12';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'permanent';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, userId, deleteComments, commentDeleteMode);

getTenantUser

Parametreler

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

Yanıt

Döndürür: GetTenantUser200Response

Örnek

getTenantUser Örneği

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // yük (payload) erişimi
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

getTenantUsers

Parametreler

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Yanıt

Döndürür: GetTenantUsers200Response

Örnek

getTenantUsers Örneği

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

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 = 'tenant_9d8f4b2c';
const id: string = 'user_f47ac10b';
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: 'ext-5234',
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  metadata: { department: 'product', region: 'us-east-1' }
};
const updateComments: string = 'propagate-display-name-to-comments';
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parametreler

Ad	Tür	Gerekli
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_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

updateTenantUser

Parametreler

Ad	Tür	Gerekli
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 = "tenant_8f3b2a9d";
const id: string = "user_52c9f1ab";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  isActive: true,
  metadata: { signupSource: "sso", locale: "en-US" }
};
const updateComments: string = "Promoted to moderator and updated display name";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, 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-corp-001";
const createTenantBody: CreateTenantBody = {
  name: "Acme Corporation",
  domain: "comments.acme.com",
  adminContact: { name: "Jane Doe", email: "jane.doe@acme.com" },
  billingInfo: { planId: "pro-monthly", billingContactEmail: "billing@acme.com" },
  importedSite: { siteId: "site-123", siteName: "Acme Blog" } // isteğe bağlı içe aktarılan site
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

deleteTenant

Parametreler

Ad	Tip	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_7f3d2c";
const id: string = "flag_8392b1a7";
const sure: string = "confirmed";
const responseWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id);
const responseWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

getTenant

Parametreler

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

Yanıt

Döndürür: GetTenant200Response

Örnek

getTenant Örneği

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // isteğe bağlı geçersiz kılma, mevcutsa
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

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 = 'tenant_8421e7';
const meta: string = 'include=domains,billing,customConfig';
const skip: number = 20;
const tenantsBasic: GetTenants200Response = await getTenants(tenantId);
const tenantsWithOptions: GetTenants200Response = await getTenants(tenantId, meta, skip);

updateTenant

Parametreler

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

Yanıt

Döndürür: FlagCommentPublic200Response

Örnek

updateTenant Örneği

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // isteğe bağlı, mevcut faturalamayı korumak için dışarı bırakın
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parametreler

Ad	Tür	Zorunlu
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_82f9b3';
const userId: string = 'user_9472';
const id: string = 'ticket_550e8400-e29b-41d4-a716-446655440000';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'resolved',
  comment: 'Confirmed fix deployed to production; closing ticket.',
  notifySubscribers: true
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

createTicket

Parametreler

Name	Type	Required
tenantId	string	Evet
userId	string	Evet
createTicketBody	CreateTicketBody	Evet

Response

Döndürür: CreateTicket200Response

Örnek

createTicket Örneği

Copy

const tenantId: string = "acme-corp-001";
const userId: string = "user_72b9f4";
const createTicketBody: CreateTicketBody = {
  subject: "Subscription renewal failed for card on file",
  description: "Customer's card was declined by the payment processor during automatic renewal. Transaction ID: txn_9a8b7c. Please review gateway logs and retry.",
  priority: "high", // isteğe bağlı alan örneği
  contactEmail: "billing@acme-corp.com", // isteğe bağlı iletişim bilgisi
  relatedUrl: "https://acme-corp.com/account/billing"
};
const ticketResponse: 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-tenant-01';
const ticketId: string = 'tkt-20260325-42';
const userId: string = 'user-8452';
const ticketResponseWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketResponseWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);

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_92f3b4c1";
const userId: string = "user_742a9f3e";
const state: number = 1;
const skip: number = 0;
const limit: number = 25;
const ticketsFull: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);
const ticketsMinimal: GetTickets200Response = await getTickets("tenant_92f3b4c1");

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

Ad	Tip	Gerekli	Açıklama
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetUserBadgeProgressById200Response

Örnek

getUserBadgeProgressById Örneği

Copy

const optionalTenantSuffix: string | undefined = undefined;
const tenantId: string = `5f8d0d55-1234-4ab1-9e2a-3f2b5c6d7e8f${optionalTenantSuffix ?? ''}`;
const id: string = '3a2b1c4d-5678-4ef0-9abc-def123456789';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

getUserBadgeProgressByUserId

Parametreler

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

Yanıt

Döndürür: GetUserBadgeProgressById200Response

Örnek

getUserBadgeProgressByUserId Örneği

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // isteğe bağlı kaynak (undefined olabilir)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

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

(async () => {
  const tenantId: string = 'tenant_4f8c2b9d';
  const userId: string = 'user_9a7e215c';
  const limit: number = 25;
  const skip: number = 0;
  const resultMinimal: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);
  const resultFull: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  console.log(resultMinimal, resultFull);
})();

createUserBadge

Parametreler

Name	Type	Required	Description
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

Yanıt

Döndürür: CreateUserBadge200Response

Örnek

createUserBadge Örneği

Copy

const tenantId: string = 'tenant_84f3b2';
const createUserBadgeParams: CreateUserBadgeParams = {
  name: 'Top Contributor',
  slug: 'top-contributor',
  imageUrl: 'https://assets.fastcomments.com/badges/top-contributor.png',
  description: 'Awarded for 100 helpful comments',
  active: true,
  criteria: { commentsCount: 100 }, // isteğe bağlı kriterler
  displayOrder: 10,
  metadata: { featured: true } // isteğe bağlı meta veriler
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);
console.log(result);

deleteUserBadge

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: UpdateUserBadge200Response

Örnek

deleteUserBadge Örneği

Copy

type DeleteOptions = { notifyModerators?: boolean };
const tenantId: string = 'tenant_8a3f21';
const id: string = 'badge_71f2b';
const options: DeleteOptions = { notifyModerators: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

getUserBadge

Parametreler

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

Yanıt

Döndürür: GetUserBadge200Response

Örnek

getUserBadge Örneği

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "badge_8c7d2f";
const response: GetUserBadge200Response = await getUserBadge(tenantId, id);

getUserBadges

Parametreler

Adı	Tip	Zorunlu
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öndürür: GetUserBadges200Response

Örnek

getUserBadges Örneği

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_5f4d3c2a';
const badgeId: string = 'badge_top_contributor';
const type: number = 1;
const displayedOnComments: boolean = true;
const limit: number = 50;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

updateUserBadge

Parametreler

Ad	Tip	Gerekli
tenantId	string	Evet
id	string	Evet
updateUserBadgeParams	UpdateUserBadgeParams	Evet

Yanıt

Döndürür: UpdateUserBadge200Response

Örnek

updateUserBadge Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_acme_987';
  const id: string = 'badge_top_contributor_42';
  const updateUserBadgeParams: UpdateUserBadgeParams = {
    title: 'Top Contributor',
    description: 'Awarded for reaching 100 high-quality comments',
    color: '#FFD700',
    iconUrl: 'https://cdn.acme.com/badges/top-contributor.svg',
    active: true,
    notifyUsers: true
  } as UpdateUserBadgeParams;
  const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);
  console.log(result);
})();

getUserNotificationCount

Parametreler

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

Yanıt

Döndürür: GetUserNotificationCount200Response

Örnek

getUserNotificationCount Örneği

Copy

(async () => {
  const tenantId: string = '9f1e2d3c-4b5a-6d7e-8f90-123456789abc';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
  console.log(resultWithSSO, resultWithoutSSO);
})();

getUserNotifications

Parametreler

Name	Type	Required
tenantId	string	Evet
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
sso	string	Hayır

Yanıt

Döndürür: GetUserNotifications200Response

Örnek

getUserNotifications Örneği

Copy

const tenantId: string = 'tenant_7f3b1c';
const pageSize: number = 25;
const afterId: string = 'notif_b2f9e4';
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const sso: string = 'sso_tok_user_9f8d7c';
const response: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  sso
);

resetUserNotificationCount

Parametreler

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

Yanıt

Döndürür: ResetUserNotifications200Response

Örnek

resetUserNotificationCount Örneği

Copy

(async () => {
  const tenantId: string = "tenant_9f3b2c4a";
  const ssoToken: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9._sample_payload_.signature";
  const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSSO, responseWithoutSSO);
})();

resetUserNotifications

Parametreler

Ad	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_prod_4a9f12";
const afterId: string = "notification_87213";
const afterCreatedAt: number = Math.floor(Date.now() / 1000) - 3600;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload";
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, undefined, sso);

updateUserNotificationCommentSubscriptionStatus

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

Parametreler

Ad	Tür	Gerekli
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 = 'acme-tenant-001';
const notificationId: string = 'notif-2026-03-25-01';
const commentId: string = 'cmt-8f3a2b';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-payload.signature';
const result: 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 root yorumlar için bildirimler oluşturulur ve ayrıca

Parametreler

Ad	Tür	Zorunlu
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 = 'acme-tenant-42';
const urlId: string = 'blog-launch-2026';
const url: string = 'https://acme.example.com/blog/launch-march-2026';
const pageTitle: string = 'Acme Product Launch — March 2026';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: 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_84a2c3';
const notificationId: string = 'notif_20260325_01';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_signature_example';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

getUserPresenceStatuses

Parametreler

Name	Type	Zorunlu
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_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // isteğe bağlı kaynak
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

searchUsers

Parametreler

Name	Type	Required
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_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: 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 = 'tenant_7b3f42';
const id: string = 'user_9c4d2a';
const userResponse: GetUser200Response = await getUser(tenantId, id);
console.log(userResponse);

createVote

Parametreler

Name	Type	Required
tenantId	string	Evet
commentId	string	Evet
direction	CreateVoteDirectionEnum	Evet
userId	string	Hayır
anonUserId	string	Hayır

Yanıt

Döndürür: VoteComment200Response

Örnek

createVote Örneği

Copy

const tenantId: string = 'tenant_9f8b6a';
const commentId: string = 'comment_3b7d2e';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_4c2a1f';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

deleteVote

Parametreler

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

Yanıt

Döndürür: DeleteCommentVote200Response

Örnek

deleteVote Örneği

Copy

const tenantId: string = "tenant_7c3f2b4a";
const voteId: string = "vote_4f8d9a11";
const editKey: string = "edit_2b9f8c";
const resultWithoutKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId);
const resultWithKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId, editKey);

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 = 'acme-corp-8f3b';
const refCampaign: string | undefined = 'newsletter-march2026'; // isteğe bağlı sorgu parametresi
const urlId: string = `https://www.example.com/articles/2026/03/25/fastcomments-integration${refCampaign ? `?ref=${refCampaign}` : ''}`;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

getVotesForUser

Parametreler

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

Yanıt

Döndürür: GetVotesForUser200Response

Örnek

getVotesForUser Örneği

Copy

(async (): Promise<void> => {
  const tenantId: string = "local-news-ny";
  const urlId: string = "articles/2026-03-25/ev-infrastructure-update";
  const userId: string = "user_78b6f3d9";
  const anonUserId: string = "anon_9c3f7a1b";
  const result: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);
  console.log(result);
})();

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

Engellenmiş Yorumları Kontrol Et

Yorumlar

Etki Alanı Yapılandırmaları

E-posta Şablonları

Olay Kaydı

Akış Gönderileri

Yorumu İşaretle

Hashtag'ler

Moderatörler

Bildirim Sayısı

Bildirimler

Sayfalar

Bekleyen Webhook Olayları

Soru Yapılandırmaları

Soru Sonuçları

Soru Sonuçları Toplama

SSO Kullanıcıları

Abonelikler

Kiracı Günlük Kullanımı

Kiracı Paketleri

Kiracı Kullanıcıları

Kiracılar

Destek Talepleri

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ı ve 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ı

Açık ve 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 (Tek 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

Yanıt

getAuditLogs

Parametreler

Yanıt

Örnek

blockFromCommentPublic

Parametreler