FastComments JavaScript/TypeScript SDK

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

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

Depo

Kurulum

npm install fastcomments-sdk

API Dokümantasyonu

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

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

Genel ve Güvenli API'ler

SDK şu API sınıflarını sağlar:

DefaultApi - Kimlik doğrulama için API anahtarınızı gerektiren güvenli uç noktalar. Sunucu tarafı işlemler için bunları kullanın.
PublicApi - API anahtarı olmadan erişilebilen genel uç noktalar. Bunlar doğrudan tarayıcılardan/mobil cihazlardan/vb. çağrılabilir.
ModerationApi - Moderatör paneli uç noktaları (yorum moderasyonu, yasaklar, rozetler, güven faktörü, arama). Moderatörün oturumu ile yetkilendirilir; SSO ile yetkilendirilmiş moderatörler için sso sorgu parametresini geçin.
HiddenApi - Gelişmiş kullanım durumları için dahili/admin uç noktaları.

Örnek: Public API Kullanımı (tarayıcıda güvenli)

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

const publicApi = new PublicApi();

// Bir sayfa için yorumları al (API anahtarı gerekmez)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Örnek: Default API Kullanımı (sadece 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'
});

Örnek: Moderation API Kullanımı

import { createFastCommentsSDK } from 'fastcomments-sdk/server';

const sdk = createFastCommentsSDK({ /* basePath, vb. */ });

// Moderatör kimliğiyle yetkilendirilmiş çağrılar (oturum çerezi, veya SSO moderatörü için `sso`'yu geçin).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

await sdk.moderationApi.postSetCommentSpamStatus({
  commentId: 'comment-id',
  spam: true
});

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

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ı Olaylar (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

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

Yanıt

Döndürür: AggregateResponse

Örnek

aggregate Örneği

Copy

const tenantId: string = "tenant-12345";
const aggregationRequest: AggregationRequest = {
  predicates: [
    {
      field: "status",
      operator: "eq",
      value: { type: "string", value: "approved" }
    }
  ],
  operations: [
    { type: "count", field: "commentId" }
  ],
  sort: { field: "createdAt", direction: "desc" }
};
const parentTenantId: string = "parent-001";
const includeStats: boolean = true;
const result: AggregateResponse = await aggregate(
  tenantId,
  aggregationRequest,
  parentTenantId,
  includeStats
);

getAuditLogs

Parametreler

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

Örnek

getAuditLogs Örneği

Copy

(async () => {
  const tenantId: string = "tenant_42";
  const limit: number = 100;
  const skip: number = 10;
  const order: SORTDIR = "desc";
  const after: number = Date.now() - 3 * 24 * 60 * 60 * 1000; // 3 gün önce
  const auditResponse: GetAuditLogsResponse1 = await getAuditLogs(
    tenantId,
    limit,
    skip,
    order,
    after
  );
  console.log(auditResponse);
})();

blockFromCommentPublic

Parametreler

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

Yanıt

Returns: BlockFromCommentPublicResponse

Örnek

blockFromCommentPublic Örneği

Copy

async function demo() {
  const tenantId: string = "tenant_9f8b7c";
  const commentId: string = "cmt_1234567890";
  const blockParams: PublicBlockFromCommentParams = {
    reason: "spam",
    durationHours: 24,
  };
  const ssoToken: string = "sso_ABCDEF123456";
  const responseWithSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams,
    ssoToken
  );
  const responseWithoutSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams
  );
  console.log(responseWithSso, responseWithoutSso);
}
demo();

unBlockCommentPublic

Parametreler

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

Yanıt

Döndürür: UnBlockCommentPublicResponse

Örnek

unBlockCommentPublic Örneği

Copy

const tenantId: string = "acme-corp-tenant";
const commentId: string = "cmt-20230915-001";
const unblockParams: PublicBlockFromCommentParams = {
  reason: "User appealed and was cleared",
  unblockExpiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString()
};
const ssoToken: string = "sso-3d9f8a7b";
const result: UnBlockCommentPublicResponse = await unBlockCommentPublic(
  tenantId,
  commentId,
  unblockParams,
  ssoToken
);

checkedCommentsForBlocked

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentIds	string	Yes
sso	string	No

Yanıt

Döndürür: CheckedCommentsForBlockedResponse

Örnek

checkedCommentsForBlocked Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const commentIds: string = "cmt_001,cmt_002";
  const ssoToken: string = "ssoTokenXYZ";
  const blockedCheck: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds);
  const blockedCheckWithSso: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);
})();

blockUserFromComment

Parametreler

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

Yanıt

Döndürür: BlockUserFromCommentResponse

Örnek

blockUserFromComment Örneği

Copy

const tenantId: string = 'tenant_42';
const commentId: string = 'cmt_20231101';
const blockParams: BlockFromCommentParams = {
  reason: 'spam',
  blockDurationHours: 24,
};
const userId: string = 'user_123'; // isteğe bağlı parametre
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

createCommentPublic

Parametreler

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

Yanıt

Döndürür: CreateCommentPublicResponse

Örnek

createCommentPublic Örneği

Copy

(async () => {
  const tenantId: string = "tenant-abc123";
  const urlId: string = "post-987654";
  const broadcastId: string = "bcast-001";
  const commentData: CommentData = {
    content: "I really enjoyed this article!"
  };
  const sessionId: string = "session-xyz789";
  const sso: string = "sso-token-456def";
  const response: CreateCommentPublicResponse = await createCommentPublic(
    tenantId,
    urlId,
    broadcastId,
    commentData,
    sessionId,
    sso
  );
  console.log(response);
})();

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

Örnek

deleteComment Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_01';
  const commentId: string = 'comment_abc123';
  const contextUserId: string = 'user_42';
  const isLive: boolean = false;
  const deleteResult: DeleteCommentResponse = await deleteComment(tenantId, commentId, contextUserId, isLive);
  const simpleResult: DeleteCommentResponse = await deleteComment(tenantId, commentId);
})();

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

Örnek

deleteCommentPublic Örneği

Copy

(async () => {
  const tenantId: string = 'c6f9a2e3-9b1d-4f8a-b2d2-1a2b3c4d5e6f';
  const commentId: string = '7d9f0b1c-2e3f-4a5b-6c7d-8e9f0a1b2c3d';
  const broadcastId: string = 'live-2023-09-15';
  const editKey: string = 'ed1tK3y1234567890';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123';
  const result: DeleteCommentPublicResponse = await deleteCommentPublic(
    tenantId,
    commentId,
    broadcastId,
    editKey,
    sso
  );
})();

deleteCommentVote

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
voteId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Yanıt

Döndürür: DeleteCommentVoteResponse

Örnek

deleteCommentVote Örneği

Copy

async function removeVote() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const voteId: string = "vote_abcde";
  const urlId: string = "url_56789";
  const broadcastId: string = "brd_001";
  const editKey: string = "edit_456";
  // sso isteğe bağlıdır ve atlanmıştır
  const response: DeleteCommentVoteResponse = await deleteCommentVote(
    tenantId,
    commentId,
    voteId,
    urlId,
    broadcastId,
    editKey
  );
  console.log(response);
}
removeVote();

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

Örnek

flagComment Örneği

Copy

(async () => {
  const tenantId: string = "tenant_2023";
  const commentId: string = "comment_5678";
  const userId: string = "user_1234";
  const anonUserId: string = "anon_4321";
  const result: FlagCommentResponse1 = await flagComment(tenantId, commentId, userId);
  const anonResult: FlagCommentResponse1 = await flagComment(tenantId, commentId, undefined, anonUserId);
})();

getComment

Parametreler

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

Yanıt

Döndürür: GetCommentResponse

Örnek

getComment Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-987654";
  const result: GetCommentResponse = await getComment(tenantId, commentId);
  const badgeInfo: CommentUserBadgeInfo | undefined = result.comment?.user?.badgeInfo;
  console.log(badgeInfo?.label);
})();

getComments

Parametreler

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

Yanıt

Returns: GetCommentsResponse

Örnek

getComments Örneği

Copy

const tenantId: string = "tenant_12345";
const page: number = 2;
const limit: number = 50;
const asTree: boolean = true;
const urlId: string = "article_5678";
const direction: SortDirections = "desc";
const fromDate: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // bir hafta önce
const toDate: number = Date.now();
const commentsResponse: GetCommentsResponse = await getComments({
  tenantId,
  page,
  limit,
  asTree,
  urlId,
  direction,
  fromDate,
  toDate,
});

getCommentsPublic

req tenantId urlId

Parametreler

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

Yanıt

Döndürür: GetCommentsPublicResponse

Örnek

getCommentsPublic Örneği

Copy

async function fetchComments() {
  const tenantId: string = 'acme-corp';
  const urlId: string = 'blog/post-789';
  const page: number = 1;
  const direction: SortDirections = SortDirections.Desc;
  const limit: number = 25;
  const includeConfig: boolean = true;
  const locale: string = 'en-GB';
  const modules: string = 'reactions,attachments';
  const isCrawler: boolean = false;
  const includeNotificationCount: boolean = true;
  const asTree: boolean = true;
  const maxTreeDepth: number = 4;
  const searchText: string = 'TypeScript';
  const hashTags: string[] = ['typescript', 'api'];
  const response: GetCommentsPublicResponse = await getCommentsPublic(
    tenantId,
    urlId,
    page,
    direction,
    undefined,
    undefined,
    undefined,
    limit,
    undefined,
    undefined,
    undefined,
    includeConfig,
    undefined,
    undefined,
    locale,
    modules,
    isCrawler,
    includeNotificationCount,
    asTree,
    maxTreeDepth,
    undefined,
    undefined,
    searchText,
    hashTags,
    undefined,
    undefined,
    undefined,
    undefined
  );
}

getCommentText

Parametreler

İsim	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
editKey	string	No
sso	string	No

Yanıt

Döndürür: GetCommentTextResponse1

Örnek

getCommentText Örneği

Copy

async function run() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt-5f2e9a1b";
  const editKey: string = "edk-9b7c3";
  const ssoToken: string = "sso-xyz789";
  const commentOnly: GetCommentTextResponse1 = await getCommentText(tenantId, commentId);
  const commentWithEdit: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey);
  const commentFull: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey, ssoToken);
}
run();

getCommentVoteUserNames

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

Yanıt

Döndürür: GetCommentVoteUserNamesResponse

Örnek

getCommentVoteUserNames Örneği

Copy

async function demoGetCommentVoteUserNames() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_5f2a1e3b";
  const dir: number = 1; // artan
  const votesWithoutSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir
  );
  const ssoToken: string = "sso_abcdef123456";
  const votesWithSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir,
    ssoToken
  );
  console.log(votesWithoutSSO, votesWithSSO);
}

lockComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Yanıt

Döndürür: LockCommentResponse

Örnek

lockComment Örneği

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  // Opsiyonel SSO token ile
  const ssoToken: string = "user-abc123";
  const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  // SSO token olmadan
  const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);
})();

pinComment

Parametreler

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

Yanıt

Döndürür: PinCommentResponse

Örnek

pinComment Örneği

Copy

(async () => {
  const tenantId: string = 'tenant-001';
  const commentId: string = 'comment-5678';
  const broadcastId: string = 'broadcast-2023';
  const ssoToken: string = 'sso-xyz-789';
  const pinResult: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId);
  const pinResultWithSso: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId, ssoToken);
})();

saveComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
createCommentParams	CreateCommentParams	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Yanıt

Döndürür: SaveCommentResponse

Örnek

saveComment Örneği

Copy

async function submitComment() {
  const tenantId: string = "tenant_9f8e7d6c";
  const commentParams: CreateCommentParams = {
    text: "Great post, thanks for sharing!",
    authorId: "user_123abc",
    mentions: [] as CommentUserMentionInfo[],
    hashtags: [] as CommentUserHashTagInfo[]
  };
  const response: SaveCommentResponse = await saveComment(
    tenantId,
    commentParams,
    true,   // isLive
    false   // doSpamCheck
  );
  console.log(response);
}
submitComment();

saveCommentsBulk

Parametreler

İsim	Tür	Gerekli
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Yanıt

Döndürür: Array<SaveCommentsBulkResponse

Örnek

saveCommentsBulk Örneği

Copy

const tenantId: string = "tenant_9f8b7c6d";
const bulkComments: CreateCommentParams[] = [
  {
    content: "Welcome to the new forum thread!",
    authorId: "user_42",
    mentions: [{ userId: "user_84", username: "alice" }],
    hashtags: [{ tag: "intro" }]
  },
  {
    content: "Please review the updated guidelines.",
    authorId: "moderator_1",
    mentions: [],
    hashtags: [{ tag: "guidelines" }, { tag: "update" }]
  }
];
const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(
  tenantId,
  bulkComments,
  true,      // isLive
  false,     // doSpamCheck
  true,      // sendEmails
  undefined  // populateNotifications (using default)
);

setCommentText

Parametreler

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

Örnek

setCommentText Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const commentId: string = 'cmt_98765';
  const broadcastId: string = 'brd_112233';
  const commentTextUpdateRequest: CommentTextUpdateRequest = {
    text: 'Updated comment with @john.doe and #important',
    mentions: [{ userId: 'user_001', username: 'john.doe' }],
    hashtags: [{ tag: 'important' }],
  };
  const editKey: string = 'edit_abc123';
  const result: SetCommentTextResponse1 = await setCommentText(
    tenantId,
    commentId,
    broadcastId,
    commentTextUpdateRequest,
    editKey,
  );
  console.log(result);
})();

