FastComments JavaScript/TypeScript SDK

npm install fastcomments-sdk

מדריך API מלא: docs/api/README.md

ה-SDK הזה משתמש ב-שתי נקודות כניסה כדי להבטיח תאימות מיטבית ולמנוע שגיאות בזמן ריצה:

• fastcomments-sdk/browser - גרסה בטוחה לדפדפן עם fetch מובנה
• fastcomments-sdk/server - גרסה מלאה ל-Node.js עם תמיכה ב-SSO
• fastcomments-sdk (ברירת מחדל) - טיפוסים בלבד, בטוח לייבא בכל מקום

The SDK מספק שלוש מחלקות API עיקריות:

• DefaultApi - נקודות קצה מאובטחות שדורשות את מפתח ה-API שלך לאימות. השתמש בהן עבור פעולות בצד השרת.
• PublicApi - נקודות קצה ציבוריות שניתן לגשת אליהן ללא מפתח API. ניתן לקרוא להן ישירות מדפדפנים/מכשירים ניידים/וכו'.
• HiddenApi - נקודות קצה פנימיות/מנהליות לשימושים מתקדמים.

דוגמה: שימוש ב-Public API (בטוח לדפדפן)

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

const publicApi = new PublicApi();

// קבל תגובות עבור דף (אין צורך במפתח API)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

דוגמה: שימוש ב-Default API (צד שרת בלבד)

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

const config = new Configuration({
  apiKey: 'your-api-key' // שמור זאת בסוד!
});
const defaultApi = new DefaultApi(config);

// קבל תגובות עם גישה מנהלית מלאה
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

FastComments תומך ב-SSO כדי להשתלב במערכת אימות המשתמשים הקיימת שלך. פונקציונליות SSO זמינה רק בגרסת השרת מכיוון שהיא דורשת יכולות crypto של Node.js.

SSO פשוט (צד שרת בלבד)

יש ליצור SSO פשוט בצד השרת ולשלוח אותו אל הלקוח:

// קוד צד שרת (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// יצירת SSO פשוט באמצעות עזר מובנה  
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 לקוד בצד הלקוח
// קוד בצד הלקוח יכול אז להשתמש בטוקן זה עם ה-SDK לדפדפן

SSO מאובטח (צד שרת, מומלץ)

יש ליישם SSO מאובטח בצד השרת והוא מספק אבטחה טובה יותר:

// קוד צד שרת (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// יצירת SSO מאובטח באמצעות העזר המובנה
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();

// Use with API calls on the server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Or send ssoConfig to client for browser usage

שימוש ב-SSO מהדפדפן (עם טוקן שנוצר בשרת)

// קוד בצד הלקוח (דפדפן)
import { PublicApi } from 'fastcomments-sdk/browser';

// קבל טוקן SSO מנקודת הקצה של השרת שלך
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 // השתמש בטוקן SSO שנוצר בשרת
});

SSO עם יצירת תגובה

// צד שרת: צור SSO ותגובה
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)
});

קבלת תגובות לעמוד

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

יצירת תגובה

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

הצבעה על תגובה

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 להצבעה בעד, -1 להצבעה נגד
  }
});

ניהול משתמשים (דורש מפתח API)

// חפש משתמשים (דורש DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

הירשם לאירועים חיים כדי לקבל עדכונים בזמן אמת על תגובות, הצבעות ופעילויות נוספות.

אירועים ברמת הדף

האזן לאירועים חיים בדף מסוים (תגובות, הצבעות וכו׳):

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

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

// הירשם לאירועים חיים עבור דף
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (קבל זאת מתוך התגובה של getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // עדכן את ממשק המשתמש שלך עם התגובה החדשה
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // עדכן את ספירות ההצבעות בממשק המשתמש שלך
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // החזר true אם האירוע טופל
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// סגור את המנוי כשסיימת
subscription.close();

הירשם לאירועי משתמש

האזן לאירועים ספציפיים למשתמש (התראות, אזכורים וכו׳):

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

const userConfig = {
  userIdWS: 'user-session-id', // Get this from getComments response
};

// הירשם לפיד האישי של המשתמש
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // הצג הודעה בממשק המשתמש שלך
        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');
  }
);