unBlockUserFromComment

Parametreler

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

Yanıt

Döndürür: UnBlockUserFromCommentResponse

Örnek

unBlockUserFromComment Örneği

Copy

async function demoUnblock() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt_9f8b7a6d";
  const params: UnBlockFromCommentParams = {
    reason: "User resolved the issue",
    notifyUser: true
  };
  const userId: string = "usr_12345";
  const result: UnBlockUserFromCommentResponse = await unBlockUserFromComment(
    tenantId,
    commentId,
    params,
    userId
    // anonUserId atlandı
  );
  console.log(result);
}
demoUnblock();

unFlagComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Yanıt

Döndürür: UnFlagCommentResponse

Örnek

unFlagComment Örneği

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_123456";
const userId: string = "usr_98765";
const result: UnFlagCommentResponse = await unFlagComment(tenantId, commentId, userId);
const anonCommentId: string = "cmt_123457";
const anonUserId: string = "anon_abc123";
const anonResult: UnFlagCommentResponse = await unFlagComment(tenantId, anonCommentId, undefined, anonUserId);

unLockComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Yanıt

Döndürür: UnLockCommentResponse

Örnek

unLockComment Örneği

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const broadcastId: string = "brd_001";
const ssoToken: string | undefined = "sso_token_abc";
async function run() {
  const unlocked: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
  console.log(unlocked);
  // Opsiyonel sso parametresi olmadan çağırın
  const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);
  console.log(unlockedWithoutSso);
}
run();

unPinComment

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Yanıt

Döndürür: UnPinCommentResponse

Örnek

unPinComment Örneği

Copy

(async () => {
  const tenantId: string = "tenant-001"
  const commentId: string = "comment-123"
  const broadcastId: string = "broadcast-456"
  const sso: string = "sso-token-xyz"
  const resultWithSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId, sso)
  const resultWithoutSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId)
  console.log(resultWithSso, resultWithoutSso)
})()

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

Örnek

updateComment Örneği

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // örnek alanlar; gerçek şekil API tanımına bağlıdır
  // örn., body: "Edited comment content",
};
const contextUserId: string = "user_abcde";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: UpdateCommentResponse = await updateComment(
  tenantId,
  commentId,
  updatableCommentParams,
  contextUserId,
  doSpamCheck,
  isLive
);

voteComment

Parameters

Ad	Tür	Gerekli
tenantId	string	Evet
commentId	string	Evet
urlId	string	Evet
broadcastId	string	Evet
voteBodyParams	VoteBodyParams	Evet
sessionId	string	Hayır
sso	string	Hayır

Response

Döndürür: VoteCommentResponse

Örnek

voteComment Örneği

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_9f8e7d6c";
const urlId: string = "url_123456";
const broadcastId: string = "bcast_2024_01";
const voteBodyParams: VoteBodyParams = {
  vote: "up",               // örnek, "up" | "down"
  weight: 1,                // oyun isteğe bağlı ağırlığı
};
const sessionId: string = "sess_abc123def";
const sso: string = "sso_token_xyz";
const result: VoteCommentResponse = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

getCommentsForUser

Parametreler

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

Yanıt

Döner: GetCommentsForUserResponse1

Örnek

getCommentsForUser Örneği

Copy

async function demo() {
    const userId: string = "user-12345";
    const direction: SortDirections = "desc";
    const page: number = 1;
    const includei10n: boolean = true;
    const locale: string = "en-US";
    const isCrawler: boolean = false;
    const response: GetCommentsForUserResponse1 = await getCommentsForUser(
        userId,
        direction,
        undefined,
        page,
        includei10n,
        locale,
        isCrawler
    );
    console.log(response);
}

addDomainConfig

Parametreler

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

Yanıt

Döndürür: AddDomainConfigResponse

Örnek

addDomainConfig Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // açıklama isteğe bağlıdır ve burada atlanmıştır
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

deleteDomainConfig

Parametreler

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

Yanıt

Döndürür: DeleteDomainConfigResponse

Örnek

deleteDomainConfig Örneği

Copy

async function runExample() {
  const tenantId: string = 'acme-corp';
  const domain: string = 'blog.acme.com';
  const response: DeleteDomainConfigResponse = await deleteDomainConfig(tenantId, domain);
  console.log(response);
}
runExample();

getDomainConfig

Parametreler

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

Yanıt

Döndürür: GetDomainConfigResponse

Örnek

getDomainConfig Örneği

Copy

async function main() {
  const tenantId: string = "acme-corp-123";
  const domain: string = "blog.acme.com";
  const config: GetDomainConfigResponse = await getDomainConfig(tenantId, domain);
  console.log(config);
}
main();

getDomainConfigs

Parametreler

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

Yanıt

Döndürür: GetDomainConfigsResponse

Örnek

getDomainConfigs Örneği

Copy

async function fetchDomainConfigs(): Promise<void> {
  const tenantId: string = "acme-corp-567";
  const configs: GetDomainConfigsResponse = await getDomainConfigs(tenantId);
  console.log(configs);
}

patchDomainConfig

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
domainToUpdate	string	Evet
patchDomainConfigParams	PatchDomainConfigParams	Evet

Yanıt

Döndürür: PatchDomainConfigResponse

Örnek

patchDomainConfig Örneği

Copy

async function updateDomainConfig() {
  const tenantId: string = "tenant_98765";
  const domainToUpdate: string = "forum.mycompany.com";
  const patchParams: PatchDomainConfigParams = {
    enableComments: true,
    moderationLevel: "strict",
    allowAnonymous: false, // gösterilen isteğe bağlı parametre
  };
  const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);
  console.log(response);
}
updateDomainConfig();

putDomainConfig

Parametreler

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

Yanıt

Döndürür: PutDomainConfigResponse

Örnek

putDomainConfig Örneği

Copy

async function runExample() {
  const tenantId: string = 'tenant-9f8c7b1a';
  const domainToUpdate: string = 'comments.mywebsite.org';
  const updateDomainConfigParams: UpdateDomainConfigParams = {
    enableModeration: true,
    // isteğe bağlı alan atlandı, örn., maxCommentLength?: number
  };
  const result: PutDomainConfigResponse = await putDomainConfig(
    tenantId,
    domainToUpdate,
    updateDomainConfigParams,
  );
  console.log(result);
}
runExample();

createEmailTemplate

Parametreler

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

Yanıt

Döndürür: CreateEmailTemplateResponse1

Örnek

createEmailTemplate Örneği

Copy

const tenantId: string = "tenant_9f8e7d6c";
const emailTemplate: CreateEmailTemplateBody = {
  name: "Account Activation",
  subject: "Activate Your New Account",
  htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",
  // textContent ve isActive gibi isteğe bağlı alanlar, opsiyonel parametreleri göstermek için atlanmıştır
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

deleteEmailTemplate

Parametreler

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

Yanıt

Döndürür: DeleteEmailTemplateResponse

Örnek

deleteEmailTemplate Örneği

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // Yanıttan isteğe bağlı bir özelliğe erişme örneği
  const statusCode: number | undefined = response.status?.code;
}();

deleteEmailTemplateRenderError

Parametreler

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

Yanıt

Döndürür: DeleteEmailTemplateRenderErrorResponse

Örnek

deleteEmailTemplateRenderError Örneği

Copy

async function executeDelete() {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_001";
  const errorId: string = "render_err_2023";
  const result: DeleteEmailTemplateRenderErrorResponse = await deleteEmailTemplateRenderError(
    tenantId,
    templateId,
    errorId
  );
  console.log(result);
}
executeDelete();

getEmailTemplate

Parametreler

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

Yanıt

Döndürür: GetEmailTemplateResponse1

Örnek

getEmailTemplate Örneği

Copy

async function fetchTemplate(): Promise<void> {
    const tenantId: string = "tenant-12345";
    const templateId: string = "order-confirmation";
    const response: GetEmailTemplateResponse1 = await getEmailTemplate(tenantId, templateId);
    const emailTemplate: CustomEmailTemplate | undefined = response.customEmailTemplate;
    const configParams: CustomConfigParameters | undefined = response.customConfigParameters;
}

getEmailTemplateDefinitions

Parametreler

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

Yanıt

Returns: GetEmailTemplateDefinitionsResponse1

Örnek

getEmailTemplateDefinitions Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const emailTemplateDefs: GetEmailTemplateDefinitionsResponse1 = await getEmailTemplateDefinitions(tenantId);
  console.log(emailTemplateDefs);
})();

getEmailTemplateRenderErrors

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
id	string	Yes
skip	number	No

Yanıt

Döner: GetEmailTemplateRenderErrorsResponse1

Örnek

getEmailTemplateRenderErrors Örnek

Copy

const tenantId: string = "c2f5a8d9-4b3e-4f6a-9e1b-2d5c6f7a8b9c";
const templateId: string = "welcome-email-template";
const skip: number = 20;
const result: GetEmailTemplateRenderErrorsResponse1 = await getEmailTemplateRenderErrors(
  tenantId,
  templateId,
  skip
);

getEmailTemplates

Parameters

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

Response

Döndürür: GetEmailTemplatesResponse1

Örnek

getEmailTemplates Örneği

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // Opsiyonel 'skip' olmadan çağır
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // Opsiyonel 'skip' parametresiyle çağır
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

renderEmailTemplate

Parametreler

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

Yanıt

Döndürür: RenderEmailTemplateResponse1

Örnek

renderEmailTemplate Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp-01";
  const templateBody: RenderEmailTemplateBody = {
    templateId: "welcome-email",
    placeholders: {
      userName: "John Doe",
      signupDate: "2024-04-01"
    }
  };
  const locale: string = "en-US";
  const result: RenderEmailTemplateResponse1 = await renderEmailTemplate(tenantId, templateBody, locale);
  console.log(result);
})();

updateEmailTemplate

Parametreler

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

Yanıt

Döndürür: UpdateEmailTemplateResponse

Örnek

updateEmailTemplate Örneği

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_67890";
  const updateBody: UpdateEmailTemplateBody = {
    subject: "Comment reply notification",
    htmlContent: "<p>Someone replied to your comment.</p>",
    plainTextContent: "Someone replied to your comment.",
    // isteğe bağlı alan örneği
    isActive: true,
  };
  const result: UpdateEmailTemplateResponse = await updateEmailTemplate(
    tenantId,
    templateId,
    updateBody
  );
  console.log(result);
})();

getEventLog

req tenantId urlId userIdWS

Parametreler

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

Yanıt

Döndürür: GetEventLogResponse1

Örnek

getEventLog Örneği

Copy

(async () => {
    const tenantId: string = "tenant_9876";
    const urlId: string = "page_54321";
    const userIdWS: string = "ws_user_1122";
    const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // bir hafta önce
    const endTime: number = Date.now();
    const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);
})();

getGlobalEventLog

req tenantId urlId userIdWS

Parametreler

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

Yanıt

Döndürür: GetGlobalEventLogResponse

Örnek

getGlobalEventLog Örneği

Copy

(async () => {
  const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
  const urlId: string = 'article-2023-09-15';
  const userIdWS: string = 'ws_987654321';
  const startTime: number = Date.now() - 86400000;
  const endTime: number = Date.now();
  const fullLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
  const recentLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime);
  console.log(fullLog, recentLog);
})();

createFeedPost

Parametreler

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

Yanıt

Döndürür: CreateFeedPostResponse1

Örnek

createFeedPost Örneği

Copy

async function run() {
  const tenantId = "tenant-12345";
  const feedParams: CreateFeedPostParams = {
    text: "New product launch!",
    mediaItems: [{ type: "image", asset: { url: "https://cdn.example.com/img.jpg", width: 800, height: 600 } as FeedPostMediaItemAsset } as FeedPostMediaItem],
    link: { url: "https://example.com/product", title: "Product" } as FeedPostLink
  };
  const result: CreateFeedPostResponse1 = await createFeedPost(tenantId, feedParams, "broadcast-987", true, false, true);
  console.log(result);
}
run();

createFeedPostPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

Yanıt

Döndürür: CreateFeedPostPublicResponse

Örnek

createFeedPostPublic Örneği

Copy

async function submitPost() {
  const tenantId: string = "tenant_12345";
  const mediaItem: FeedPostMediaItem = {
    asset: {
      url: "https://cdn.example.com/image.jpg",
      mimeType: "image/jpeg",
      size: 104857,
    },
    type: "image",
  };
  const link: FeedPostLink = {
    url: "https://example.com/blog/new-feature",
    title: "New Feature Release",
    description: "Details about our latest product update.",
  };
  const createFeedPostParams: CreateFeedPostParams = {
    content: "Check out our new feature!",
    media: [mediaItem],
    link: link,
  };
  const broadcastId: string = "broadcast_9876";
  const sso: string = "sso_token_abc123";
  const response: CreateFeedPostPublicResponse = await createFeedPostPublic(
    tenantId,
    createFeedPostParams,
    broadcastId,
    sso
  );
}

deleteFeedPostPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
postId	string	Yes
broadcastId	string	No
sso	string	No

Yanıt

Döndürür: DeleteFeedPostPublicResponse

Örnek

deleteFeedPostPublic Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const postId: string = "post_987654321";
  const broadcastId: string = "broadcast_2024Q1";
  const sso: string = "sso_4fa3b9c2";
  const response1: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId);
  const response2: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId);
  const response3: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
})();

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

Örnek

getFeedPosts Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const afterId: string = 'post_9876';
  const limit: number = 20;
  const tags: string[] = ['news', 'sports'];
  const feedResult: GetFeedPostsResponse1 = await getFeedPosts(tenantId, afterId, limit, tags);
})();

getFeedPostsPublic

req tenantId afterId

Parametreler

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

Yanıt

Döndürür: GetFeedPostsPublicResponse

Örnek

getFeedPostsPublic Örneği

Copy

async function example() {
  const tenantId: string = "tenant_12345";
  const afterId: string = "post_9876";
  const limit: number = 20;
  const tags: string[] = ["news", "tech"];
  const sso: string = "userToken123";
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublicResponse = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
}
example();

getFeedPostsStats

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
postIds	Array	Yes
sso	string	No

Yanıt

Döndürür: GetFeedPostsStatsResponse

Örnek

getFeedPostsStats Örneği

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
    const ssoToken: string = "sso_abcdef123456";
    const statsWithoutSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds);
    const statsWithSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds, ssoToken);
}
runExample();

getUserReactsPublic

Parametreler

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

Yanıt

Döndürür: GetUserReactsPublicResponse

Örnek

getUserReactsPublic Örneği

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const postIds: string[] = ["post_1a2b3c", "post_4d5e6f"];
  const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
  const fullResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId, postIds, ssoToken);
  const minimalResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId);
}
demo();

reactFeedPostPublic

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
postId	string	Yes
reactBodyParams	ReactBodyParams	Yes
isUndo	boolean	No
broadcastId	string	No
sso	string	No

Yanıt

Döndürür: ReactFeedPostPublicResponse

Örnek

reactFeedPostPublic Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const postId: string = 'post_98765';
  const reactBodyParams: ReactBodyParams = { reaction: 'thumbs_up' };
  const isUndo: boolean = false;
  const broadcastId: string = 'broadcast_abcde';
  const sso: string = 'sso_token_xyz';
  const response: ReactFeedPostPublicResponse = await reactFeedPostPublic(
    tenantId,
    postId,
    reactBodyParams,
    isUndo,
    broadcastId,
    sso
  );
  console.log(response);
})();

updateFeedPost

Parametreler

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

Yanıt

Döndürür: UpdateFeedPostResponse

Örnek

updateFeedPost Örneği

Copy

const tenantId: string = "tenant_3421";
const postId: string = "feedpost_a9b8c7";
const feedPost: FeedPost = {
  content: "We've refreshed the announcement with the latest project milestones.",
  media: [
    {
      type: "image",
      url: "https://assets.example.com/images/milestone.png",
      caption: "Project Milestones"
    } as FeedPostMediaItem
  ],
  link: {
    url: "https://example.com/project-updates",
    title: "Project Updates",
    description: "Read about the recent progress and upcoming goals."
  } as FeedPostLink
};
const result: UpdateFeedPostResponse = await updateFeedPost(tenantId, postId, feedPost);

updateFeedPostPublic

Parametreler

İsim	Tür	Gerekli
tenantId	string	Yes
postId	string	Yes
updateFeedPostParams	UpdateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

Yanıt

Döndürür: UpdateFeedPostPublicResponse

Örnek

updateFeedPostPublic Örneği

Copy

async function updatePostExample() {
  const tenantId: string = 'tenant-9f8b7c';
  const postId: string = 'post-3a4d5e';
  const updateParams: UpdateFeedPostParams = {
    title: 'New Announcement',
    content: 'We have updated our terms of service.',
    media: [
      {
        url: 'https://cdn.example.com/assets/image.png',
        type: 'image',
        asset: {
          width: 800,
          height: 600,
          size: 124000
        } as FeedPostMediaItemAsset
      } as FeedPostMediaItem
    ],
    link: {
      url: 'https://example.com/terms',
      title: 'Read the new TOS'
    } as FeedPostLink
  };
  const broadcastId: string = 'broadcast-2023-09';
  const sso: string = 'sso-abc123xyz';
  const result: UpdateFeedPostPublicResponse = await updateFeedPostPublic(
    tenantId,
    postId,
    updateParams,
    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: FlagCommentPublicResponse

Örnek

flagCommentPublic Örnek

Copy

async function demoFlagComment() {
    const tenantId: string = "acme-tenant-123";
    const commentId: string = "comment-987654";
    const isFlagged: boolean = true;
    const sso: string = "sso-token-abc123";
    const result: FlagCommentPublicResponse = await flagCommentPublic(
        tenantId,
        commentId,
        isFlagged,
        sso
    );
    console.log(result);
}
demoFlagComment();

getGifLarge

Parametreler

Name	Type	Required	Description
tenantId	string	Yes
largeInternalURLSanitized	string	Yes

Yanıt

Döndürür: GetGifLargeResponse

Örnek

getGifLarge Örneği

Copy

(async () => {
  const tenantId: string = 'c9f4a1b2-3d5e-4f6a-8b9c-0d1e2f3a4b5c';
  const largeInternalURLSanitized: string = 'https://cdn.fastcomments.com/gifs/awesome-cat-large.gif';
  const result: GetGifLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);
  console.log(result);
})();

getGifsSearch

Parametreler

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

Yanıt

Döndürür: GetGifsSearchResponse

Örnek

getGifsSearch Örnek

Copy

async function demo() {
  const tenantId: string = "tenant_9f8b7c";
  const search: string = "funny cats";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 1;
  const result: GetGifsSearchResponse = await getGifsSearch(
    tenantId,
    search,
    locale,
    rating,
    page
  );
  console.log(result);
}
demo();

getGifsTrending

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

Yanıt

Döner: GetGifsTrendingResponse

Örnek

getGifsTrending Örneği

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6d";
  const locale: string = "en-US";
  const rating: string = "PG-13";
  const page: number = 1;
  const trendingAll: GetGifsTrendingResponse = await getGifsTrending(tenantId, locale, rating, page);
  console.log(trendingAll);
  // Yalnızca gerekli parametreyi kullanarak
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

addHashTag

Parametreler

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

Yanıt

Returns: AddHashTagResponse

Örnek

addHashTag Örneği

Copy

const tenantId: string = "tenant_9876";
const newHashTag: CreateHashTagBody = {
  tag: "typescript",
  description: "Discussions about TypeScript"
};
const responseWithTenant: AddHashTagResponse = await addHashTag(tenantId, newHashTag);
const responseWithoutTenant: AddHashTagResponse = await addHashTag(undefined, newHashTag);

addHashTagsBulk

Parameters

Name	Type	Required	Description
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Response

Döndürür: AddHashTagsBulkResponse

Example

addHashTagsBulk Örnek

Copy

async () => {
    const tenantId: string | undefined = "tenant_9f8b7c6d";
    const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
        tags: [
            {
                name: "typescript",
                description: "Discussions about TypeScript",
                color: "#3178c6"
            },
            {
                name: "fastcomments",
                description: "Tags for FastComments integration",
                color: "#00aaff"
            }
        ]
    };
    const result: AddHashTagsBulkResponse = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
    console.log(result);
}();

deleteHashTag

Parameters

İsim	Tür	Gerekli
tag	string	Evet
tenantId	string	Hayır
deleteHashTagRequestBody	DeleteHashTagRequestBody	Hayır

Response

Döndürür: DeleteHashTagResponse

Örnek

deleteHashTag Örneği

Copy

(async () => {
  const tag: string = "announcement";
  const tenantId: string = "tenant_9876";
  const requestBody: DeleteHashTagRequestBody = {
    confirmDeletion: true
  };
  const response: DeleteHashTagResponse = await deleteHashTag(tag, tenantId, requestBody);
  console.log(response);
})();

getHashTags

Parametreler

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

Yanıt

Döndürür: GetHashTagsResponse1

Örnek

getHashTags Örnek

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const responseWithPage: GetHashTagsResponse1 = await getHashTags(tenantId, 1);
  const responseDefault: GetHashTagsResponse1 = await getHashTags(tenantId);
  console.log(responseWithPage, responseDefault);
})();

patchHashTag

Parametreler

Ad	Tip	Gerekli
tag	string	Evet
tenantId	string	Hayır
updateHashTagBody	UpdateHashTagBody	Hayır

Yanıt

Döndürür: PatchHashTagResponse

Örnek

patchHashTag Örneği

Copy

const response1: PatchHashTagResponse = await patchHashTag("new-feature");
const response2: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c"
);
const updateBody: UpdateHashTagBody = {
  description: "Mark comments related to the upcoming beta release",
  color: "#1e90ff"
};
const response3: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c",
  updateBody
);

deleteModerationVote

Parametreler

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

Yanıt

Döndürür: DeleteModerationVoteResponse

Örnek

deleteModerationVote Örneği

Copy

const commentId: string = "cmt_12345";
const voteId: string = "vote_9876";
const broadcastId: string = "brd_001";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc";
const result: DeleteModerationVoteResponse = await deleteModerationVote(
  commentId,
  voteId,
  broadcastId,
  tenantId,
  sso
);

getApiComments

Parametreler

Ad	Tür	Gerekli
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetApiCommentsResponse

Örnek

getApiComments Örnek

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // sayfa
    25,                    // adet
    "feedback",           // metinArama
    "192.168.1.100",      // IP'denYorum
    "approved",           // filtreler
    "hasReplies",         // aramaFiltreleri
    "dateDesc",           // sıralama
    false,                // demo
    "tenant-abc123",      // tenantId
    "sso-token-xyz"       // sso
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

getApiExportStatus

Parametreler

Ad	Tür	Gerekli
batchJobId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetApiExportStatusResponse

Örnek

getApiExportStatus Örneği

Copy

async function demoExportStatus() {
    const batchJobId: string = "exportBatch-20231101-001";
    const tenantId: string = "tenant-abc123";
    const ssoToken: string = "sso-xyz789";
    const fullStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId, tenantId, ssoToken);
    const simpleStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId);
    console.log(fullStatus, simpleStatus);
}

getApiIds

Parametreler

Name	Type	Required
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetApiIdsResponse

Örnek

getApiIds Örneği

Copy

const textSearch: string = "urgent feedback";
const byIPFromComment: string = "203.0.113.42";
const filters: string = "status:approved";
const afterId: string = "comment-789";
const demo: boolean = true;
const tenantId: string = "tenant-001";
const apiIds: GetApiIdsResponse = await getApiIds({
  textSearch,
  byIPFromComment,
  filters,
  afterId,
  demo,
  tenantId,
});

getBanUsersFromComment

Parametreler

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

Yanıt

Döndürür: GetBanUsersFromCommentResponse

Örnek

getBanUsersFromComment Örneği

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // Tüm parametrelerle çağır
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // Sadece gerekli parametreyle çağır
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

getCommentBanStatus

Parametreler

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

Yanıt

Döner: GetCommentBanStatusResponse1

Örnek

getCommentBanStatus Örneği

Copy

async function checkCommentBanStatus() {
  const banStatus: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654321', 'tenant_42', 'sso_token_abc123');
  const banStatusNoTenant: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654322', undefined, 'sso_token_def456');
}

getCommentChildren

Parametreler

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

Yanıt

Döndürür: GetCommentChildrenResponse

Örnek

getCommentChildren Örneği

Copy

const commentId: string = "cmt_12345";
const tenantId: string = "tenant_xyz";
const sso: string = "sso_987654";
const fullResponse: GetCommentChildrenResponse = await getCommentChildren(commentId, tenantId, sso);
const minimalResponse: GetCommentChildrenResponse = await getCommentChildren(commentId);

getCount

Parametreler

Ad	Tür	Gerekli
textSearch	string	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetCountResponse

Örnek

getCount Örneği

Copy

async function main(): Promise<void> {
  const count: GetCountResponse = await getCount({
    textSearch: "order issue",
    byIPFromComment: "198.51.100.23",
    filter: "pending",
    demo: true,
    tenantId: "acme_corp",
    sso: "sso_abcdef123456"
  });
  console.log(count);
}
main();

getCounts

Parametreler

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

Yanıt

Döndürür: GetCountsResponse

Örnek

getCounts Örneği

Copy

async function runExample() {
    const tenantId: string = "acme-corp";
    const ssoToken: string = "sso-token-2024";
    const withBoth: GetCountsResponse = await getCounts(tenantId, ssoToken);
    const withTenantOnly: GetCountsResponse = await getCounts(tenantId);
    const withoutParams: GetCountsResponse = await getCounts();
    console.log(withBoth, withTenantOnly, withoutParams);
}
runExample();

getLogs

Parametreler

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

Yanıt

Döndürür: GetLogsResponse

Örnek

getLogs Örneği

Copy

async function fetchLogs() {
    const commentId: string = "cmt_9a8b7c6d5e4f3a2b";
    const tenantId: string = "tenant_9876";
    const sso: string = "sso_abcdef123456";
    const fullResponse: GetLogsResponse = await getLogs(commentId, tenantId, sso);
    const minimalResponse: GetLogsResponse = await getLogs(commentId);
}

getManualBadges

Parametreler

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

Yanıt

Döndürür: GetManualBadgesResponse

Örnek

getManualBadges Örneği

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // Hem iki isteğe bağlı parametreyle çağır
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // Yalnızca tenantId ile çağır
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

getManualBadgesForUser

Parametreler

İsim	Tip	Gerekli
badgesUserId	string	No
commentId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetManualBadgesForUserResponse

Örnek

getManualBadgesForUser Örneği

Copy

(async () => {
  const userId: string = "user_42";
  const commentId: string = "comment_1001";
  const tenantId: string = "tenant_acme";
  const ssoToken: string = "sso_5f6g7h8i9j";
  const badges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId, commentId, tenantId, ssoToken);
  const limitedBadges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId);
})();