// סגור כשסיימת
userSubscription.close();

קבלת userIdWS

פרמטר userIdWS נדרש עבור אירועים חיים וניתן להשיגו מתשובות API:

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

// חלץ את userIdWS מהתגובה
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // כעת אתה יכול להירשם לאירועים חיים
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

תראה שעליך להעביר broadcastId בחלק מקריאות ה-API. כשאתה מקבל אירועים, תקבל חזרה את ה‑ID הזה, כך תדע להתעלם מהאירוע אם אתה מתכנן ליישם שינויים באופטימיות מצד הלקוח (מה שסביר שתרצה לעשות כיוון שזה מספק את חוויית המשתמש הטובה ביותר). העבר כאן UUID. ה‑ID צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים באותו מושב בדפדפן.

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() // מזהה ייחודי לפעולה זו
  }
});

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);
  }
}

מאחד מסמכים על ידי קיבוצם (אם נמסר groupBy) ויישום מספר פעולות. נתמכות פעולות שונות (למשל sum, countDistinct, avg וכו').

פרמטרים

תגובה

מחזיר: AggregationResponse

פרמטרים

תגובה

מחזיר: GetAuditLogs200Response

דוגמה

דוגמה ל-getAuditLogs

Copy

1

2async function main(): Promise<void> {

3 const tenantId: string = 'tenant_9b8f6c';

4 const limit: number = 50;

5 const skip: number = 0;

6 const order: SORTDIR = 'desc';

7 const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000;

8 const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after);

9 console.log(response);

10}

11main();

12

פרמטרים

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-blockFromCommentPublic

Copy

1

2const tenantId: string = "site_7f9b2e";

3const commentId: string = "comment_2026-03-25_001";

4const publicBlockFromCommentParams: PublicBlockFromCommentParams = {

5 reason: "Repeated harassment and targeted abuse",

6 blockDurationDays: 90,

7 includeHistory: true,

8 notifyModeratorTeam: true

9};

10const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";

11const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

12

פרמטרים

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה ל-unBlockCommentPublic

Copy

1

2const tenantId: string = 'tenant_42e8a1';

3const commentId: string = 'cmt_9b3f2d';

4const publicBlockFromCommentParams: PublicBlockFromCommentParams = {

5 reason: 'abusive_language',

6 blockedByModeratorId: 'mod_17',

7 note: 'Targeted harassment; review complete',

8 unblockRequestedAt: new Date().toISOString()

9};

10const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';

11const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

12

פרמטרים

תגובה

מחזיר: CheckedCommentsForBlocked200Response

דוגמה

דוגמה ל-checkedCommentsForBlocked

Copy

1

2const tenantId: string = 'tenant_4f3b2a1e';

3const commentIds: string = 'c_1001,c_1002,c_1003';

4const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';

5

6const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);

7const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

8

פרמטרים

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-blockUserFromComment

Copy

1

2const tenantId: string = "tenant_12345";

3const id: string = "comment_67890";

4const blockFromCommentParams: BlockFromCommentParams = {

5 reason: "Repeated abusive language",

6 blockDurationHours: 168,

7 blockReplies: true,

8 notifyAuthor: true

9};

10const userId: string = "user_abc123";

11const anonUserId: string = "anon_xyz789";

12const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

13

פרמטרים

תגובה

מחזיר: CreateCommentPublic200Response

דוגמה

דוגמת createCommentPublic

Copy

1

2const tenantId: string = 'tenant_prod_42';

3const urlId: string = 'article-2026-03-25-tech-deep-dive';

4const broadcastId: string = 'live-broadcast-001';

5const sessionId: string = 'sess_9f8e7d6a3b';

6const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';

7const commentData: CommentData = {

8 content: 'Great reporting — appreciated the depth on performance tradeoffs.',

9 authorName: 'Jordan M.',

10 language: 'en-US',

11 metadata: { client: 'web' }

12};

13const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

14

פרמטרים

תגובה

מחזיר: DeleteComment200Response

דוגמה

דוגמה ל-deleteComment

Copy

1

2const tenantId: string = 'tenant_7b3f2a';