getModerationComment

Parametreler

Ad	Tür	Gerekli
commentId	string	Yes
includeEmail	boolean	No
includeIP	boolean	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetModerationCommentResponse

Örnek

getModerationComment Örneği

Copy

async function fetchCommentDetails() {
  // Tam parametre seti
  const commentId: string = "cmt_12345abc";
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const tenantId: string = "tenant_9876";
  const sso: string = "sso_token_xyz";
  const fullResult: GetModerationCommentResponse = await getModerationComment(
    commentId,
    includeEmail,
    includeIP,
    tenantId,
    sso
  );
  // Gerekli argümanı sadece kullanan minimal çağrı
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // Sonuçları gerektiği gibi kullan...
}

getModerationCommentText

Parametreler

Ad	Tür	Gereklidir
commentId	string	Yes
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetModerationCommentTextResponse

Örnek

getModerationCommentText Örneği

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // Sadece gerekli parametre ile çağırma
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // Opsiyonel parametrelerle çağırma
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

getPreBanSummary

Parametreler

Ad	Tür	Gerekli
commentId	string	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetPreBanSummaryResponse

Örnek

getPreBanSummary Örneği

Copy

const commentId: string = "5f8d0c2e4b1a2c3d4e5f6a7b";
const includeByUserIdAndEmail: boolean = true;
const includeByIP: boolean = true;
const includeByEmailDomain: boolean = false;
const tenantId: string = "tenant-001";
const sso: string = "sso-xyz-123";
const preBanSummary: GetPreBanSummaryResponse = await getPreBanSummary(
  commentId,
  includeByUserIdAndEmail,
  includeByIP,
  includeByEmailDomain,
  tenantId,
  sso
);

getSearchCommentsSummary

Parametreler

Ad	Tür	Gerekli
value	string	Hayır
filters	string	Hayır
searchFilters	string	Hayır
tenantId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: GetSearchCommentsSummaryResponse

Örnek

getSearchCommentsSummary Örneği

Copy

async function runExample(): Promise<void> {
    const searchTerm: string = "fastcomments integration";
    const filterString: string = "status:approved";
    const searchFilterString: string = "author:jane";
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
    const summary: GetSearchCommentsSummaryResponse = await getSearchCommentsSummary(
        searchTerm,
        filterString,
        searchFilterString,
        tenantId,
        ssoToken
    );
    console.log(summary);
}
runExample();

getSearchPages

Parametreler

Ad	Tür	Gerekli
value	string	Hayır
tenantId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: GetSearchPagesResponse

Örnek

getSearchPages Örneği

Copy

(async () => {
  const query: string = "network outage";
  const tenantId: string = "tenant-9876";
  const ssoToken: string = "sso-abc123def456";
  const searchResult: GetSearchPagesResponse = await getSearchPages(query, tenantId, ssoToken);
  const searchResultNoSso: GetSearchPagesResponse = await getSearchPages(query, tenantId);
})();

getSearchSites

Parametreler

Ad	Tür	Gerekli
value	string	Hayır
tenantId	string	Hayır
sso	string	Hayır

Yanıt

Returns: GetSearchSitesResponse

Örnek

getSearchSites Örneği

Copy

async function fetchSites() {
  const value: string = "customer support"
  const tenantId: string = "tenant-9876"
  const sso: string = "sso-abc123"
  const sites: GetSearchSitesResponse = await getSearchSites(value, tenantId, sso)
  const sitesOnlyTenant: GetSearchSitesResponse = await getSearchSites(undefined, tenantId)
}

getSearchSuggest

Parametreler

Ad	Tür	Gerekli
textSearch	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetSearchSuggestResponse

Örnek

getSearchSuggest Örneği

Copy

async function example(): Promise<void> {
    const term: string = "fastcomments api";
    const tenant: string = "tenant_001";
    const sso: string = "sso_9a8b7c";
    const fullResult: GetSearchSuggestResponse = await getSearchSuggest(term, tenant, sso);
    const partialResult: GetSearchSuggestResponse = await getSearchSuggest(term);
}
example();

getSearchUsers

Parametreler

Name	Type	Required
value	string	Hayır
tenantId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: GetSearchUsersResponse

Örnek

getSearchUsers Örneği

Copy

async function demoSearch() {
    const query: string = "john.doe@example.com";
    const tenantId: string = "tenant_12345";
    const ssoToken: string = "sso_token_abc";
    const resultWithSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId, ssoToken);
    const resultWithoutSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId);
}

getTrustFactor

Parametreler

Ad	Tür	Gerekli
userId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: GetTrustFactorResponse

Örnek

getTrustFactor Örneği

Copy

async function runDemo(): Promise<void> {
    const trustFull: GetTrustFactorResponse = await getTrustFactor("user_12345", "tenant_abc", "sso_token_987");
    const trustUserOnly: GetTrustFactorResponse = await getTrustFactor("user_12345");
    console.log(trustFull, trustUserOnly);
}
runDemo();

getUserBanPreference

Parametreler

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

Yanıt

Döndürür: GetUserBanPreferenceResponse

Örnek

getUserBanPreference Örneği

Copy

async function demoGetUserBanPreference(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-2024";
  const sso: string = "sso-token-9f8b7a6c";
  const result: GetUserBanPreferenceResponse = await getUserBanPreference(tenantId, sso);
  console.log(result);
}
demoGetUserBanPreference();

getUserInternalProfile

Parametreler

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

Yanıt

Döndürür: GetUserInternalProfileResponse1

Örnek

getUserInternalProfile Örneği

Copy

(async () => {
  const fullProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_12345",
    tenantId: "tenant_67890",
    sso: "sso_token_abcdef"
  });
  const partialProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_98765"
  });
})();

postAdjustCommentVotes

Parameters

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

Response

Döndürür: PostAdjustCommentVotesResponse

Example

postAdjustCommentVotes Örneği

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // AdjustCommentVotesParams tarafından gerekli ek alanlar
};
const broadcastId: string = "brd_20230915";
const tenantId: string = "tenant_42";
const sso: string = "sso-token-abc123";
const result: PostAdjustCommentVotesResponse = await postAdjustCommentVotes(
  commentId,
  adjustParams,
  broadcastId,
  tenantId,
  sso
);

postApiExport

Parametreler

Ad	Tür	Gerekli
textSearch	string	Hayır
byIPFromComment	string	Hayır
filters	string	Hayır
searchFilters	string	Hayır
sorts	string	Hayır
tenantId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: PostApiExportResponse

Örnek

postApiExport Örneği

Copy

(async () => {
  const textSearch: string = "keyword:feedback"
  const byIPFromComment: string = "203.0.113.45"
  const filters: string = "status:pending,category:support"
  const searchFilters: string = "createdAt>2023-01-01"
  const sorts: string = "createdAt:desc"
  const tenantId: string = "tenant_9876"
  const sso: string = "sso_7e2a9b"
  const exportResult: PostApiExportResponse = await postApiExport(
    textSearch,
    byIPFromComment,
    filters,
    searchFilters,
    sorts,
    tenantId,
    sso
  )
  console.log(exportResult)
})()

postBanUserFromComment

Parametreler

Ad	Tür	Gerekli
commentId	string	Evet
banEmail	boolean	Hayır
banEmailDomain	boolean	Hayır
banIP	boolean	Hayır
deleteAllUsersComments	boolean	Hayır
bannedUntil	string	Hayır
isShadowBan	boolean	Hayır
updateId	string	Hayır
banReason	string	Hayır
tenantId	string	Hayır
sso	string	Hayır

Yanıt

Döndürür: PostBanUserFromCommentResponse

Örnek

postBanUserFromComment Örneği

Copy

async function runBan() {
  const commentId: string = "cmt_5f8a2b3c";
  const banEmail: boolean = true;
  const banIP: boolean = false;
  const deleteAllUsersComments: boolean = true;
  const bannedUntil: string = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000).toISOString();
  const isShadowBan: boolean = false;
  const banReason: string = "Repeated spam posting";
  const tenantId: string = "tenant_12345";
  const response: PostBanUserFromCommentResponse = await postBanUserFromComment(
    commentId,
    banEmail,
    undefined,
    banIP,
    deleteAllUsersComments,
    bannedUntil,
    isShadowBan,
    undefined,
    banReason,
    tenantId
  );
  console.log(response);
}
runBan();

postBanUserUndo

Parametreler

Ad	Tür	Gerekli
banUserUndoParams	BanUserUndoParams	Yes
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PostBanUserUndoResponse

Örnek

postBanUserUndo Örneği

Copy

const undoParams: BanUserUndoParams = {
  userId: "user-8421",
  commentId: "comment-6702",
  reason: "Accidental ban"
};
const tenantId: string = "tenant-7f9e";
const ssoToken: string = "sso-4b2c1d";
async function runUndo() {
  const resultAll: PostBanUserUndoResponse = await postBanUserUndo(undoParams, tenantId, ssoToken);
  console.log(resultAll);
  const resultMinimal: PostBanUserUndoResponse = await postBanUserUndo(undoParams);
  console.log(resultMinimal);
}
runUndo();

postBulkPreBanSummary

Parametreler

Ad	Tür	Gerekli
bulkPreBanParams	BulkPreBanParams	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PostBulkPreBanSummaryResponse

Örnek

postBulkPreBanSummary Örneği

Copy

async function runExample() {
  const bulkPreBanParams: BulkPreBanParams = {
    userIds: [10234, 56789],
    emails: ["spam_user@example.com", "abuse@badsite.org"],
    ips: ["203.0.113.45", "198.51.100.22"],
    emailDomains: ["maliciousdomain.com"]
  };
  const includeByUserIdAndEmail: boolean = true;
  const includeByIP: boolean = false;
  const includeByEmailDomain: boolean = true;
  const tenantId: string = "tenant_8f4b2c1a";
  const sso: string = "sso-3948abf0";
  const summary: PostBulkPreBanSummaryResponse = await postBulkPreBanSummary(
    bulkPreBanParams,
    includeByUserIdAndEmail,
    includeByIP,
    includeByEmailDomain,
    tenantId,
    sso
  );
  console.log(summary);
}
runExample();

postCommentsByIds

Parametreler

Ad	Tür	Gerekli
commentsByIdsParams	CommentsByIdsParams	Evet
tenantId	string	Hayır
sso	string	Hayır

Yanıt

Döner: PostCommentsByIdsResponse

Örnek

postCommentsByIds Örneği

Copy

const commentsByIdsParams: CommentsByIdsParams = {
  commentIds: ['cmt001', 'cmt002'],
  includeUserInfo: true,
  includeThreadInfo: false,
} as CommentsByIdsParams;
const fullResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams,
  'tenant-12345',
  'sso-token-xyz'
);
const minimalResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams
);

postFlagComment

Parametreler

Ad	Tür	Gerekli
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PostFlagCommentResponse

Örnek

postFlagComment Örneği

Copy

const commentId: string = "cmt_20230915_001";
const broadcastId: string = "brd_20230915_live";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc123";
const flaggedResponse: PostFlagCommentResponse = await postFlagComment(
  commentId,
  broadcastId,
  tenantId,
  sso
);

postRemoveComment

Parametreler

Name	Type	Required
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PostRemoveCommentResponse

Örnek

postRemoveComment Örneği

Copy

async function removeCommentExample(): Promise<void> {
  const commentId: string = "cmt_7f9a3e2b";
  const result1: PostRemoveCommentResponse = await postRemoveComment(commentId);
  const broadcastId: string = "brd_12ab34cd";
  const tenantId: string = "tenant_5678efgh";
  const sso: string = "sso_XYZ12345";
  const result2: PostRemoveCommentResponse = await postRemoveComment(commentId, broadcastId, tenantId, sso);
  console.log(result1, result2);
}

postRestoreDeletedComment

Parametreler

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

Yanıt

Döndürür: PostRestoreDeletedCommentResponse

Örnek

postRestoreDeletedComment Örneği

Copy

async function restoreCommentDemo(): Promise<void> {
    const commentId: string = "cmt_5f2a9b7e1234567890abcd";
    const broadcastId: string | undefined = "brd_2023_09";
    const tenantId: string | undefined = "tenant_42";
    const sso: string | undefined = "sso_token_abcdef123456";
    const response: PostRestoreDeletedCommentResponse = await postRestoreDeletedComment(
        commentId,
        broadcastId,
        tenantId,
        sso
    );
    console.log(response);
}
restoreCommentDemo();

postSetCommentApprovalStatus

Parametreler

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

Yanıt

Döndürür: PostSetCommentApprovalStatusResponse

Örnek

postSetCommentApprovalStatus Örneği

Copy

async function main() {
  const commentIdOnly: string = "cmt_1001";
  const resultOnly: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(commentIdOnly);
  const commentIdFull: string = "cmt_2002";
  const approvedFull: boolean = true;
  const broadcastIdFull: string = "brd_3003";
  const tenantIdFull: string = "tenant_abc";
  const ssoFull: string = "sso_token_xyz";
  const resultFull: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(
    commentIdFull,
    approvedFull,
    broadcastIdFull,
    tenantIdFull,
    ssoFull
  );
  console.log(resultOnly, resultFull);
}
main();

postSetCommentReviewStatus

Parametreler

Ad	Tip	Gerekli
commentId	string	Yes
reviewed	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PostSetCommentReviewStatusResponse

Örnek

postSetCommentReviewStatus Örneği

Copy

async function updateCommentReviewStatus(): Promise<void> {
  const commentId: string = "cmt_9f8a7b6c5d4e3f2a1b0c";
  const reviewed: boolean = true;
  const broadcastId: string = "broadcast_2024Q1";
  const tenantId: string = "tenant_1001";
  const sso: string = "alice@example.com";
  const response: PostSetCommentReviewStatusResponse = await postSetCommentReviewStatus(
    commentId,
    reviewed,
    broadcastId,
    tenantId,
    sso
  );
  console.log(response);
}

postSetCommentSpamStatus

Parametreler

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

Yanıt

Döndürür: PostSetCommentSpamStatusResponse

Örnek

postSetCommentSpamStatus Örneği

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // Yalnızca gerekli parametre
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // Tüm isteğe bağlı parametreler sağlandı
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

postSetCommentText

Parametreler

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

Yanıt

Döndürür: PostSetCommentTextResponse

Örnek

postSetCommentText Örneği

Copy

(async () => {
  const commentId: string = "cmt_9f8b7a6d5e4c3b2a1";
  const setParams: SetCommentTextParams = {
    text: "Edited comment to correct a typo and add clarification."
  };
  const broadcastId: string = "brd_1a2b3c4d5e6f7g8h9";
  const tenantId: string = "tenant_xyz123";
  const sso: string = "sso_user_456def";
  const fullResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams,
    broadcastId,
    tenantId,
    sso
  );
  const minimalResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams
  );
  console.log(fullResult, minimalResult);
})();

postUnFlagComment

Parameters

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

Response

Döndürür: PostUnFlagCommentResponse

Example

postUnFlagComment Örneği

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // commentId
    "brd_67890",          // broadcastId (isteğe bağlı)
    "tenant_abc",         // tenantId (isteğe bağlı)
    "sso_user_token_789"  // sso (isteğe bağlı)
  );
};

postVote

Parametreler

İsim	Tür	Gerekli
commentId	string	Yes
direction	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PostVoteResponse

Örnek

postVote Örneği

Copy

let commentId: string = 'cmt_12345';
let direction: string = 'up';
let broadcastId: string = 'brd_67890';
let tenantId: string = 'tenant_abc';
let sso: string = 'sso_token_xyz';
const fullVote: PostVoteResponse = await postVote(
  commentId,
  direction,
  broadcastId,
  tenantId,
  sso
);
const simpleVote: PostVoteResponse = await postVote('cmt_67890');

putAwardBadge

Parametreler

Ad	Tür	Gerekli
badgeId	string	Yes
userId	string	No
commentId	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PutAwardBadgeResponse

Örnek

putAwardBadge Örneği

Copy

(async () => {
    const badgeId: string = "badge-superstar"
    const userId: string = "user-42"
    const commentId: string = "comment-7f9c3"
    const broadcastId: string = "broadcast-2023-09"
    const result: PutAwardBadgeResponse = await putAwardBadge(badgeId, userId, commentId, broadcastId)
    console.log(result)
})()

putCloseThread

Parametreler

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

Yanıt

Döndürür: PutCloseThreadResponse

Örnek

putCloseThread Örneği

Copy

async function closeThreadDemo(): Promise<void> {
  const urlId: string = "article-2023-09-15";
  const tenantId: string = "tenant-42";
  const sso: string = "sso-token-xyz";
  const response: PutCloseThreadResponse = await putCloseThread(urlId, tenantId, sso);
  console.log(response);
}
closeThreadDemo();

putRemoveBadge

Parametreler

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

Yanıt

Döndürür: PutRemoveBadgeResponse

Örnek

putRemoveBadge Örneği

Copy

const badgeId: string = "badge-12345";
const userId: string = "user-9876";
const commentId: string = "comment-5555";
const broadcastId: string = "broadcast-001";
const result: PutRemoveBadgeResponse = await putRemoveBadge(
  badgeId,
  userId,
  commentId,
  broadcastId
);

putReopenThread

Parametreler

Ad	Tür	Gerekli
urlId	string	Yes
tenantId	string	No
sso	string	No

Yanıt

Döndürür: PutReopenThreadResponse

Örnek

putReopenThread Örneği

Copy

async function exampleUsage() {
  const urlId: string = "thread-9f8b7c6a";
  const tenantId: string = "tenant-001";
  const sso: string = "sso-3f9d2e1a";
  const resultAll: PutReopenThreadResponse = await putReopenThread(urlId, tenantId, sso);
  console.log(resultAll);
  const resultMinimal: PutReopenThreadResponse = await putReopenThread(urlId);
  console.log(resultMinimal);
}

setTrustFactor

Parametreler

Ad	Tür	Gerekli
userId	string	No
trustFactor	string	No
tenantId	string	No
sso	string	No

Yanıt

Döndürür: SetTrustFactorResponse

Örnek

setTrustFactor Örneği

Copy

(async () => {
  const userId: string = "user_8421";
  const trustFactor: string = "high";
  const tenantId: string = "tenant_33";
  const ssoToken: string = "sso_7d9f";
  const fullResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor, tenantId, ssoToken);
  const minimalResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor);
})();

createModerator

Parametreler

Name	Type	Required	Açıklama
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	Yes

Yanıt

Döndürür: CreateModeratorResponse1

Örnek

createModerator Örneği

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // açıklama gibi isteğe bağlı alanlar atlanmıştır
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

deleteModerator

Parametreler

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

Yanıt

Döndürür: DeleteModeratorResponse

Örnek

deleteModerator Örneği

Copy

async function runDeleteModeratorExample() {
  const tenantId: string = "tenant_2023";
  const moderatorId: string = "mod_001";
  const notificationEmail: string = "admin@mycompany.com";
  const resultWithEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId, notificationEmail);
  const resultWithoutEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId);
}

getModerator

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
id	string	Evet

Yanıt

Döner: GetModeratorResponse1

Örnek

getModerator Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp-001";
  const id: string = "mod-12345";
  const result: GetModeratorResponse1 = await getModerator(tenantId, id);
  const moderatorName: string | undefined = result.moderator?.name;
  console.log(moderatorName);
})();

getModerators

Parametreler

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

Yanıt

Döndürür: GetModeratorsResponse1

Örnek

getModerators Örneği

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // isteğe bağlı sayfalama ofseti
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // Sayfalama olmadan örnek:
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

sendInvite

Parametreler

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

Yanıt

Döndürür: SendInviteResponse

Örnek

sendInvite Örneği

Copy

const tenantId: string = "acme-corp-tenant";
const inviteId: string = "invite-12345";
const fromName: string = "John Doe";
const inviteResult: SendInviteResponse = await sendInvite(tenantId, inviteId, fromName);

updateModerator

Parametreler

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

Yanıt

Döndürür: UpdateModeratorResponse

Örnek

updateModerator Örneği

Copy

async function demoUpdateModerator(): Promise<void> {
    const tenantId: string = "tenant_42abc";
    const moderatorId: string = "moderator_8f9e";
    const updateBody: UpdateModeratorBody = {
        isActive: true,
        role: "admin",
        // isteğe bağlı alan
        notes: "Promoted to senior moderator"
    };
    const result: UpdateModeratorResponse = await updateModerator(tenantId, moderatorId, updateBody);
    console.log(result);
}
demoUpdateModerator();

deleteNotificationCount

Parametreler

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

Yanıt

Döndürür: DeleteNotificationCountResponse

Örnek

deleteNotificationCount Örneği

Copy

async function run() {
  const tenantId: string = "tenant_12345";
  const notificationId: string = "notif_98765";
  const result: DeleteNotificationCountResponse = await deleteNotificationCount(tenantId, notificationId);
  console.log(result);
}
run();

getCachedNotificationCount

Parametreler

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

Yanıt

Döndürür: GetCachedNotificationCountResponse1

Örnek

getCachedNotificationCount Örneği

Copy

const tenantId: string = "e3f1a9b2-4c5d-6e7f-8a9b-0c1d2e3f4a5b";
const userId: string = "u-20231101-001";
const notificationResult: GetCachedNotificationCountResponse1 = await getCachedNotificationCount(tenantId, userId);
console.log(notificationResult);

getNotificationCount

Parametreler

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

Yanıt

Döndürür: GetNotificationCountResponse1

Örnek

getNotificationCount Örneği

Copy

async function demoNotificationCount() {
    const tenantId: string = "tenant_001";
    const userId: string = "user_42";
    const urlId: string = "url_9f8e7d";
    const fromCommentId: string = "comment_12345";
    const viewed: boolean = false;
    const type: string = "mention";
    const result: GetNotificationCountResponse1 = await getNotificationCount(
        tenantId,
        userId,
        urlId,
        fromCommentId,
        viewed,
        type
    );
    console.log(result);
}
demoNotificationCount();

getNotifications

Parametreler

Name	Type	Required
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

Yanıt

Döner: GetNotificationsResponse1

Örnek

getNotifications Örneği

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const notifications: GetNotificationsResponse1 = await getNotifications(tenantId, userId);
  console.log(notifications);
  const more: GetNotificationsResponse1 = await getNotifications(
    tenantId,
    undefined,
    "article-5678",
    undefined,
    true,
    "reply",
    10
  );
  console.log(more);
}
demo();

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

Örnek

updateNotification Örneği

Copy

const tenantId: string = "tenant_5f4d2c";
const notificationId: string = "notif_9b8a7c";
const updateBody: UpdateNotificationBody = {
  enabled: false,
  sendEmail: true,
  schedule: "2023-12-01T08:00:00Z"
};
const userId: string = "user_123e4567";
const responseWithUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody,
  userId
);
const responseWithoutUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody
);

createV1PageReact

Parametreler

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

Yanıt

Returns: CreateV1PageReactResponse

Örnek

createV1PageReact Örneği

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "article-2024-06-improvements";
const title: string = "FastComments API Integration Guide";
const responseWithTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId, title);
const responseWithoutTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId);

createV2PageReact

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
urlId	string	Yes
id	string	Yes
title	string	No

Yanıt

Döndürür: CreateV2PageReactResponse

Örnek

createV2PageReact Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const urlId: string = "blog/posts/fastcomments-integration";
  const pageId: string = "page-12345";
  const title: string = "FastComments API Integration Guide";
  const responseWithoutTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId);
  const responseWithTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId, title);
  console.log(responseWithoutTitle, responseWithTitle);
})();

deleteV1PageReact

Parametreler

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

Yanıt

Döndürür: DeleteV1PageReactResponse

Örnek

deleteV1PageReact Örneği

Copy

const tenantId: string = "acme-corp";
const urlId: string = "article-2024-06-01";
const response: DeleteV1PageReactResponse = await deleteV1PageReact(tenantId, urlId);
console.log(response);

deleteV2PageReact

Parametreler

İsim	Tür	Gerekli
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Yanıt

Döndürür: DeleteV2PageReactResponse

Örnek

deleteV2PageReact Örneği

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "page_98765";
const reactionId: string = "react_abcde";
const deleteResult: DeleteV2PageReactResponse = await deleteV2PageReact(tenantId, urlId, reactionId);

getV1PageLikes

Parametreler

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

Yanıt

Döndürür: GetV1PageLikesResponse

Örnek

getV1PageLikes Örneği

Copy

async function fetchPageLikes() {
  const tenantId: string = "acme-corp-tenant-42";
  const urlId: string = "blog-post-2024-06-typescript-best-practices";
  const likes: GetV1PageLikesResponse = await getV1PageLikes(tenantId, urlId);
  console.log(likes);
}

getV2PageReacts

Parametreler

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

Yanıt

Döndürür: GetV2PageReactsResponse

Örnek

getV2PageReacts Örneği

Copy

async function demoGetPageReacts(): Promise<void> {
    const tenantId: string = "acme-corp-tenant";
    const urlId: string = "article-2024-06-01";
    const reacts: GetV2PageReactsResponse = await getV2PageReacts(tenantId, urlId);
    // isteğe bağlı özellik erişim örneği
    const customConfig: CustomConfigParameters | undefined = reacts.customConfig;
    console.log(reacts);
}
demoGetPageReacts();

getV2PageReactUsers

Parametreler

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

Yanıt

Döndürür: GetV2PageReactUsersResponse1

Örnek

getV2PageReactUsers Örneği

Copy

async function fetchReactUsers() {
  const tenantId: string = 'tenant_12345';
  const urlId: string = 'article-9876';
  const id: string = 'user_abcde';
  const response: GetV2PageReactUsersResponse1 = await getV2PageReactUsers(tenantId, urlId, id);
  console.log(response);
}
fetchReactUsers();

addPage

Parametreler

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

Yanıt

Döndürür: AddPageAPIResponse

Örnek

addPage Örneği

Copy

const tenantId: string = "tenant_9f8432b1-4c2e-4f9d-8a5d-7bc9e2f6d9a0";
const pageData: CreateAPIPageData = {
    url: "https://example.com/articles/fastcomments-intro",
    title: "FastComments Introduction",
    description: "An introductory guide to FastComments API usage.",
    tags: ["fastcomments", "api", "tutorial"],
    metadata: {
        author: "Jane Doe",
        publishedAt: "2024-03-15T08:00:00Z"
    }
};
const response: AddPageAPIResponse = await addPage(tenantId, pageData);

deletePage

Parametreler

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

Yanıt

Döndürür: DeletePageAPIResponse

Örnek

deletePage Örneği

Copy

async function example() {
    const tenantId: string = "acme-corp-001";
    const pageId: string = "page-987654321";
    const result: DeletePageAPIResponse = await deletePage(tenantId, pageId);
    console.log(result);
}
example();

getOfflineUsers