3const commentId: string = 'cmt_8a1f4d2b';

4const contextUserId: string = 'user_102';

5const isLive: boolean = true;

6const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, isLive);

7

פרמטרים

תגובה

מחזיר: DeleteCommentPublic200Response

דוגמה

דוגמה ל-deleteCommentPublic

Copy

1

2const tenantId: string = 'tenant_4f2c9b';

3const commentId: string = 'comment-7c3a9f2d';

4const broadcastId: string = 'article-2026-03-20';

5const editKey: string | undefined = 'ek_pub_abc12345';

6const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';

7

8const result: DeleteCommentPublic200Response = await deleteCommentPublic(

9 tenantId,

10 commentId,

11 broadcastId,

12 editKey,

13 sso

14);

15

פרמטרים

תגובה

מחזיר: DeleteCommentVote200Response

דוגמה

דוגמה ל-deleteCommentVote

Copy

1

2const tenantId: string = 'acme-tenant-87e4fd';

3const commentId: string = 'cmt-9a12b3f4';

4const voteId: string = 'vote-4f6d21b9';

5const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';

6const broadcastId: string = 'broadcast-20260325-01';

7const editKey: string = 'editkey-6b7c8d9e';

8const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';

9

10const response: DeleteCommentVote200Response = await deleteCommentVote(

11 tenantId,

12 commentId,

13 voteId,

14 urlId,

15 broadcastId,

16 editKey,

17 sso

18);

19

פרמטרים

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמה ל-flagComment

Copy

1

2const tenantId: string = 'tenant_acme_001';

3const id: string = 'comment_7f3a2b9e';

4const userId: string = 'user_jdoe_1001';

5const anonUserId: string = 'anon_3f2b_visitor';

6const result: FlagComment200Response = await flagComment(tenantId, id, userId, anonUserId);

7

פרמטרים

תגובה

מחזיר: GetComment200Response

דוגמה

דוגמת getComment

Copy

1

2const tenantId: string = "acme-publishing-001";

3const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";

4const result: GetComment200Response = await getComment(tenantId, commentId);

5const wrapper: GetComment200Response & { comment?: APIComment } = result;

6const comment: APIComment | undefined = wrapper.comment;

7const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;

8const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

9

פרמטרים

תגובה

מחזיר: GetComments200Response

דוגמה

דוגמת getComments

Copy

1

2const tenantId: string = 'tenant_acme_42';

3const response: GetComments200Response = await getComments(

4 tenantId,

5 1, // page (עמוד)

6 20, // limit (הגבלה)

7 0, // skip (דילוג)

8 true, // asTree (כעץ)

9 1, // skipChildren (דילוג על ילדים)

10 3, // limitChildren (הגבלת ילדים)

11 4, // maxTreeDepth (עומק מרבי של העץ)

12 'articles/2026/new-product-launch', // urlId (מזהה URL)

13 'user_7890', // userId (מזהה משתמש)

14 'anon_4f3b2', // anonUserId (מזהה משתמש אנונימי)

15 undefined, // contextUserId (מזהה משתמש בהקשר)

16 '#launch', // hashTag (האשטאג)

17 undefined // parentId (מזהה הורה)

18);

19

req tenantId urlId

פרמטרים

תגובה

מחזיר: GetCommentsPublic200Response

דוגמה

דוגמה ל-getCommentsPublic

Copy

1

2const tenantId: string = 'tenant_eu-west_01';

3const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';

4const response: GetCommentsPublic200Response = await getCommentsPublic(

5 tenantId,

6 urlId,

7 2,

8 undefined,

9 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',

10 undefined,

11 0,

12 50,

13 5,

14 true,

15 undefined,

16 true,

17 false,

18 true,

19 'en-US',

20 'reactions,moderation',

21 false,

22 true,

23 true,

24 3,

25 false,

26 undefined,

27 'performance',

28 ['feature','fastcomments'],

29 'user_9876',

30 undefined,

31 undefined,

32 undefined

33);

34

פרמטרים

תגובה

מחזיר: GetCommentText200Response

דוגמה

דוגמה ל-getCommentText

Copy

1

2const tenantId: string = 'tenant_acme_001';