Sayfadaki geçmiş yorumcular, şu anda çevrimiçi olmayanlar. displayName alanına göre sıralanır.
Bu, /users/online uç noktasını tükettiğinizden sonra bir "Members" bölümü oluşturmak için kullanılır.
commenterName üzerinde cursor sayfalama: sunucu {tenantId, urlId, commenterName} kısmı üzerinden afterName sonrası $gt ile ilerler, $skip maliyeti yok.

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Response

Döndürür: GetOfflineUsersResponse

Örnek

getOfflineUsers Örneği

Copy

async function fetchOfflineUsers(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "thread_9876";
    const afterName: string = "Jane Smith";
    const afterUserId: string = "user_7f9b3c";
    const offlineUsers: GetOfflineUsersResponse = await getOfflineUsers(
        tenantId,
        urlId,
        afterName,
        afterUserId
    );
    console.log(offlineUsers);
}

getOnlineUsers

Şu anda çevrimiçi izleyiciler bir sayfada: websocket oturumu şu anda sayfaya abone olan kişiler.
anonCount + totalCount değerini döndürür (odadaki tüm aboneler, saymadığımız anonim izleyiciler dahil).

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
urlId	string	Evet
afterName	string	Hayır
afterUserId	string	Hayır

Yanıt

Döndürür: GetOnlineUsersResponse

Örnek

getOnlineUsers Örnek

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // İsteğe bağlı sayfalama parametreleriyle
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // İsteğe bağlı sayfalama parametreleri olmadan
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

getPageByURLId

Parametreler

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

Yanıt

Döndürür: GetPageByURLIdAPIResponse

Örnek

getPageByURLId Örnek

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_9876";
  const response: GetPageByURLIdAPIResponse = await getPageByURLId(tenantId, urlId);
  const page: APIPage | undefined = response.page;
})();

getPages

Parametreler

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

Yanıt

Döndürür: GetPagesAPIResponse

Örnek

getPages Örneği

Copy

const tenantId: string = "tenant_12345";
(async () => {
  const response: GetPagesAPIResponse = await getPages(tenantId);
  const firstPage: APIPage | undefined = response.pages?.[0];
  console.log(firstPage?.title);
})();

getPagesPublic

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

Parameters

Name	Type	Required
tenantId	string	Yes
cursor	string	No
limit	number	No
q	string	No
sortBy	PagesSortBy	No
hasComments	boolean	No

Response

Döndürür: GetPagesPublicResponse

Örnek

getPagesPublic Örneği

Copy

async function fetchPages() {
  const tenantId: string = "tenant_12345";
  const cursor: string = "nextPageToken";
  const limit: number = 20;
  const q: string = "blog";
  const sortBy: PagesSortBy = "createdAt";
  const hasComments: boolean = true;
  const response: GetPagesPublicResponse = await getPagesPublic(
    tenantId,
    cursor,
    limit,
    q,
    sortBy,
    hasComments
  );
  console.log(response);
}

getUsersInfo

Bir kiracı için toplu kullanıcı bilgisi. userId'ler verildiğinde, User / SSOUser'dan görüntüleme bilgisi döndürür.
Yorum widget'ı tarafından, bir varlık etkinliğiyle yeni ortaya çıkan kullanıcıları zenginleştirmek için kullanılır.
Sayfa bağlamı yok: gizlilik tutarlı bir şekilde uygulanır (özel profiller maskelelenir).

Parametreler

İsim	Tür	Zorunlu	Açıklama
tenantId	string	Evet
ids	string	Evet

Yanıt

Döndürür: GetUsersInfoResponse

Örnek

getUsersInfo Örneği

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// Yanıt içindeki isteğe bağlı alanlar tanımsız olabilir
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

patchPage

Parametreler

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

Yanıt

Döndürür: PatchPageAPIResponse

Örnek

patchPage Örneği

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const pageId: string = "page_98765";
  const updateData: UpdateAPIPageData = {
    title: "Updated FAQ Page"
    // description?: string atlanabilir
  };
  const response: PatchPageAPIResponse = await patchPage(tenantId, pageId, updateData);
})();

deletePendingWebhookEvent

Parametreler

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

Yanıt

Döndürür: DeletePendingWebhookEventResponse

Örnek

deletePendingWebhookEvent Örneği

Copy

async function runDemo() {
  const tenantId: string = 'c3f5e9d2-1a2b-4c3d-9e7f-1234567890ab';
  const eventId: string = 'event_987654321';
  const response: DeletePendingWebhookEventResponse = await deletePendingWebhookEvent(tenantId, eventId);
  console.log(response);
}
runDemo();

getPendingWebhookEventCount

Parametreler

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

Yanıt

Dönüş: GetPendingWebhookEventCountResponse1

Örnek

getPendingWebhookEventCount Örneği

Copy

(async () => {
  const tenantId: string = "tenant_001";
  const responseAll: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(
    tenantId,
    "comment_456",
    "ext_789",
    "comment.updated",
    "webhook",
    "mydomain.com",
    3
  );
  const responseMinimal: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(tenantId);
  console.log(responseAll, responseMinimal);
})();

getPendingWebhookEvents

Parametreler

Name	Type	Required
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No
skip	number	No

Yanıt

Döndürür: GetPendingWebhookEventsResponse1

Örnek

getPendingWebhookEvents Örneği

Copy

async function fetchPendingEvents(): Promise<void> {
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const commentId: string = "cmt-987654321";
    const externalId: string = "ext-abc-123";
    const eventType: string = "comment_created";
    const type: string = "outbound";
    const domain: string = "myblog.com";
    const attemptCountGT: number = 3;
    const skip: number = 0;
    const pending: GetPendingWebhookEventsResponse1 = await getPendingWebhookEvents(
        tenantId,
        commentId,
        externalId,
        eventType,
        type,
        domain,
        attemptCountGT,
        skip
    );
    console.log(pending);
}
fetchPendingEvents();

createQuestionConfig

Parametreler

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

Yanıt

Döndürür: CreateQuestionConfigResponse1

Örnek

createQuestionConfig Örneği

Copy

const tenantId: string = "tenant_12345";
const customOption: QuestionConfigCustomOptionsInner = {
  label: "Option A",
  value: "a",
};
const createQuestionConfigBody: CreateQuestionConfigBody = {
  questionText: "What is your favorite color?",
  isActive: true,
  // isteğe bağlı alanlar atlanabilir
  customOptions: [customOption],
};
const response: CreateQuestionConfigResponse1 = await createQuestionConfig(
  tenantId,
  createQuestionConfigBody
);

deleteQuestionConfig

Parametreler

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

Yanıt

Döndürür: DeleteQuestionConfigResponse

Örnek

deleteQuestionConfig Örneği

Copy

async function runDeletion(): Promise<void> {
  const tenantId: string = "tenant_8f5a2c9d";
  const configId: string = "questionConfig_4b7e1f";
  const deleteResult: DeleteQuestionConfigResponse = await deleteQuestionConfig(tenantId, configId);
  console.log(deleteResult);
}
void runDeletion();

getQuestionConfig

Parametreler

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

Yanıt

Döndürür: GetQuestionConfigResponse1

Örnek

getQuestionConfig Örneği

Copy

const tenantId: string = "acme-corp-tenant-42";
const questionId: string = "question-7f9b3e";
const response: GetQuestionConfigResponse1 = await getQuestionConfig(tenantId, questionId);

getQuestionConfigs

Parametreler

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

Yanıt

Döndürür: GetQuestionConfigsResponse1

Örnek

getQuestionConfigs Örneği

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // Opsiyonel 'skip' parametresi olmadan çağır
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // Opsiyonel 'skip' parametresiyle çağır
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

updateQuestionConfig

Parametreler

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

Yanıt

Döndürür: UpdateQuestionConfigResponse

Örnek

updateQuestionConfig Örneği

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "qstn-2023-04";
const updateBody: UpdateQuestionConfigBody = {
  // isteğe bağlı alanlar gösterildi
  customOptions: [
    {
      id: "opt-001",
      label: "Extra Details",
      required: true,
    },
  ],
  renderingType: "markdown",
};
const response: UpdateQuestionConfigResponse = await updateQuestionConfig(
  tenantId,
  questionId,
  updateBody
);

createQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

Yanıt

Döndürür: CreateQuestionResultResponse1

Örnek

createQuestionResult Örneği

Copy

const tenantId: string = "acme-corp-tenant";
const metaItem: MetaItem = {
  key: "campaign",
  value: "spring-launch"
};
const questionResultBody: CreateQuestionResultBody = {
  questionId: "question-42",
  answer: "Positive",
  metadata: [metaItem]
  // notlar gibi opsiyonel alanlar dışarı bırakılmıştır
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

deleteQuestionResult

Parametreler

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

Yanıt

Döndürür: DeleteQuestionResultResponse

Örnek

deleteQuestionResult Örneği

Copy

async function runDeletion(): Promise<void> {
    const tenantId: string = "tenant-001";
    const resultId: string = "c9f2a5b3-7e6d-4c9a-8b1f-2d3e4f5a6b7c";
    const result: DeleteQuestionResultResponse = await deleteQuestionResult(tenantId, resultId);
    console.log(result);
}
runDeletion();

getQuestionResult

Parametreler

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

Yanıt

Döndürür: GetQuestionResultResponse1

Örnek

getQuestionResult Örneği

Copy

async function fetchQuestionResult(): Promise<void> {
    const tenantId: string = "acme-corp-001";
    const questionId: string = "question-7a9b8c";
    const result: GetQuestionResultResponse1 = await getQuestionResult(tenantId, questionId);
    const question: QuestionResult | undefined = result.questionResult;
    const firstMeta: MetaItem | undefined = result.meta?.[0];
    console.log(question?.id, firstMeta?.key);
}

getQuestionResults

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Yanıt

Döner: GetQuestionResultsResponse1

Örnek

getQuestionResults Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const urlId: string = "post-456";
  const userId: string = "user-789";
  const startDate: string = "2023-09-01T00:00:00Z";
  const questionId: string = "q-101";
  const questionIds: string = "q-102,q-103";
  const skip: number = 20;
  const results: GetQuestionResultsResponse1 = await getQuestionResults(
    tenantId,
    urlId,
    userId,
    startDate,
    questionId,
    questionIds,
    skip
  );
  console.log(results);
})();

updateQuestionResult

Parametreler

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

Yanıt

Döndürür: UpdateQuestionResultResponse

Örnek

updateQuestionResult Örneği

Copy

async function runUpdate() {
    const tenantId: string = "acme-corp-01";
    const id: string = "qr-20230915-001";
    const updateQuestionResultBody: UpdateQuestionResultBody = {
        // gerekli alanlar
        answer: "No",
        // isteğe bağlı alanlar
        comment: "User clarified their response",
        // anotherOptionalField?: değer,
    };
    const result: UpdateQuestionResultResponse = await updateQuestionResult(
        tenantId,
        id,
        updateQuestionResultBody
    );
    console.log(result);
}
runUpdate();

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

Örnek

aggregateQuestionResults Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const questionId: string = "feedback-rating";
  const questionIds: string[] = ["feedback-rating", "recommendation"];
  const urlId: string = "https://myblog.com/articles/42";
  const timeBucket: AggregateTimeBucket = "month";
  const startDate: Date = new Date("2023-01-01T00:00:00Z");
  const forceRecalculate: boolean = true;
  const result: AggregateQuestionResultsResponse1 = await aggregateQuestionResults(
    tenantId,
    questionId,
    questionIds,
    urlId,
    timeBucket,
    startDate,
    forceRecalculate
  );
  console.log(result);
})();

bulkAggregateQuestionResults

Parametreler

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

Yanıt

Döndürür: BulkAggregateQuestionResultsResponse1

Örnek

bulkAggregateQuestionResults Örneği

Copy

const tenantId: string = "acme-corp";
const request: BulkAggregateQuestionResultsRequest = {
  questionIds: ["product-satisfaction", "feature-usage"],
  startDate: "2024-01-01T00:00:00Z",
  endDate: "2024-01-31T23:59:59Z",
  timeBucket: "day"
};
const result: BulkAggregateQuestionResultsResponse1 = await bulkAggregateQuestionResults(
  tenantId,
  request,
  true
);

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

Örnek

combineCommentsWithQuestionResults Örneği

Copy

const tenantId: string = "tenant_12345";
const questionIds: string[] = ["question_1", "question_2"];
const urlId: string = "article-9876";
const startDate: Date = new Date("2023-01-01T00:00:00Z");
const forceRecalculate: boolean = false;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResultsResponse = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

addSSOUser

Parameters

Name	Type	Required	Description
tenantId	string	Evet
createAPISSOUserData	CreateAPISSOUserData	Evet

Response

Döndürür: AddSSOUserAPIResponse

Example

addSSOUser Örneği

Copy

const tenantId: string = "tenant_12345";
const newUser: CreateAPISSOUserData = {
  userId: "sso_user_987",
  name: "Jane Doe",
  email: "jane.doe@example.com",
  // optional field
  avatarUrl: "https://example.com/avatars/jane.jpg",
};
const result: AddSSOUserAPIResponse = await addSSOUser(tenantId, newUser);

deleteSSOUser

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

Yanıt

Döndürür: DeleteSSOUserAPIResponse

Örnek

deleteSSOUser Örneği

Copy

const tenantId: string = "acme-corp-tenant";
const userId: string = "sso-user-42";
const deleteComments: boolean = true;
const commentDeleteMode: string = "hard";
const detailedResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId,
  deleteComments,
  commentDeleteMode
);
const simpleResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId
);