3const commentId: string = 'cmt_7890b';

4const editKey: string = 'edit_4f2d9b7c';

5const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';

6

7const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

8

פרמטרים

תשובה

מחזיר: GetCommentVoteUserNames200Response

דוגמה

דוגמה של getCommentVoteUserNames

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_4f2c1e';

4 const commentId: string = 'cmt_9a7b3d';

5 const dir: number = 1;

6 const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);

7 const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';

8 const dirDown: number = -1;

9 const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);

10 console.log(resultUpvotes, resultDownvotes);

11})();

12

פרמטרים

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה ל-lockComment

Copy

1

2const tenantId: string = "tenant_prod_8f3a2b";

3const commentId: string = "cmt_5d7e9a92";

4const broadcastId: string = "broadcast_2026_03_25_1400";

5const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";

6const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);

7const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

8

פרמטרים

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמת pinComment

Copy

1

2const tenantId: string = "tenant_4f2b9a";

3const commentId: string = "cmt_9f8e7d6c";

4const broadcastId: string = "brd_live_concert_2026-03-25";

5const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";

6

7const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

8

פרמטרים

תשובה

מחזיר: SaveComment200Response

דוגמה

דוגמה ל-saveComment

Copy

1

2const tenantId: string = 'tenant_acme_001';

3const createCommentParams: CreateCommentParams = {

4 content: 'Great article — helped me fix a production issue in minutes.',

5 url: 'https://app.acme.com/blog/performance-tips',

6 author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },

7 metadata: { locale: 'en-US', appVersion: '4.2.1' }

8} as CreateCommentParams;

9const isLive: boolean = true;

10const doSpamCheck: boolean = true;

11const sendEmails: boolean = false;

12const populateNotifications: boolean = true;

13const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

14

פרמטרים

תגובה

מחזיר: Array<SaveComment200Response

דוגמה

דוגמה ל-saveCommentsBulk

Copy

1

2const tenantId: string = 'acme-corp-01';

3const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];

4const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];

5const createCommentParams: CreateCommentParams[] = [

6 {

7 content: 'Great insights on async/await patterns.',

8 authorName: 'John Smith',

9 authorEmail: 'john.smith@acme.com',

10 externalId: 'comment-001',

11 createdAt: '2026-03-25T10:15:00Z',

12 userMentions: mentions1,

13 userHashTags: hashtags1

14 },

15 {

16 content: 'I prefer using Promise.all for bulk ops.',

17 authorName: 'Emily Turner',

18 authorEmail: 'emily.turner@acme.com',

19 externalId: 'comment-002',

20 createdAt: '2026-03-25T10:20:00Z'

21 }

22];

23const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

24

פרמטרים

תגובה

מחזיר: SetCommentText200Response

דוגמה

דוגמה ל-setCommentText

Copy

1

2const tenantId: string = 'tenant_6721f4';

3const commentId: string = 'cmt_9a3b2d';

4const broadcastId: string = 'live_2026_03_25';

5const editKey: string = 'edit_k_4f7b9';

6const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';

7const commentTextUpdateRequest: CommentTextUpdateRequest = {

8 text: 'Updated to clarify the timeline and link the relevant docs.',

9 mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],

10 hashtags: [{ tag: 'product-update' }]

11};

12const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

13

פרמטרים

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה של unBlockUserFromComment

Copy

1

2const tenantId: string = 'tenant_87f3e1';

3const id: string = 'comment_9b2a4f';

4const unBlockFromCommentParams: UnBlockFromCommentParams = {

5 reason: 'Reviewed by moderation team — reinstated',

6 moderatorId: 'mod_21',

7 unblockedAt: new Date().toISOString()

8};

9const userId: string = 'user_42';

10const anonUserId: string = 'anon_e7f9';

11const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

12

פרמטרים

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמה ל-unFlagComment

Copy

1

2const tenantId: string = 'acme-tenant-001';

3const commentId: string = 'cmt_9f8e7d6c';

4const userId: string = 'user_72b4a1c9';

5const anonUserId: string = 'anon_3d2c1b0a';

6const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

7

פרמטרים

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה ל-unLockComment

Copy

1

2const tenantId: string = 'tenant_9d4f2b';

3const commentId: string = 'cmt_8a3e1f';

4const broadcastId: string = 'broadcast_2026_03_25';

5const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';

6

7const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

8

פרמטרים

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמה ל-unPinComment

Copy

1

2const tenantId: string = 'tenant_7f9d2a3b';

3const commentId: string = 'comment_842b9c1f';

4const broadcastId: string = 'bcast_frontpage_202603';

5const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';

6

7const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

8

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת updateComment

Copy

1

2const tenantId: string = "tenant_acme_corp_01";

3const id: string = "comment_20260325_4592";

4const updatableCommentParams: UpdatableCommentParams = {

5 body: "Updated the response to include a link to the RFC and fixed a typo in the second paragraph.",

6 editedByUserId: "user_8721",

7 isVisible: true

8};

9const contextUserId: string = "user_8721";

10const doSpamCheck: boolean = true;

11const isLive: boolean = true;

12const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

13

פרמטרים

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמה ל-voteComment

Copy

1

2const tenantId: string = 'tenant_9f8b7c';

3const commentId: string = 'cmt_42f3a1';

4const urlId: string = 'articles/ai-trends-2026';

5const broadcastId: string = 'web';

6const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };

7const sessionId: string = 'sess_6d2b4c9e';

8const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';

9const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

10

פרמטרים

תגובה

מחזיר: AddDomainConfig200Response

פרמטרים

תגובה

מחזיר: DeleteDomainConfig200Response

פרמטרים

תגובה

מחזיר: GetDomainConfig200Response

פרמטרים

תגובה

מחזיר: GetDomainConfigs200Response

פרמטרים

תגובה

מחזיר: GetDomainConfig200Response

פרמטרים

תגובה

מחזיר: GetDomainConfig200Response

פרמטרים

תגובה

מחזיר: CreateEmailTemplate200Response

דוגמה

דוגמה ל-createEmailTemplate

Copy

1

2const tenantId: string = "tenant_7a9f3c2b";

3const customConfig: CustomConfigParameters = { smtpHost: "smtp.fastmail.com", smtpPort: 587, useTLS: true };

4const createEmailTemplateBody: CreateEmailTemplateBody = {

5 name: "Account Notification",

6 subject: "Your ACME account was updated",

7 fromEmail: "no-reply@acme-corp.com",

8 replyTo: "support@acme-corp.com",

9 html: "<p>Hi {{user.firstName}}, your account settings were changed.</p>",

10 text: "Hi {{user.firstName}}, your account settings were changed.",

11 isActive: true,

12 description: "Used for transactional account update emails",

13 customConfig

14};

15const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

16

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteEmailTemplate

Copy

1

2const tenantId: string = 'tenant_7f4c9d1e';

3const templateId: string = 'tmpl_welcome_2024-03';

4const notifyAdmin: boolean | undefined = true; // דוגמה לפרמטר אופציונלי

5

6const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

7

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteEmailTemplateRenderError

Copy

1

2const tenantId: string = 'tenant_7f3b4c2a';

3const templateEnvironment: string | undefined = 'production'; // בורר סביבה אופציונלי

4const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;

5const errorId: string = 'err_5a9d2f1c';

6const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

7console.log(result);

8

פרמטרים

תגובה

מחזיר: GetEmailTemplate200Response

דוגמה

דוגמה ל-getEmailTemplate

Copy

1

2const tenantId: string = "acme-marketing-042";

3const templateId: string = "tpl_welcome_2026";

4const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

5const template: CustomEmailTemplate | undefined = result.template;

6const subject: string | undefined = template?.subject;

7const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

8

פרמטרים

תגובה

מחזיר: GetEmailTemplateDefinitions200Response

דוגמה

getEmailTemplateDefinitions דוגמה

Copy

1

2const tenantId: string = 'tenant_acme_eu_01';

3const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);

4console.log('Email template definitions loaded for', tenantId, templates);

5

פרמטרים

תגובה

מחזיר: GetEmailTemplateRenderErrors200Response

דוגמה

דוגמת getEmailTemplateRenderErrors

Copy

1