getSSOUserByEmail

Parametreler

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

Yanıt

Döndürür: GetSSOUserByEmailAPIResponse

Örnek

getSSOUserByEmail Örneği

Copy

async function fetchSSOUser() {
  const tenantId: string = "tenant_12345";
  const email: string = "john.doe@example.com";
  const result: GetSSOUserByEmailAPIResponse = await getSSOUserByEmail(tenantId, email);
  const user: APISSOUser | undefined = result?.user;
}

getSSOUserById

Parametreler

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

Yanıt

Döner: GetSSOUserByIdAPIResponse

Örnek

getSSOUserById Örneği

Copy

async function fetchUser() {
  const tenantId: string = "tenant-987654321";
  const userId: string = "sso-user-abc123";
  const result: GetSSOUserByIdAPIResponse = await getSSOUserById(tenantId, userId);
  const ssoUser: APISSOUser = result.user;
}

getSSOUsers

Parametreler

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

Yanıt

Returns: GetSSOUsersResponse

Örnek

getSSOUsers Örneği

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    // `skip` opsiyoneli olmadan çağır
    const firstPage: GetSSOUsersResponse = await getSSOUsers(tenantId);
    // `skip` opsiyoneli ile çağır
    const secondPage: GetSSOUsersResponse = await getSSOUsers(tenantId, 100);
    console.log(firstPage, secondPage);
}
runExample();

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

Örnek

patchSSOUser Örneği

Copy

const tenantId: string = "c1f2a3b4-5678-90ab-cdef-1234567890ab";
const userId: string = "user-987654321";
const updateData: UpdateAPISSOUserData = {
  email: "jane.smith@enterprise.com",
  displayName: "Jane Smith",
  role: "editor"
};
const responseWithComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData,
  true
);
const responseWithoutComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData
);

putSSOUser

Parametreler

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

Yanıt

Döndürür: PutSSOUserAPIResponse

Örnek

putSSOUser Örneği

Copy

(async () => {
  const tenantId: string = "tenant_abc123";
  const userId: string = "user_456def";
  const updateData: UpdateAPISSOUserData = {
    email: "jane.doe@example.com",
    displayName: "Jane Doe",
    isActive: true,
  };
  const response: PutSSOUserAPIResponse = await putSSOUser(tenantId, userId, updateData, true);
})();

createSubscription

Parametreler

Ad	Tip	Gerekli	Açıklama
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

Yanıt

Döndürür: CreateSubscriptionAPIResponse

Örnek

createSubscription Örneği

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const subscriptionData: CreateAPIUserSubscriptionData = {
        userId: "user-456",
        planId: "premium-monthly",
        startDate: new Date(),
        trialPeriodDays: 14 // isteğe bağlı alan
    };
    const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, subscriptionData);
    console.log(result);
})();

deleteSubscription

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
id	string	Yes
userId	string	No

Yanıt

Döndürür: DeleteSubscriptionAPIResponse

Örnek

deleteSubscription Örneği

Copy

(async () => {
  const tenantId: string = "tenant_9876";
  const subscriptionId: string = "sub_54321";
  const userId: string = "user_abc123";
  // With optional userId
  const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  // Without optional userId
  const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
})();

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

(async () => {
    const tenantId: string = "acme-corp-123";
    const userId: string = "user-789";
    const responseWithUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
    const responseWithoutUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
})();

updateSubscription

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

Yanıt

Döndürür: UpdateSubscriptionAPIResponse

Örnek

updateSubscription Örneği

Copy

const tenantId: string = "tenant_12345";
const subscriptionId: string = "sub_98765";
const updateData: UpdateAPIUserSubscriptionData = {
  planId: "premium_plan",
  status: "active",
  renewalDate: "2024-12-31",
};
const userId: string = "user_abcde";
const response: UpdateSubscriptionAPIResponse = await updateSubscription(
  tenantId,
  subscriptionId,
  updateData,
  userId
);

getTenantDailyUsages

Parametreler

Name	Type	Required
tenantId	string	Yes
yearNumber	number	No
monthNumber	number	No
dayNumber	number	No
skip	number	No

Yanıt

Döndürür: GetTenantDailyUsagesResponse1

Örnek

getTenantDailyUsages Örneği

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // Mayıs
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // Yalnızca gerekli ve bir isteğe bağlı parametre kullanarak
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

createTenantPackage

Parametreler

İsim	Tür	Gerekli	Açıklama
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	Yes

Yanıt

Döndürür: CreateTenantPackageResponse1

Örnek

createTenantPackage Örneği

Copy

(async () => {
  const tenantId: string = "tenant-9876";
  const body: CreateTenantPackageBody = {
    packageName: "Standard",
    quota: 5000,
    // opsiyonel alan
    description: "Standard package for medium traffic",
  };
  const result: CreateTenantPackageResponse1 = await createTenantPackage(tenantId, body);
  console.log(result);
})();

deleteTenantPackage

Parametreler

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

Yanıt

Döndürür: DeleteTenantPackageResponse

Örnek

deleteTenantPackage Örneği

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // sonucu gerektiği gibi kullan
}
removeTenantPackage();

getTenantPackage

Parametreler

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

Yanıt

Döndürür: GetTenantPackageResponse1

Örnek

getTenantPackage Örneği

Copy

async function fetchTenantPackage(): Promise<void> {
    const tenantId: string = "acme-tenant-2024";
    const packageId: string = "premium-package-01";
    const response: GetTenantPackageResponse1 = await getTenantPackage(tenantId, packageId);
    // Yanıttaki isteğe bağlı alanlar
    const tenantPackage: TenantPackage | undefined = response.tenantPackage;
    const customConfig: CustomConfigParameters | undefined = response.customConfigParameters;
}

getTenantPackages

Parametreler

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

Yanıt

Döndürür: GetTenantPackagesResponse1

Örnek

getTenantPackages Örneği

Copy

(async () => {
  const tenantId: string = 'tenant_67890';
  const skip: number = 30;
  const packagesWithSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId, skip);
  const packagesWithoutSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId);
  console.log(packagesWithSkip, packagesWithoutSkip);
})();

replaceTenantPackage

Parameters

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

Yanıt

Döndürür: ReplaceTenantPackageResponse

Örnek

replaceTenantPackage Örneği

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // buraya özel yapılandırma alanları
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // isteğe bağlı özel yapılandırma
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

updateTenantPackage

Parametreler

Name	Type	Required
tenantId	string	Evet
id	string	Evet
updateTenantPackageBody	UpdateTenantPackageBody	Evet

Yanıt

Döndürür: UpdateTenantPackageResponse

Örnek

updateTenantPackage Örneği

Copy

const tenantId: string = "tenant-9876";
const packageId: string = "pkg-2023";
const customConfig: CustomConfigParameters = {
  enableSpamFilter: true,
  spamRatingThreshold: 4,
};
const updateBody: UpdateTenantPackageBody = {
  displayName: "Enterprise Pro",
  customConfig,
};
const response: UpdateTenantPackageResponse = await updateTenantPackage(
  tenantId,
  packageId,
  updateBody
);

createTenantUser

Parametreler

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

Yanıt

Döndürür: CreateTenantUserResponse1

Örnek

createTenantUser Örneği

Copy

const tenantId: string = "a1b2c3d4-5678-90ab-cdef-1234567890ab";
const newUser: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "admin",
  // isteğe bağlı parametreler
  phoneNumber: "+15551234567",
  isActive: true,
};
const result: CreateTenantUserResponse1 = await createTenantUser(tenantId, newUser);

deleteTenantUser

Parametreler

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

Yanıt

Döndürür: DeleteTenantUserResponse

Örnek

deleteTenantUser Örneği

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // Kullanıcıyı ve tüm yorumlarını, kalıcı silme modunu kullanarak sil
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // Yorumları kaldırmadan kullanıcıyı sil (varsayılan davranış)
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

getTenantUser

Parametreler

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

Yanıt

Döndürür: GetTenantUserResponse1

Örnek

getTenantUser Örnek

Copy

async function fetchUser(): Promise<void> {
  const tenantId: string = "tenant-01a2b3c";
  const userId: string = "user-7890";
  const result: GetTenantUserResponse1 = await getTenantUser(tenantId, userId);
  console.log(result);
}

getTenantUsers

Parametreler

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

Yanıt

Döndürür: GetTenantUsersResponse1

Örnek

getTenantUsers Örneği

Copy

(async () => {
  const tenantId: string = "tenant_9f7a2c";
  const skip: number = 25;
  const usersPage: GetTenantUsersResponse1 = await getTenantUsers(tenantId, skip);
  const allUsers: GetTenantUsersResponse1 = 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: ReplaceTenantUserResponse

Örnek

replaceTenantUser Örneği

Copy

async function updateUser() {
  const tenantId: string = "c3d1f2e4-5b6a-4c7d-9f2e-1234567890ab";
  const userId: string = "u-654321";
  const replaceBody: ReplaceTenantUserBody = {
    email: "newuser@example.com",
    username: "newusername"
  };
  const response: ReplaceTenantUserResponse = await replaceTenantUser(
    tenantId,
    userId,
    replaceBody,
    "true"
  );
  console.log(response);
}
updateUser();

sendLoginLink

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
id	string	Yes
redirectURL	string	No

Yanıt

Döndürür: SendLoginLinkResponse

Örnek

sendLoginLink Örneği

Copy

async function demoSendLoginLink() {
  const tenantId: string = "acme-corp";
  const userId: string = "user-9876";
  const redirectURL: string = "https://app.acme-corp.com/auth/callback";
  const resultWithRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId, redirectURL);
  const resultWithoutRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId);
}

updateTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateTenantUserBody	UpdateTenantUserBody	Yes
updateComments	string	No

Response

Döndürür: UpdateTenantUserResponse

Örnek

updateTenantUser Örneği

Copy

let tenantId: string = "5f8f8c1a2e9b3c001c2a9b2d";
let userId: string = "user_98765";
let updateBody: UpdateTenantUserBody = {
  email: "jane.smith@example.com",
  role: "moderator",
  isActive: false,
};
let updateComments: string = "Deactivated user due to policy violation.";
let result: UpdateTenantUserResponse = await updateTenantUser(tenantId, userId, updateBody, updateComments);

createTenant

Parametreler

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

Yanıt

Döndürür: CreateTenantResponse1

Örnek

createTenant Örneği

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // gerekli alanlar
    name: 'Acme International',
    // isteğe bağlı alanlar gerektiği gibi eklenebilir, örn.:
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

deleteTenant

Parametreler

Name	Type	Required
tenantId	string	Yes
id	string	Yes
sure	string	No

Yanıt

Döndürür: DeleteTenantResponse

Örnek

deleteTenant Örneği

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // 'sure' parametresiyle istekte bulun
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // 'sure' parametresi olmadan istekte bulun
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

getTenant

Parametreler

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

Yanıt

Döndürür: GetTenantResponse1

Örnek

getTenant Örneği

Copy

async function fetchTenant(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const id: string = "user_9876";
  const tenantInfo: GetTenantResponse1 = await getTenant(tenantId, id);
  console.log(tenantInfo);
}
fetchTenant();

getTenants

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
meta	string	No
skip	number	No

Yanıt

Döndürür: GetTenantsResponse1

Örnek

getTenants Örneği

Copy

(async () => {
  const tenantId: string = "tenant-9f8e7d6c";
  const resultOnlyId: GetTenantsResponse1 = await getTenants(tenantId);
  const resultWithMeta: GetTenantsResponse1 = await getTenants(tenantId, "full");
  const resultAllParams: GetTenantsResponse1 = await getTenants(tenantId, "full", 15);
  console.log(resultOnlyId, resultWithMeta, resultAllParams);
})();

updateTenant

Parametreler

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

Yanıt

Döndürür: UpdateTenantResponse

Örnek

updateTenant Örneği

Copy

const tenantId: string = "c8f9e3d2-4b6a-11ee-8c99-0242ac130003";
const id: string = "tenant-config-01";
const updateBody: UpdateTenantBody = {
  domain: "mytenant.fastcomments.io",
  branding: {
    logoUrl: "https://cdn.mytenant.com/assets/logo.png"
  },
  description: "Branding update for Q3"
};
const response: UpdateTenantResponse = await updateTenant(tenantId, id, updateBody);
console.log(response);

changeTicketState

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
userId	string	Yes
id	string	Yes
changeTicketStateBody	ChangeTicketStateBody	Yes

Yanıt

Döndürür: ChangeTicketStateResponse1

Örnek

changeTicketState Örneği

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-97123";
const ticketId: string = "ticket-45001";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  // body içinde isteğe bağlı alan
  comment: "Issue resolved after code fix"
};
const response: ChangeTicketStateResponse1 = await changeTicketState(
  tenantId,
  userId,
  ticketId,
  changeTicketStateBody
);

createTicket

Parametreler

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

Yanıt

Döndürür: CreateTicketResponse1

Örnek

createTicket Örneği

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string isteğe bağlıdır ve atlanmıştır
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// Yanıttan isteğe bağlı bir alanın kullanım örneği
// console.log(response.ticket?.id);

getTicket

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
id	string	Yes
userId	string	No

Yanıt

Döndürür: GetTicketResponse1

Örnek

getTicket Örneği

Copy

const tenantId: string = "acme-inc";
const ticketId: string = "ticket-3421";
const userId: string = "alice.smith";
const ticketWithUser: GetTicketResponse1 = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicketResponse1 = 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: GetTicketsResponse1