2(async () => {

3 const tenantId: string = 'acme-tenant-42';

4 const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';

5 const skip: number = 20;

6 const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);

7 console.log(result);

8})();

9

פרמטרים

תגובה

מחזיר: GetEmailTemplates200Response

דוגמה

דוגמה ל-getEmailTemplates

Copy

1

2async function main(): Promise<void> {

3 const tenantId: string = 'tenant_5f3a9c2b';

4 const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);

5 const skip: number = 20;

6 const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

7 console.log(templates, pagedTemplates);

8}

9main();

10

פרמטרים

תגובה

מחזיר: RenderEmailTemplate200Response

דוגמה

דוגמה של renderEmailTemplate

Copy

1

2const tenantId: string = 'tenant_b6f3c2';

3const renderEmailTemplateBody: RenderEmailTemplateBody = {

4 templateId: 'comment-notification',

5 recipient: { name: 'Ava Thompson', email: 'ava.thompson@publisher.com' },

6 context: {

7 siteName: 'City Gazette',

8 commentText: 'Thanks for the in-depth coverage — very helpful.',

9 articleTitle: 'Downtown Redevelopment Plan Advances',

10 threadUrl: 'https://citygazette.example/articles/2026/redevelopment#comments'

11 }

12};

13const locale: string = 'en-US';

14const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

15

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת updateEmailTemplate

Copy

1

2const tenantId: string = "tenant_76a4b2";

3const id: string = "template_9f3c1e";

4const updateEmailTemplateBody: UpdateEmailTemplateBody = {

5 name: "Comment Flag Notification",

6 subject: "A comment was flagged on your-site.com",

7 bodyHtml: "<p>Admin,</p><p>User {{commenterName}} flagged a comment: “{{commentText}}”</p>",

8 isEnabled: true,

9 description: "Email sent to moderators when a comment is flagged (optional field included)"

10};

11const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

12

req tenantId urlId userIdWS

פרמטרים

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-getEventLog

Copy

1

2const tenantId: string = 'fastcomments-tenant-01';

3const urlId: string = 'article-2026-03-25';

4const userIdWS: string | undefined = undefined; // ערך מקור אופציונלי

5const startTime: number = Date.parse('2026-03-01T00:00:00Z');

6const endTime: number = Date.parse('2026-03-25T23:59:59Z');

7

8const eventLogResponse: GetEventLog200Response = await getEventLog(

9 tenantId,

10 urlId,

11 userIdWS ?? 'ws_user_8b1f',

12 startTime,

13 endTime

14);

15

req tenantId urlId userIdWS

פרמטרים

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-getGlobalEventLog

Copy

1

2const tenantId: string = "tenant-84b2f1";

3const urlId: string = "article-6721";

4const userIdWS: string = "ws-conn-9a3c";

5const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // לפני 7 ימים

6const endTimeOptional: number | undefined = undefined; // סוף טווח זמן אופציונלי

7const endTime: number = endTimeOptional ?? Date.now();

8const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

9

פרמטרים

תגובה

מחזיר: CreateFeedPost200Response

דוגמה

דוגמת createFeedPost

Copy

1

2const tenantId: string = "tenant_7f3b9a";

3const createFeedPostParams: CreateFeedPostParams = {

4 title: "Weekly Product Update — March 2026",

5 body: "We've shipped performance improvements and bug fixes across the web client. See the release notes for details.",

6 authorId: "user_86fa2b",

7 allowComments: true,

8 media: [

9 {

10 url: "https://cdn.example.com/images/update-march.png",

11 mimeType: "image/png",

12 caption: "Performance graph",

13 assets: [{ url: "https://cdn.example.com/images/update-march@2x.png", width: 1600, height: 900 }]

14 }

15 ],

16 links: [{ url: "https://www.example.com/release-notes/march-2026", title: "Release notes" }]

17};

18const broadcastId: string = "broadcast_prod_updates_202603";

19const isLive: boolean = false;

20const doSpamCheck: boolean = true;

21const skipDupCheck: boolean = false;

22const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

23

פרמטרים

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-createFeedPostPublic

Copy

1

2const tenantId: string = "tenant_987654321";

3const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };

4const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };

5const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };

6const createFeedPostParams: CreateFeedPostParams = {

7 title: "Product update — March 2026",

8 content: "<p>We shipped performance improvements and two new integrations.</p>",

9 media: [mediaItem],

10 link,

11 visibility: "public",

12 tags: ["product","release","march-2026"],

13 customConfig: { allowComments: true, requireTOS: false }

14};

15const broadcastId: string = "broadcast_2026_03_25_live";

16const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

17const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

18

פרמטרים

תגובה

מחזיר: DeleteFeedPostPublic200Response

דוגמה

דוגמה ל-deleteFeedPostPublic

Copy

1

2const tenantId: string = "tenant_5f8a9b3c";

3const postId: string = "post_a1b2c3d4";

4const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";

5const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

6

7const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

8const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

9

req tenantId afterId

פרמטרים

תגובה

מחזיר: GetFeedPosts200Response

דוגמה

דוגמת getFeedPosts

Copy

1

2const initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);

3const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

4

req tenantId afterId

פרמטרים

תגובה

מחזיר: GetFeedPostsPublic200Response

דוגמה

דוגמה ל-getFeedPostsPublic

Copy

1

2const tenantId: string = 'tenant_acme_01';

3const afterId: string = 'fp_20260301_042';

4const limit: number = 25;

5const tags: Array<string> = ['technology', 'announcement'];

6const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

7const isCrawler: boolean = false;

8const includeUserInfo: boolean = true;

9const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

10

פרמטרים

תגובה

מחזיר: GetFeedPostsStats200Response

דוגמה

דוגמת getFeedPostsStats

Copy

1

2const tenantId: string = 'tenant_9b2f1c4a';

3const postIds: Array<string> = [

4 '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',

5 'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'

6];

7const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';

8const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);

9const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

10

פרמטרים

תגובה

מחזיר: GetUserReactsPublic200Response

דוגמה

דוגמה ל-getUserReactsPublic

Copy

1

2const tenantId: string = "acme-tenant-8a4d2c";

3const postIds: string[] = ["post-645a2f", "post-645a30"];

4const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

5const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

6

פרמטרים

תגובה

מחזיר: ReactFeedPostPublic200Response

דוגמה

דוגמת reactFeedPostPublic

Copy

1

2const tenantId: string = 'd290f1ee-6c54-4b01-90e6-d701748f0851';

3const postId: string = 'c1a2b3d4-5678-90ab-cdef-1234567890ab';

4const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍', source: 'web' };

5const isUndo: boolean = false;

6const broadcastId: string = 'broadcast-2026-03-25-001';

7const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

8const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, sso);

9

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateFeedPost

Copy

1

2const tenantId: string = 'acme-global-tenant-42';

3const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';

4

5const asset: FeedPostMediaItemAsset = {

6 url: 'https://cdn.acme.com/images/product-launch.jpg',

7 mimeType: 'image/jpeg',

8 width: 1200,

9 height: 630

10};

11

12const mediaItem: FeedPostMediaItem = {

13 id: 'media-001',

14 type: 'image',

15 asset

16};

17

18const link: FeedPostLink = {

19 url: 'https://acme.com/blog/product-launch',

20 title: 'Product Launch Details'

21};

22

23const feedPost: FeedPost = {

24 title: 'Introducing the Q3 Product Suite',

25 body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',

26 media: [mediaItem], // כולל מערך אופציונלי

27 links: [link], // כולל קישורים אופציונליים

28 isPublished: true // דגל פרסום אופציונלי משמש כאן

29};

30

31const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

32

פרמטרים

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-updateFeedPostPublic

Copy

1

2const tenantId: string = "tenant_9f4b2";

3const postId: string = "post_21a8e";

4const updateFeedPostParams: UpdateFeedPostParams = {

5 title: "Quarterly product update",

6 body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",

7 links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],

8 media: [

9 {

10 type: "image",

11 assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]

12 }

13 ]

14};

15const broadcastId: string = "broadcast_live_202603";

16const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";

17const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

18

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-flagCommentPublic

Copy

1

2const tenantId: string = "tenant_9f8b3c";

3const commentId: string = "comment_72a1d4";

4const isFlagged: boolean = true;

5const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

6const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