Örnek

getTickets Örneği

Copy

async function loadTickets() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const state: number = 2; // ör. kapalı
  const skip: number = 10;
  const limit: number = 5;
  const ticketsFull: GetTicketsResponse1 = await getTickets(tenantId, userId, state, skip, limit);
  const ticketsPartial: GetTicketsResponse1 = await getTickets(tenantId);
}
loadTickets();

getTranslations

Parametreler

Ad	Tip	Gerekli
namespace	string	Yes
component	string	Yes
locale	string	No
useFullTranslationIds	boolean	No

Yanıt

Döndürür: GetTranslationsResponse1

Örnek

getTranslations Örneği

Copy

(async () => {
  const namespace: string = 'blog';
  const component: string = 'comment-editor';
  const locale: string = 'fr-FR';
  const useFullTranslationIds: boolean = true;
  const basicTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component);
  const fullTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component, locale, useFullTranslationIds);
})();

uploadImage

Upload and resize an image

Parameters

Ad	Tür	Gerekli
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

Response

Döndürür: UploadImageResponse

Example

uploadImage Örneği

Copy

const tenantId: string = "acme-tenant-01";
const imageBlob: Blob = new Blob([new Uint8Array([137,80,78,71])], { type: "image/png" });
const uploadResult1: UploadImageResponse = await uploadImage(tenantId, imageBlob);
const sizePreset: SizePreset = { presetName: "medium" };
const urlId: string = "article-9876";
const uploadResult2: UploadImageResponse = await uploadImage(tenantId, imageBlob, sizePreset, urlId);

getUserBadgeProgressById

Parametreler

Name	Type	Required	Description
tenantId	string	Evet
id	string	Evet

Yanıt

Döndürür: GetUserBadgeProgressByIdResponse

Örnek

getUserBadgeProgressById Örneği

Copy

async function demo(): Promise<void> {
    const tenantId: string = "acme-corp";
    const userId: string = "user-42";
    const result: GetUserBadgeProgressByIdResponse = await getUserBadgeProgressById(tenantId, userId);
    const progress: UserBadgeProgress | undefined = result.progress;
    const earnedAt: Date | undefined = progress?.earnedAt;
    console.log(`Badge earned at: ${earnedAt?.toISOString() ?? "not earned yet"}`);
}
demo();

getUserBadgeProgressByUserId

Parametreler

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

Yanıt

Döndürür: GetUserBadgeProgressByUserIdResponse

Örnek

getUserBadgeProgressByUserId Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const userId: string = "user-12345";
  const badgeProgress: GetUserBadgeProgressByUserIdResponse = await getUserBadgeProgressByUserId(tenantId, userId);
  console.log(badgeProgress);
})();

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

Örnek

getUserBadgeProgressList Örneği

Copy

async function fetchBadgeProgress() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe@example.com";
  const limit: number = 10;
  const skip: number = 5;
  const fullList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(
    tenantId,
    userId,
    limit,
    skip
  );
  const simpleList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(tenantId);
}
fetchBadgeProgress();

createUserBadge

Parametreler

Name	Type	Required	Açıklama
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

Yanıt

Döndürür: CreateUserBadgeResponse

Örnek

createUserBadge Örneği

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // açıklama isteğe bağlıdır ve burada atlanmıştır
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

deleteUserBadge

Parametreler

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

Yanıt

Döndürür: DeleteUserBadgeResponse

Örnek

deleteUserBadge Örneği

Copy

async function exampleDeleteBadge(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6a";
  const badgeId: string = "badge_4e3d2c1b";
  const result: DeleteUserBadgeResponse = await deleteUserBadge(tenantId, badgeId);
  console.log(result);
}
exampleDeleteBadge();

getUserBadge

Parametreler

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

Yanıt

Döndürür: GetUserBadgeResponse

Örnek

getUserBadge Örneği

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-001";
  const badgeId: string = "badge-5f9d3a2b";
  const badgeResponse: GetUserBadgeResponse = await getUserBadge(tenantId, badgeId);
  // Opsiyonel alanlara güvenli bir şekilde erişin
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

getUserBadges

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

Yanıt

Döndürür: GetUserBadgesResponse

Örnek

getUserBadges Örneği

Copy

async function example() {
  const tenantId: string = "tenant-01";
  const userId: string = "user-42";
  const badgeId: string = "badge-gold";
  const type: number = 1;
  const displayedOnComments: boolean = true;
  const limit: number = 10;
  const skip: number = 5;
  const fullResult: GetUserBadgesResponse = await getUserBadges(
    tenantId,
    userId,
    badgeId,
    type,
    displayedOnComments,
    limit,
    skip
  );
  const minimalResult: GetUserBadgesResponse = await getUserBadges(tenantId);
}
example();

updateUserBadge

Parametreler

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

Yanıt

Döndürür: UpdateUserBadgeResponse

Örnek

updateUserBadge Örneği

Copy

async function applyBadge() {
    const tenantId: string = "acme-corp-tenant";
    const userId: string = "user-98765";
    const params: UpdateUserBadgeParams = {
        badgeId: "gold-contributor",
        // isteğe bağlı alan örneği
        expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
    };
    const result: UpdateUserBadgeResponse = await updateUserBadge(tenantId, userId, params);
    console.log(result);
}
applyBadge();

getUserNotificationCount

Parametreler

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

Yanıt

Döndürür: GetUserNotificationCountResponse1

Örnek

getUserNotificationCount Örneği

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // İsteğe bağlı SSO belirteciyle çağır
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // SSO belirteci olmadan çağır
    const countWithoutSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId
    );
    console.log(countWithSSO, countWithoutSSO);
}

getUserNotifications

Parametreler

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

Yanıt

Döndürür: GetUserNotificationsResponse

Örnek

getUserNotifications Örneği

Copy

async function fetchUserNotifications() {
    const tenantId: string = "tenant_9f4b2c";
    const urlId: string = "post_1234";
    const pageSize: number = 25;
    const afterId: string = "notif_5678";
    const includeContext: boolean = true;
    const unreadOnly: boolean = false;
    const dmOnly: boolean = false;
    const includeTranslations: boolean = true;
    const notifications: GetUserNotificationsResponse = await getUserNotifications(
        tenantId,
        urlId,
        pageSize,
        afterId,
        includeContext,
        undefined,
        unreadOnly,
        dmOnly,
        undefined,
        includeTranslations,
        undefined,
        undefined
    );
    console.log(notifications);
}

resetUserNotificationCount

Parametreler

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

Yanıt

Döner: ResetUserNotificationCountResponse

Örnek

resetUserNotificationCount Örneği

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // Opsiyonel sso parametresi ile çağır
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // Opsiyonel sso parametresi olmadan çağır
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

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

Örnek

resetUserNotifications Örneği

Copy

(async () => {
  const tenantId: string = "tenant-001";
  const afterId: string = "notif-123";
  const afterCreatedAt: number = 1697049600; // örnek UNIX zaman damgası
  const unreadOnly: boolean = true;
  const dmOnly: boolean = false;
  const noDm: boolean = false;
  const sso: string = "sso-token-xyz";
  const result: ResetUserNotificationsResponse1 = await resetUserNotifications(
    tenantId,
    afterId,
    afterCreatedAt,
    unreadOnly,
    dmOnly,
    noDm,
    sso
  );
  console.log(result);
})();

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Yanıt

Döndürür: UpdateUserNotificationCommentSubscriptionStatusResponse

Örnek

updateUserNotificationCommentSubscriptionStatus Örneği

Copy

const tenantId: string = "tenant_12345";
const notificationId: string = "notif_9876";
const commentId: string = "comment_abc123";
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum =
  UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = "ssoTokenXYZ";
const responseWithSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId,
    sso
  );
const responseWithoutSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId
  );

updateUserNotificationPageSubscriptionStatus

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

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

Yanıt

Döndürür: UpdateUserNotificationPageSubscriptionStatusResponse

Örnek

updateUserNotificationPageSubscriptionStatus Örneği

Copy

(async () => {
  const tenantId: string = "tenant-2024";
  const urlId: string = "page-5678";
  const url: string = "https://example.com/articles/typescript-tips";
  const pageTitle: string = "Top TypeScript Tips";
  const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum =
    UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
  const sso: string = "sso-token-xyz";
  const resultWithSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed,
    sso
  );
  const resultWithoutSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed
  );
})();

updateUserNotificationStatus

Parametreler

Ad	Tür	Gerekli
tenantId	string	Evet
notificationId	string	Evet
newStatus	UpdateUserNotificationStatusNewStatusEnum	Evet
sso	string	Hayır

Yanıt

Döndürür: UpdateUserNotificationStatusResponse

Örnek

updateUserNotificationStatus Örneği

Copy

const tenantId: string = "acme-corp";
const notificationId: string = "notif-20231101-001";
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Dismissed;
const ssoToken: string = "sso-9f8e7d6c5b4a";
const result: UpdateUserNotificationStatusResponse = await updateUserNotificationStatus(
  tenantId,
  notificationId,
  newStatus,
  ssoToken
);

getUserPresenceStatuses

Parametreler

Ad	Tür	Zorunlu
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

Yanıt

Döndürür: GetUserPresenceStatusesResponse1

Örnek

getUserPresenceStatuses Örneği

Copy

async function fetchUserPresences() {
  const tenantId: string = "tenant_9f8e2d";
  const urlIdWS: string = "blog.mycompany.com/thread/12345";
  const userIds: string = "alice,bob,carol";
  const result: GetUserPresenceStatusesResponse1 = await getUserPresenceStatuses(
    tenantId,
    urlIdWS,
    userIds
  );
  console.log(result);
}

searchUsers

Parametreler

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

Yanıt

Döndürür: SearchUsersResponse1

Örnek

searchUsers Örneği

Copy

async function demoSearch(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "article-9876";
    const usernameStartsWith: string = "john";
    const mentionGroupIds: string[] = ["groupA", "groupB"];
    const sso: string = "sso_abc123";
    const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Users;
    const response: SearchUsersResponse1 = await searchUsers(
        tenantId,
        urlId,
        usernameStartsWith,
        mentionGroupIds,
        sso,
        searchSection
    );
    console.log(response);
}
demoSearch();

getUser

Parametreler

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

Yanıt

Döndürür: GetUserResponse1

Örnek

getUser Örneği

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const userId: string = "user_98765";
  const result: GetUserResponse1 = await getUser(tenantId, userId);
})();

createVote

Parametreler

Ad	Tür	Gerekli
tenantId	string	Yes
commentId	string	Yes
direction	CreateVoteDirectionEnum	Yes
userId	string	No
anonUserId	string	No

Yanıt

Döndürür: CreateVoteResponse

Örnek

createVote Örneği

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "comment_987654";
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Upvote;
const userId: string = "user_7f9a2b";
const voteResult: CreateVoteResponse = await createVote(
  tenantId,
  commentId,
  direction,
  userId
);

deleteVote

Parametreler

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

Yanıt

Döndürür: DeleteVoteResponse

Örnek

deleteVote Örneği

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-9876";
  const editKey: string = "edit-key-123";
  const resultWithEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId, editKey);
  const resultWithoutEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId);
})();

getVotes

Parametreler

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

Yanıt

Döndürür: GetVotesResponse1

Örnek

getVotes Örneği

Copy

async function fetchVotes(): Promise<void> {
  const tenantId: string = "acme-corp-01";
  const urlId: string = "article-2024-05-15";
  const response: GetVotesResponse1 = await getVotes(tenantId, urlId);
  // Yanıt içinde isteğe bağlı bir alanı erişme örneği
  const firstVoteId: string | undefined = response?.votes?.[0]?.id;
}

getVotesForUser

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userId	string	No
anonUserId	string	No

Response

Returns: GetVotesForUserResponse1

Example

getVotesForUser Örneği

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const urlId: string = "post-9f8b7c";
  const userId: string = "user-42";
  const anonUserId: string = "anon-123";
  const votesRequiredOnly: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId);
  const votesWithUserId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, userId);
  const votesWithAnonId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, undefined, anonUserId);
}
demo();

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

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

Katkıda Bulunma

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

Dil 🇹🇷 Türkçe

Başlarken

API Referansı

Dokümantasyon

Kullanım

Toplama

Denetim Kayıtları

Yorumdan Engelleme

Engellenen Yorumları Kontrol Etme

Yorumlar

Kullanıcı İçin Yorumlar

Alan Adı Yapılandırmaları

E-posta Şablonları

Olay Günlüğü

Akış Gönderileri

Yorumu Bildir

GIF'ler

Hashtag'ler

Moderasyon

Moderatörler

Bildirim Sayısı

Bildirimler

Sayfa Tepkileri

Sayfalar

Bekleyen Webhook Olayları

Soru Yapılandırmaları

Soru Sonuçları

Soru Sonuçları Toplaması

SSO Kullanıcıları

Abonelikler

Kiracı Günlük Kullanımı

Kiracı Paketleri

Kiracı Kullanıcıları

Kiracılar

Biletler

Çeviriler

Resim Yükle

Kullanıcı Rozet İlerlemesi

Kullanıcı Rozetleri

Kullanıcı Bildirimleri

Kullanıcı Varlık Durumları

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ı

Genel ve Güvenli API'ler

Örnek: Public API Kullanımı (tarayıcıda güvenli)

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

Örnek: Moderation API Kullanımı

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

Bir Sayfa İçin Yorumları Alma

Yorum Oluşturma

Bir Yorum İçin Oy Verme

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

Canlı Olaylar (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