7

פרמטרים

תגובה

מחזיר: AddHashTag200Response

דוגמה

דוגמה ל-addHashTag

Copy

1

2const tenantId: string = 'tenant_acme_01';

3const createHashTagBody: CreateHashTagBody = {

4 name: 'feature-request',

5 label: 'Feature Request',

6 color: '#FF5722',

7 enabled: true

8};

9const response: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

10const responseWithoutTenant: AddHashTag200Response = await addHashTag(undefined, createHashTagBody);

11

פרמטרים

תגובה

מחזיר: AddHashTagsBulk200Response

דוגמה

דוגמה ל-addHashTagsBulk

Copy

1

2// צור מזהה tenant (פרמטר אופציונלי)

3const tenantId: string = "tenant_9f8c2b7a";

4

5// הכנה של פריטי תג בודדים

6const tag1: BulkCreateHashTagsBodyTagsInner = {

7 name: "product-feedback",

8 label: "Product Feedback",

9 color: "#1f8a70",

10 description: "User suggestions and enhancement requests",

11 isActive: true

12};

13

14const tag2: BulkCreateHashTagsBodyTagsInner = {

15 name: "bug-report",

16 label: "Bug Report",

17 color: "#d64545",

18 description: "User-reported defects and issues",

19 isActive: true

20};

21

22// גוף הבקשה ליצירה בכמות (פרמטר אופציונלי)

23const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {

24 tags: [tag1, tag2]

25};

26

27// קריאה לפונקציה אסינכרונית גלובלית והקצאת התוצאה עם טיפוס

28const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

29

פרמטרים

תשובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteHashTag

Copy

1

2const tag: string = "breaking-news";

3const tenantId: string = "tenant_12345";

4const deleteRequest: DeleteHashTagRequest = { initiatedBy: "moderator@newsorg.com", purgeAllOccurrences: true };

5const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteRequest);

6

פרמטרים

תשובה

מחזיר: GetHashTags200Response

דוגמה

דוגמת getHashTags

Copy

1

2const tenantId: string = 'acme-tenant-42';

3const pageNumber: number = 2;

4const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);

5const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

6

פרמטרים

תגובה

מחזיר: PatchHashTag200Response

דוגמה

דוגמה ל-patchHashTag

Copy

1

2const tag: string = "feature-ux-refresh";

3const tenantId: string = "tenant_4f92c1";

4const updateHashTagBody: UpdateHashTagBody = {

5 label: "UX Refresh",

6 description: "Track comments related to the 2026 UX redesign",

7 isActive: true,

8 metadata: { owner: "product-design", rolloutPhase: "phase-2" }

9};

10const response: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

11

פרמטרים

תגובה

מחזיר: CreateModerator200Response

דוגמה

דוגמת createModerator

Copy

1

2const tenantId: string = 'tenant_7d9f2b4a';

3const customConfig: CustomConfigParameters = { timezone: 'UTC', moderationQueueEnabled: true };

4const createModeratorBody: CreateModeratorBody = {

5 email: 'jane.martin@publisher.com',

6 displayName: 'Jane Martin',

7 roles: ['moderator'],

8 sendWelcomeEmail: true,

9 customConfig

10};

11const response: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

12

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של deleteModerator

Copy

1

2const tenantId: string = 'tenant_9f3b2d4a6c';

3const moderatorId: string = 'moderator_84a1b9c2';

4const sendEmail: string = 'true';

5const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

6

פרמטרים

תגובה

מחזיר: GetModerator200Response

דוגמה

דוגמה ל-getModerator

Copy

1

2const tenantId: string = 'acme-corp-tenant-123';

3const id: string = 'mod-987654321';

4const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

5

פרמטרים

תשובה

מחזיר: GetModerators200Response

דוגמה

דוגמת getModerators

Copy

1

2const tenantId: string = 'tenant-12345-prod';

3const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);

4const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

5

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-sendInvite

Copy

1

2const tenantId: string = 'tenant_acme-42';

3const id: string = 'comment_8f3b21a7';

4const fromName: string = 'Elena Morales';

5const replyToEmail: string | undefined = undefined;

6

7const result: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName, replyToEmail);

8