FastComments SDK ל-JavaScript/TypeScript

זהו ה-SDK הרשמי של JavaScript/TypeScript עבור FastComments.

נהל תגובות, משתמשים, SSO ומודרציה מתוך Node.js או מהדפדפן.

מאגר

התקנה

npm install fastcomments-sdk

תיעוד ה-API

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

תאימות דפדפן מול שרת

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

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

שימוש

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

שימוש בדפדפן (צד-לקוח)

For browser/frontend applications, use the browser-safe export that excludes Node.js dependencies:

// ייבוא בטוח לדפדפן (ללא תלות ב-Node.js)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// יצירת מופע SDK לדפדפן
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// השתמש ב-APIs ציבוריים (אין צורך במפתח API - בטוח לדפדפנים)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

שימוש בצד השרת (Node.js)

For server/backend applications, use the full SDK with SSO and authentication features:

// ייבוא בצד השרת (כולל SSO ומתוכנן לעבוד עם NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// יצירת מופע SDK לשרת
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // שמרו על זה בסוד בשרת!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// השתמשו ב-APIs מאובטחות עם מפתח ה-API שלכם
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

ייבוא טיפוסים בלבד

If you only need TypeScript types (no runtime code), use the default import:

// רק טיפוסים (ללא תלות בזמן ריצה - בטוח בכל מקום)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

שימוש במחלקות API בודדות

סביבה בדפדפן

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

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

const publicApi = new PublicApi(config);

סביבה בצד השרת

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

API ציבוריים לעומת מאובטחים

ה-SDK מספק את מחלקות ה-API הבאות:

DefaultApi - נקודות קצה מאובטחות שמחייבות את מפתח ה-API שלך לאימות. השתמש בהן עבור פעולות בצד השרת.
PublicApi - נקודות קצה ציבוריות שניתן לגשת אליהן ללא מפתח API. ניתן לקרוא להן ישירות מדפדפנים/מכשירים ניידים/וכו'.
ModerationApi - נקודות קצה של לוח המנהלים (ניהול תגובות, השעיות, תגים, גורם אמון, חיפוש). מאומתות על-ידי סשן המנהלים; העבר את פרמטר השאילתה sso עבור מנהלים המאומתים דרך SSO.
HiddenApi - נקודות קצה פנימיות/מנהליות לשימושים מתקדמים.

דוגמה: שימוש ב-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'
});

דוגמה: שימוש ב-Moderation API

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

const sdk = createFastCommentsSDK({ /* basePath, וכו'. */ });

// קריאות מאומתות של מנהל (עוגיית סשן, או העבר את הפרמטר `sso` עבור מנהל המאומת דרך SSO).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

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

אינטגרציית SSO (כניסה יחידה)

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 וכו׳) נתמכות.

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

תגובה

מחזיר: AggregateResponse

דוגמה

דוגמת אגירה

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

קבלת יומני ביקורת

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
limit	number	לא
skip	number	לא
order	SORTDIR	לא
after	number	לא
before	number	לא

תגובה

מחזיר: GetAuditLogsResponse1

דוגמה

דוגמה getAuditLogs

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 ימים
  const auditResponse: GetAuditLogsResponse1 = await getAuditLogs(
    tenantId,
    limit,
    skip,
    order,
    after
  );
  console.log(auditResponse);
})();

חסימה מתגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

תגובה

מחזירה: BlockFromCommentPublicResponse

דוגמה

דוגמה של blockFromCommentPublic

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

הסרת חסימה מתגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

תגובה

מחזיר: UnBlockCommentPublicResponse

דוגמה

דוגמת unBlockCommentPublic

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

בדיקת תגובות שחוסמו

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentIds	string	Yes
sso	string	No

תגובה

מחזיר: CheckedCommentsForBlockedResponse

דוגמה

דוגמה ל-checkedCommentsForBlocked

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

חסימת משתמש מתגובה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
id	string	Yes
blockFromCommentParams	BlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

תגובה

מחזיר: BlockUserFromCommentResponse

דוגמה

blockUserFromComment דוגמה

Copy

const tenantId: string = 'tenant_42';
const commentId: string = 'cmt_20231101';
const blockParams: BlockFromCommentParams = {
  reason: 'spam',
  blockDurationHours: 24,
};
const userId: string = 'user_123'; // פרמטר אופציונלי
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

יצירת תגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
commentData	CommentData	Yes
sessionId	string	No
sso	string	No

תגובה

מחזיר: CreateCommentPublicResponse

דוגמה

דוגמת createCommentPublic

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

מחיקת תגובה

Parameters

שם	סוג	נחוץ
tenantId	string	Yes
id	string	Yes
contextUserId	string	No
isLive	boolean	No

Response

מחזירה: DeleteCommentResponse

Example

דוגמת deleteComment

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

מחיקת תגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

תגובה

מחזיר: DeleteCommentPublicResponse

דוגמה

דוגמת deleteCommentPublic

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

מחיקת הצבעת תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
voteId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

תגובה

מחזיר: DeleteCommentVoteResponse

דוגמה

דוגמה של deleteCommentVote

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 הוא אופציונלי ונדחה
  const response: DeleteCommentVoteResponse = await deleteCommentVote(
    tenantId,
    commentId,
    voteId,
    urlId,
    broadcastId,
    editKey
  );
  console.log(response);
}
removeVote();

דיווח על תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
userId	string	לא
anonUserId	string	לא

תגובה

מחזיר: FlagCommentResponse1

דוגמה

דוגמת flagComment

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

קבלת תגובה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזירה: GetCommentResponse

דוגמה

דוגמת getComment

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

קבלת תגובות

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
page	number	לא
limit	number	לא
skip	number	לא
asTree	boolean	לא
skipChildren	number	לא
limitChildren	number	לא
maxTreeDepth	number	לא
urlId	string	לא
userId	string	לא
anonUserId	string	לא
contextUserId	string	לא
hashTag	string	לא
parentId	string	לא
direction	SortDirections	לא
fromDate	number	לא
toDate	number	לא

תשובה

מחזיר: GetCommentsResponse

דוגמה

דוגמה של getComments

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; // לפני שבוע
const toDate: number = Date.now();
const commentsResponse: GetCommentsResponse = await getComments({
  tenantId,
  page,
  limit,
  asTree,
  urlId,
  direction,
  fromDate,
  toDate,
});

קבלת תגובות (ציבורי)

req
tenantId
urlId

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
page	number	לא
direction	SortDirections	לא
sso	string	לא
skip	number	לא
skipChildren	number	לא
limit	number	לא
limitChildren	number	לא
countChildren	boolean	לא
fetchPageForCommentId	string	לא
includeConfig	boolean	לא
countAll	boolean	לא
includei10n	boolean	לא
locale	string	לא
modules	string	לא
isCrawler	boolean	לא
includeNotificationCount	boolean	לא
asTree	boolean	לא
maxTreeDepth	number	לא
useFullTranslationIds	boolean	לא
parentId	string	לא
searchText	string	לא
hashTags	Array	לא
userId	string	לא
customConfigStr	string	לא
afterCommentId	string	לא
beforeCommentId	string	לא

תגובה

מחזיר: GetCommentsPublicResponse

דוגמה

getCommentsPublic דוגמה

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

קבלת טקסט התגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
editKey	string	No
sso	string	No

תגובה

מחזיר: GetCommentTextResponse1

דוגמה

getCommentText דוגמה

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

קבלת שמות משתמשים שהצביעו על תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

תשובה

מחזיר: GetCommentVoteUserNamesResponse

דוגמה

דוגמת getCommentVoteUserNames

Copy

async function demoGetCommentVoteUserNames() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_5f2a1e3b";
  const dir: number = 1; // עולה
  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);
}

נעילת תגובה

Parameters

Name	Type	Required
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
sso	string	לא

Response

מחזירה: LockCommentResponse

Example

דוגמת lockComment

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  // עם אסימון SSO אופציונלי
  const ssoToken: string = "user-abc123";
  const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  // ללא אסימון SSO
  const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);
})();

נעיצה של תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
sso	string	לא

תגובה

מחזיר: PinCommentResponse

דוגמה

דוגמת pinComment

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

שמירת תגובה

פרמטרים

שם	סוג	דרוש
tenantId	string	Yes
createCommentParams	CreateCommentParams	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

תגובה

מחזיר: SaveCommentResponse

דוגמה

דוגמת saveComment

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,   // זה חי
    false   // בצע בדיקת ספאם
  );
  console.log(response);
}
submitComment();

שמירת תגובות באופן אצווה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
createCommentParams	Array	כן
isLive	boolean	לא
doSpamCheck	boolean	לא
sendEmails	boolean	לא
populateNotifications	boolean	לא

תגובה

מחזיר: Array<SaveCommentsBulkResponse

דוגמה

דוגמת saveCommentsBulk

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 (בברירת מחדל)
);

הגדרת טקסט תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
commentTextUpdateRequest	CommentTextUpdateRequest	Yes
editKey	string	No
sso	string	No

תגובה

מחזיר: SetCommentTextResponse1

דוגמה

דוגמת setCommentText

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

הסרת חסימת משתמש מתגובה

פרמטרים

Name	Type	Required
tenantId	string	Yes
id	string	Yes
unBlockFromCommentParams	UnBlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

תגובה

מחזיר: UnBlockUserFromCommentResponse

דוגמה

unBlockUserFromComment דוגמה

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 omitted
  );
  console.log(result);
}
demoUnblock();

הסרת דיווח על תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

תגובה

מחזיר: UnFlagCommentResponse

דוגמה

unFlagComment דוגמה

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

שחרור נעילת תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

תגובה

מחזיר: UnLockCommentResponse

דוגמה

דוגמת unLockComment

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);
  // קריאה ללא פרמטר sso האופציונלי
  const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);
  console.log(unlockedWithoutSso);
}
run();

הסרת נעיצה של תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

תגובה

מחזיר: UnPinCommentResponse

דוגמה

דוגמת unPinComment

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

עדכון תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updatableCommentParams	UpdatableCommentParams	כן
contextUserId	string	לא
doSpamCheck	boolean	לא
isLive	boolean	לא

תגובה

מחזיר: UpdateCommentResponse

דוגמה

דוגמת updateComment

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // שדות לדוגמה; הצורה בפועל תלויה בהגדרת ה-API
  // למשל, 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
);

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

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
voteBodyParams	VoteBodyParams	Yes
sessionId	string	No
sso	string	No

תגובה

מחזיר: VoteCommentResponse

דוגמה

דוגמת voteComment

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",               // למשל, "up" | "down"
  weight: 1,                // משקל אופציונלי של ההצבעה
};
const sessionId: string = "sess_abc123def";
const sso: string = "sso_token_xyz";
const result: VoteCommentResponse = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

קבלת תגובות עבור משתמש

פרמטרים

שם	סוג	נדרש
userId	string	לא
direction	SortDirections	לא
repliesToUserId	string	לא
page	number	לא
includei10n	boolean	לא
locale	string	לא
isCrawler	boolean	לא

תגובה

מחזיר: GetCommentsForUserResponse1

דוגמה

דוגמת getCommentsForUser

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

הוספת תצורת דומיין

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
addDomainConfigParams	AddDomainConfigParams	כן

תגובה

מחזיר: AddDomainConfigResponse

דוגמה

addDomainConfig דוגמה

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // התיאור הוא אופציונלי ונמנע כאן
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

מחיקת תצורת דומיין

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes
domain	string	Yes

תגובה

מחזיר: DeleteDomainConfigResponse

דוגמה

דוגמה של deleteDomainConfig

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

קבלת תצורת דומיין

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
domain	string	כן

תגובה

מחזירה: GetDomainConfigResponse

דוגמה

דוגמה ל‑getDomainConfig

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

קבלת תצורות דומיין

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן

תגובה

מחזיר: GetDomainConfigsResponse

דוגמה

דוגמת getDomainConfigs

Copy

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

עדכון חלקי של תצורת דומיין

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
domainToUpdate	string	Yes
patchDomainConfigParams	PatchDomainConfigParams	Yes

תגובה

מחזיר: PatchDomainConfigResponse

דוגמה

patchDomainConfig דוגמה

Copy

async function updateDomainConfig() {
  const tenantId: string = "tenant_98765";
  const domainToUpdate: string = "forum.mycompany.com";
  const patchParams: PatchDomainConfigParams = {
    enableComments: true,
    moderationLevel: "strict",
    allowAnonymous: false, // פרמטר אופציונלי מוצג
  };
  const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);
  console.log(response);
}
updateDomainConfig();

החלפת תצורת דומיין

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
domainToUpdate	string	Yes
updateDomainConfigParams	UpdateDomainConfigParams	Yes

תגובה

מחזיר: PutDomainConfigResponse

דוגמה

דוגמת putDomainConfig

Copy

async function runExample() {
  const tenantId: string = 'tenant-9f8c7b1a';
  const domainToUpdate: string = 'comments.mywebsite.org';
  const updateDomainConfigParams: UpdateDomainConfigParams = {
    enableModeration: true,
    // שדה אופציונלי הושמט, למשל, maxCommentLength?: number
  };
  const result: PutDomainConfigResponse = await putDomainConfig(
    tenantId,
    domainToUpdate,
    updateDomainConfigParams,
  );
  console.log(result);
}
runExample();

יצירת תבנית אימייל

Parameters

Name	Type	Required	Description
tenantId	string	כן
createEmailTemplateBody	CreateEmailTemplateBody	כן

Response

מחזיר: CreateEmailTemplateResponse1

Example

דוגמה createEmailTemplate

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, isActive מוסרים כדי להציג פרמטרים אופציונליים
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

מחיקת תבנית אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: DeleteEmailTemplateResponse

דוגמה

deleteEmailTemplate דוגמה

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // דוגמה לגישה למאפיין אופציונלי בתגובה
  const statusCode: number | undefined = response.status?.code;
}();

מחיקת שגיאת רינדור של תבנית אימייל

Parameters

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

Response

Returns: DeleteEmailTemplateRenderErrorResponse

Example

deleteEmailTemplateRenderError דוגמה

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

קבלת תבנית אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetEmailTemplateResponse1

דוגמה

דוגמת getEmailTemplate

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

קבלת הגדרות תבניות אימייל

פרמטרים

Name	Type	Required	Description
tenantId	string	Yes

תגובה

מחזיר: GetEmailTemplateDefinitionsResponse1

דוגמה

דוגמת getEmailTemplateDefinitions

Copy

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

קבלת שגיאות רינדור של תבניות אימייל

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
skip	number	No

תגובה

מחזיר: GetEmailTemplateRenderErrorsResponse1

דוגמה

דוגמת getEmailTemplateRenderErrors

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

קבלת תבניות אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

Returns: GetEmailTemplatesResponse1

דוגמה

getEmailTemplates דוגמה

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // Call without optional 'skip'
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // Call with optional 'skip' parameter
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

רינדור תבנית אימייל

Parameters

שם	סוג	נדרש
tenantId	string	כן
renderEmailTemplateBody	RenderEmailTemplateBody	כן
locale	string	לא

Response

מחזיר: RenderEmailTemplateResponse1

Example

דוגמה renderEmailTemplate

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

עדכון תבנית אימייל

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
updateEmailTemplateBody	UpdateEmailTemplateBody	Yes

תגובה

מחזירה: UpdateEmailTemplateResponse

דוגמה

דוגמת updateEmailTemplate

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.",
    // דוגמה לשדה אופציונלי
    isActive: true,
  };
  const result: UpdateEmailTemplateResponse = await updateEmailTemplate(
    tenantId,
    templateId,
    updateBody
  );
  console.log(result);
})();

קבלת יומן אירועים

req tenantId urlId userIdWS

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
userIdWS	string	כן
startTime	number	כן
endTime	number	לא

תגובה

מחזיר: GetEventLogResponse1

דוגמה

דוגמת getEventLog

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; // לפני שבוע
    const endTime: number = Date.now();
    const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);
})();

קבלת יומן אירועים גלובלי

req tenantId urlId userIdWS

פרמטרים

Name	Type	Required
tenantId	string	כן
urlId	string	כן
userIdWS	string	כן
startTime	number	כן
endTime	number	לא

תשובה

מחזיר: GetGlobalEventLogResponse

דוגמה

דוגמת getGlobalEventLog

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

יצירת פוסט פיד

פרמטרים

שם	סוג	חובה
tenantId	string	כן
createFeedPostParams	CreateFeedPostParams	כן
broadcastId	string	לא
isLive	boolean	לא
doSpamCheck	boolean	לא
skipDupCheck	boolean	לא

תגובה

מחזיר: CreateFeedPostResponse1

דוגמה

דוגמת createFeedPost

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

יצירת פוסט פיד (ציבורי)

פרמטרים

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

תגובה

מחזיר: CreateFeedPostPublicResponse

דוגמה

דוגמת createFeedPostPublic

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

מחיקת פוסט פיד (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
postId	string	Yes
broadcastId	string	No
sso	string	No

תגובה

מחזיר: DeleteFeedPostPublicResponse

דוגמה

deleteFeedPostPublic דוגמה

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

קבלת פוסטים בפיד

req
tenantId
afterId

פרמטרים

שם	סוג	חובה
tenantId	string	כן
afterId	string	לא
limit	number	לא
tags	Array	לא

תגובה

מחזיר: GetFeedPostsResponse1

דוגמה

getFeedPosts דוגמה

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

קבלת פוסטים בפיד (ציבורי)

req tenantId afterId

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No
sso	string	No
isCrawler	boolean	No
includeUserInfo	boolean	No

תגובה

מחזיר: GetFeedPostsPublicResponse

דוגמה

getFeedPostsPublic דוגמה

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

קבלת סטטיסטיקות פוסטים בפיד

פרמטרים

שם	סוג	חובה
tenantId	string	כן
postIds	Array	כן
sso	string	לא

תגובה

מחזיר: GetFeedPostsStatsResponse

דוגמה

getFeedPostsStats דוגמה

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

קבלת ריאקציות משתמש (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
postIds	Array	No
sso	string	No

תגובה

מחזיר: GetUserReactsPublicResponse

דוגמה

דוגמת getUserReactsPublic

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

הוספת ריאקציה לפוסט פיד (ציבורי)

Parameters

Name	Type	Required
tenantId	string	כן
postId	string	כן
reactBodyParams	ReactBodyParams	כן
isUndo	boolean	לא
broadcastId	string	לא
sso	string	לא

Response

מחזיר: ReactFeedPostPublicResponse

Example

דוגמת reactFeedPostPublic

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

עדכון פוסט פיד

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
feedPost	FeedPost	Yes

Response

מחזיר: UpdateFeedPostResponse

Example

דוגמה ל‑updateFeedPost

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

עדכון פוסט פיד (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
postId	string	Yes
updateFeedPostParams	UpdateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

תגובה

Returns: UpdateFeedPostPublicResponse

דוגמה

דוגמת updateFeedPostPublic

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

דיווח על תגובה (ציבורי)

פרמטרים

שם	סוג	חובה
tenantId	string	כן
commentId	string	כן
isFlagged	boolean	כן
sso	string	לא

תגובה

מחזיר: FlagCommentPublicResponse

דוגמה

דוגמת flagCommentPublic

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

קבלת GIF גדול

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
largeInternalURLSanitized	string	כן

תגובה

מחזירה: GetGifLargeResponse

דוגמה

דוגמת getGifLarge

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

חיפוש GIFs

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
search	string	כן
locale	string	לא
rating	string	לא
page	number	לא

תגובה

מחזירה: GetGifsSearchResponse

דוגמה

דוגמה ל‑getGifsSearch

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

GIFs טרנדיים

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

תגובה

מחזיר: GetGifsTrendingResponse

דוגמה

דוגמת getGifsTrending

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);
  // שימוש רק בפרמטר הנדרש
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

הוספת תגית

Parameters

שם	סוג	נדרש	תיאור
tenantId	string	לא
createHashTagBody	CreateHashTagBody	לא

Response

מחזיר: AddHashTagResponse

Example

דוגמת addHashTag

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

הוספת תגיות באופן אצווה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	לא
bulkCreateHashTagsBody	BulkCreateHashTagsBody	לא

תגובה

מחזיר: AddHashTagsBulkResponse

דוגמה

addHashTagsBulk דוגמה

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

מחיקת תגית

פרמטרים

שם	סוג	נדרש
tag	string	כן
tenantId	string	לא
deleteHashTagRequestBody	DeleteHashTagRequestBody	לא

תגובה

מחזיר: DeleteHashTagResponse

דוגמה

דוגמת deleteHashTag

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

קבלת תגיות

Parameters

שם	סוג	נדרש	תיאור
tenantId	string	כן
page	number	לא

תגובה

Returns: GetHashTagsResponse1

דוגמה

getHashTags דוגמה

Copy

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

עדכון חלקי של תגית

Parameters

שם	סוג	נדרש
tag	string	כן
tenantId	string	לא
updateHashTagBody	UpdateHashTagBody	לא

Response

מחזיר: PatchHashTagResponse

דוגמה

patchHashTag דוגמה

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

מחיקת הצבעת בקרה

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
voteId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: DeleteModerationVoteResponse

דוגמה

דוגמה של deleteModerationVote

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

קבלת תגובות דרך ה-API

Parameters

Name	Type	Required
page	number	לא
count	number	לא
textSearch	string	לא
byIPFromComment	string	לא
filters	string	לא
searchFilters	string	לא
sorts	string	לא
demo	boolean	לא
tenantId	string	לא
sso	string	לא

Response

מחזיר: GetApiCommentsResponse

דוגמה

דוגמת getApiComments

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // עמוד
    25,                    // כמות
    "feedback",           // חיפוש טקסט
    "192.168.1.100",      // כתובת IP מההערה
    "approved",           // מסננים
    "hasReplies",         // מסנני חיפוש
    "dateDesc",           // מיון
    false,                // הדגמה
    "tenant-abc123",      // מזהה שוכר
    "sso-token-xyz"       // SSO
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

קבלת סטטוס יצוא ה-API

פרמטרים

שם	סוג	נדרש
batchJobId	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetApiExportStatusResponse

דוגמה

getApiExportStatus דוגמה

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

קבלת מזהי API

Parameters

שם	סוג	נדרש
textSearch	string	לא
byIPFromComment	string	לא
filters	string	לא
searchFilters	string	לא
afterId	string	לא
demo	boolean	לא
tenantId	string	לא
sso	string	לא

Response

מחזירה: GetApiIdsResponse

דוגמה

דוגמת getApiIds

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

קבלת משתמשים שנחסמו מתגובה

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetBanUsersFromCommentResponse

דוגמה

דוגמת getBanUsersFromComment

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // קריאה עם כל הפרמטרים
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // קריאה עם הפרמטר ההכרחי בלבד
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

קבלת סטטוס חסימת תגובה

פרמטרים

שם	סוג	נדרש
commentId	string	כן
tenantId	string	לא
sso	string	לא

תגובה

מחזירה: GetCommentBanStatusResponse1

דוגמה

דוגמת getCommentBanStatus

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

קבלת תגובות-ילדים

פרמטרים

שם	סוג	חובה
commentId	string	Yes
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetCommentChildrenResponse

דוגמה

דוגמה getCommentChildren

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

קבלת ספירה

פרמטרים

שם	סוג	חובה
textSearch	string	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetCountResponse

דוגמה

דוגמת getCount

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

קבלת ספירות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetCountsResponse

דוגמה

דוגמת getCounts

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

קבלת יומנים

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetLogsResponse

דוגמה

דוגמת getLogs

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

קבלת תגים ידניים

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	No
sso	string	No

תשובה

מחזיר: GetManualBadgesResponse

דוגמה

דוגמת getManualBadges

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // קריאה עם שני הפרמטרים האופציונליים
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // קריאה רק עם tenantId
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

קבלת תגים ידניים עבור משתמש

פרמטרים

שם	סוג	חובה
badgesUserId	string	No
commentId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetManualBadgesForUserResponse

דוגמה

getManualBadgesForUser דוגמה

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

קבלת תגובת בקרה

פרמטרים

שם	סוג	נדרש
commentId	string	כן
includeEmail	boolean	לא
includeIP	boolean	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetModerationCommentResponse

דוגמה

דוגמת getModerationComment

Copy

async function fetchCommentDetails() {
  // קבוצת פרמטרים מלאה
  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
  );
  // קריאה מינימלית עם הפרמטר הדרוש בלבד
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // השתמש בתוצאות לפי הצורך...
}

קבלת טקסט תגובת בקרה

Parameters

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

Response

מחזיר: GetModerationCommentTextResponse

Example

getModerationCommentText דוגמה

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // קריאה עם רק הפרמטר הדרוש
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // קריאה עם פרמטרים אופציונליים
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

קבלת סיכום לפני חסימה

פרמטרים

שם	סוג	חובה
commentId	string	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetPreBanSummaryResponse

דוגמה

דוגמה getPreBanSummary

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

קבלת סיכום חיפוש תגובות

פרמטרים

שם	סוג	חובה
value	string	לא
filters	string	לא
searchFilters	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetSearchCommentsSummaryResponse

דוגמה

דוגמת getSearchCommentsSummary

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

קבלת דפי תוצאות חיפוש

פרמטרים

שם	סוג	נדרש
value	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetSearchPagesResponse

דוגמה

דוגמת getSearchPages

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

קבלת אתרים בתוצאות חיפוש

פרמטרים

שם	סוג	חובה
value	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetSearchSitesResponse

דוגמה

getSearchSites דוגמה

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

קבלת הצעות חיפוש

פרמטרים

שם	סוג	חובה
textSearch	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetSearchSuggestResponse

דוגמה

דוגמת getSearchSuggest

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

קבלת משתמשים בחיפוש

פרמטרים

שם	סוג	נדרש
value	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetSearchUsersResponse

דוגמה

דוגמת getSearchUsers

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

קבלת גורם אמון

פרמטרים

שם	סוג	נדרש
userId	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: GetTrustFactorResponse

דוגמה

דוגמת getTrustFactor

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

קבלת העדפת חסימת משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetUserBanPreferenceResponse

דוגמה

getUserBanPreference דוגמה

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

קבלת פרופיל פנימי של משתמש

פרמטרים

שם	סוג	נדרש
commentId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: GetUserInternalProfileResponse1

דוגמה

דוגמת getUserInternalProfile

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

כיוון הצבעות תגובה

Parameters

שם	סוג	נדרש
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Response

מחזיר: PostAdjustCommentVotesResponse

דוגמה

דוגמה ל‑postAdjustCommentVotes

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // שדות נוספים כנדרש על‑ידי AdjustCommentVotesParams
};
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
);

ביצוע יצוא דרך ה-API

פרמטרים

שם	סוג	הכרחי
textSearch	string	לא
byIPFromComment	string	לא
filters	string	לא
searchFilters	string	לא
sorts	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: PostApiExportResponse

דוגמה

postApiExport דוגמה

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

חסימת משתמש מתגובה

Parameters

שם	סוג	נדרש
commentId	string	Yes
banEmail	boolean	No
banEmailDomain	boolean	No
banIP	boolean	No
deleteAllUsersComments	boolean	No
bannedUntil	string	No
isShadowBan	boolean	No
updateId	string	No
banReason	string	No
tenantId	string	No
sso	string	No

Response

מחזיר: PostBanUserFromCommentResponse

Example

postBanUserFromComment דוגמה

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

ביטול חסימת משתמש

פרמטרים

שם	סוג	נדרש
banUserUndoParams	BanUserUndoParams	Yes
tenantId	string	No
sso	string	No

תגובה

מחזיר: PostBanUserUndoResponse

דוגמה

דוגמה postBanUserUndo

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

שליחת סיכום מקדמי חסימה באופן אצווה

פרמטרים

שם	סוג	נדרש
bulkPreBanParams	BulkPreBanParams	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

תגובה

מחזירה: PostBulkPreBanSummaryResponse

דוגמה

postBulkPreBanSummary דוגמה

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

שליחת תגובות לפי מזהים

פרמטרים

שם	סוג	נדרש
commentsByIdsParams	CommentsByIdsParams	כן
tenantId	string	לא
sso	string	לא

תשובה

מחזיר: PostCommentsByIdsResponse

דוגמה

postCommentsByIds דוגמה

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

דיווח על תגובה

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: PostFlagCommentResponse

דוגמה

postFlagComment דוגמה

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

הסרת תגובה

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: PostRemoveCommentResponse

דוגמה

postRemoveComment דוגמה

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

שחזור תגובה שנמחקה

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: PostRestoreDeletedCommentResponse

דוגמה

postRestoreDeletedComment דוגמה

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

הגדרת סטטוס אישור תגובה

פרמטרים

שם	סוג	נדרש
commentId	string	כן
approved	boolean	לא
broadcastId	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: PostSetCommentApprovalStatusResponse

דוגמה

postSetCommentApprovalStatus דוגמה

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

הגדרת סטטוס סקירת תגובה

פרמטרים

שם	סוג	נדרש
commentId	string	כן
reviewed	boolean	לא
broadcastId	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: PostSetCommentReviewStatusResponse

דוגמה

postSetCommentReviewStatus דוגמה

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

הגדרת סטטוס דואר זבל לתגובה

Parameters

שם	סוג	נדרש
commentId	string	Yes
spam	boolean	No
permNotSpam	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Response

מחזיר: PostSetCommentSpamStatusResponse

Example

postSetCommentSpamStatus דוגמה

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // רק הפרמטר הדרוש
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // כל הפרמטרים האופציונליים סופקו
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

הגדרת טקסט תגובה

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: PostSetCommentTextResponse

דוגמה

דוגמה של postSetCommentText

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

הסרת דיווח מתגובה

Parameters

שם	סוג	נדרש
commentId	string	כן
broadcastId	string	לא
tenantId	string	לא
sso	string	לא

Response

מחזיר: PostUnFlagCommentResponse

Example

דוגמת postUnFlagComment

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // commentId
    "brd_67890",          // broadcastId (optional)
    "tenant_abc",         // tenantId (optional)
    "sso_user_token_789"  // sso (optional)
  );
};

שליחת הצבעה

פרמטרים

שם	סוג	נדרש
commentId	string	Yes
direction	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

תשובה

מחזיר: PostVoteResponse

דוגמה

דוגמת postVote

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

הענקת תג

פרמטרים

שם	סוג	נדרש
badgeId	string	כן
userId	string	לא
commentId	string	לא
broadcastId	string	לא
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: PutAwardBadgeResponse

דוגמה

דוגמה ל‑putAwardBadge

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

סגירת שרשור

פרמטרים

שם	סוג	נדרש
urlId	string	Yes
tenantId	string	No
sso	string	No

תגובה

מחזיר: PutCloseThreadResponse

דוגמה

דוגמת putCloseThread

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

הסרת תג

Parameters

שם	סוג	נדרש
badgeId	string	Yes
userId	string	No
commentId	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: PutRemoveBadgeResponse

דוגמה

דוגמה של putRemoveBadge

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

פתיחת שרשור מחדש

פרמטרים

שם	סוג	הנדרש
urlId	string	כן
tenantId	string	לא
sso	string	לא

תגובה

מחזיר: PutReopenThreadResponse

דוגמה

דוגמה ל‑putReopenThread

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

הגדרת גורם אמון

פרמטרים

שם	סוג	נדרש
userId	string	No
trustFactor	string	No
tenantId	string	No
sso	string	No

תגובה

מחזיר: SetTrustFactorResponse

דוגמה

setTrustFactor דוגמה

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

יצירת ממונה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	Yes

תגובה

מחזיר: CreateModeratorResponse1

דוגמה

דוגמת createModerator

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // שדות אופציונליים כמו תיאור נשמטו
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

מחיקת ממונה

פרמטרים

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

תגובה

מחזיר: DeleteModeratorResponse

דוגמה

דוגמת deleteModerator

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

קבלת ממונה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetModeratorResponse1

דוגמה

דוגמת getModerator

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

קבלת ממונים

פרמטרים

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

תגובה

מחזיר: GetModeratorsResponse1

דוגמה

דוגמת getModerators

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // אופציונלי קיזוז דפדוף
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // דוגמה ללא דפדוף:
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

שליחת הזמנה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
fromName	string	Yes

תגובה

מחזיר: SendInviteResponse

דוגמה

דוגמת sendInvite

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

עדכון ממונה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateModeratorBody	UpdateModeratorBody	כן

תגובה

מחזיר: UpdateModeratorResponse

דוגמה

דוגמת updateModerator

Copy

async function demoUpdateModerator(): Promise<void> {
    const tenantId: string = "tenant_42abc";
    const moderatorId: string = "moderator_8f9e";
    const updateBody: UpdateModeratorBody = {
        isActive: true,
        role: "admin",
        // שדה אופציונלי
        notes: "Promoted to senior moderator"
    };
    const result: UpdateModeratorResponse = await updateModerator(tenantId, moderatorId, updateBody);
    console.log(result);
}
demoUpdateModerator();

מחיקת ספירת התראות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: DeleteNotificationCountResponse

דוגמה

דוגמת deleteNotificationCount

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

קבלת ספירת התראות ממטמון

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetCachedNotificationCountResponse1

דוגמה

דוגמת getCachedNotificationCount

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

קבלת ספירת התראות

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	לא
urlId	string	לא
fromCommentId	string	לא
viewed	boolean	לא
type	string	לא

תגובה

מחזיר: GetNotificationCountResponse1

דוגמה

דוגמת getNotificationCount

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

קבלת התראות

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

תגובה

מחזיר: GetNotificationsResponse1

דוגמה

דוגמת getNotifications

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

עדכון התראה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateNotificationBody	UpdateNotificationBody	כן
userId	string	לא

תגובה

מחזירה: UpdateNotificationResponse

דוגמה

דוגמת updateNotification

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

יצירת ריאקציה לעמוד (V1)

Parameters

שם	סוג	חובה
tenantId	string	כן
urlId	string	כן
title	string	לא

תגובה

מחזיר: CreateV1PageReactResponse

דוגמה

createV1PageReact דוגמה

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

יצירת ריאקציה לעמוד (V2)

פרמטרים

שם	סוג	חובה
tenantId	string	כן
urlId	string	כן
id	string	כן
title	string	לא

תגובה

מחזיר: CreateV2PageReactResponse

דוגמה

createV2PageReact דוגמה

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

מחיקת ריאקציה לעמוד (V1)

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
urlId	string	Yes

תגובה

מחזיר: DeleteV1PageReactResponse

דוגמה

דוגמת deleteV1PageReact

Copy

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

מחיקת ריאקציה לעמוד (V2)

פרמטרים

Name	Type	Required
tenantId	string	כן
urlId	string	כן
id	string	כן

תשובה

מחזיר: DeleteV2PageReactResponse

דוגמה

דוגמת deleteV2PageReact

Copy

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

קבלת לייקים לעמוד (V1)

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
urlId	string	כן

תגובה

מחזירה: GetV1PageLikesResponse

דוגמה

getV1PageLikes דוגמה

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

קבלת ריאקציות לעמוד (V2)

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
urlId	string	כן

תגובה

מחזיר: GetV2PageReactsResponse

דוגמה

דוגמת getV2PageReacts

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);
    // דוגמה לגישה לאופציונלית למאפיין
    const customConfig: CustomConfigParameters | undefined = reacts.customConfig;
    console.log(reacts);
}
demoGetPageReacts();

קבלת משתמשים שהגיבו לעמוד (V2)

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

תגובה

מחזיר: GetV2PageReactUsersResponse1

דוגמה

דוגמת getV2PageReactUsers

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

הוספת עמוד

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	Yes

תגובה

מחזירה: AddPageAPIResponse

דוגמה

דוגמת addPage

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

מחיקת עמוד

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: DeletePageAPIResponse

דוגמה

דוגמת deletePage

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

קבלת משתמשים לא מקוונים

מגיבים קודמים בעמוד שאינם מחוברים כעת. ממוין לפי displayName.
השתמש בזה לאחר שכבר נצלת /users/online כדי ליצור קטע "Members" section.
דפדוף בעזרת מצביע על commenterName: השרת פועל על החלקי {tenantId, urlId, commenterName}
אינדקס מ‑afterName קדימה באמצעות $gt, ללא עלות $skip.

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

תגובה

מחזיר: GetOfflineUsersResponse

דוגמה

דוגמת getOfflineUsers

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

קבלת משתמשים מקוונים

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

תגובה

מחזיר: GetOnlineUsersResponse

דוגמה

דוגמה ל‑getOnlineUsers

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // עם פרמטרי דפדוף אופציונליים
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // ללא פרמטרי דפדוף אופציונליים
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

קבלת עמוד לפי מזהה URL

פרמטרים

שם	סוג	דרוש	תיאור
tenantId	string	Yes
urlId	string	Yes

תגובה

מחזיר: GetPageByURLIdAPIResponse

דוגמה

דוגמת getPageByURLId

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

קבלת דפים

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes

תגובה

מחזיר: GetPagesAPIResponse

דוגמה

דוגמת getPages

Copy

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

קבלת דפים (ציבורי)

רשימת דפים לשוכר. משמשת על ידי לקוח הדסקטופ של FChat למלא את רשימת החדרים שלו.
דורש enableFChat להיות true בתצורה המותאמת שנפתרה עבור כל דף.
דפים הדורשים SSO מסוננים לפי גישה לקבוצת המשתמש המבקש.

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
cursor	string	לא
limit	number	לא
q	string	לא
sortBy	PagesSortBy	לא
hasComments	boolean	לא

תגובה

מחזירה: GetPagesPublicResponse

דוגמה

getPagesPublic דוגמה

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

קבלת מידע על משתמשים

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

שם	סוג	נדרש	תיאור
tenantId	string	כן
ids	string	כן

Response

מחזיר: GetUsersInfoResponse

דוגמה

דוגמת getUsersInfo

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// Optional fields in the response may be undefined
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

עדכון חלקי של עמוד

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
updateAPIPageData	UpdateAPIPageData	Yes

תגובה

מחזיר: PatchPageAPIResponse

דוגמה

patchPage דוגמה

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const pageId: string = "page_98765";
  const updateData: UpdateAPIPageData = {
    title: "Updated FAQ Page"
    // description?: string ניתן להשמיט
  };
  const response: PatchPageAPIResponse = await patchPage(tenantId, pageId, updateData);
})();

מחיקת אירוע webhook תלוי

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: DeletePendingWebhookEventResponse

דוגמה

deletePendingWebhookEvent דוגמה

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

קבלת ספירת אירועי webhook תלויים

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

תגובה

מחזיר: GetPendingWebhookEventCountResponse1

דוגמה

דוגמה ל-getPendingWebhookEventCount

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

קבלת אירועי webhook תלויים

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No
skip	number	No

תגובה

מחזיר: GetPendingWebhookEventsResponse1

דוגמה

getPendingWebhookEvents דוגמה

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

יצירת תצורת שאלה

Parameters

שם	סוג	חובה	תיאור
tenantId	string	כן
createQuestionConfigBody	CreateQuestionConfigBody	כן

Response

מחזיר: CreateQuestionConfigResponse1

Example

createQuestionConfig דוגמה

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,
  // ניתן להסיר שדות אופציונליים
  customOptions: [customOption],
};
const response: CreateQuestionConfigResponse1 = await createQuestionConfig(
  tenantId,
  createQuestionConfigBody
);

מחיקת תצורת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: DeleteQuestionConfigResponse

דוגמה

דוגמה של deleteQuestionConfig

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

קבלת תצורת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetQuestionConfigResponse1

דוגמה

דוגמת getQuestionConfig

Copy

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

קבלת תצורות שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
skip	number	No

תגובה

מחזיר: GetQuestionConfigsResponse1

דוגמה

דוגמת getQuestionConfigs

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // קריאה ללא הפרמטר האופציונלי 'skip'
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // קריאה עם הפרמטר האופציונלי 'skip'
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

עדכון תצורת שאלה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

תגובה

מחזיר: UpdateQuestionConfigResponse

דוגמה

דוגמת updateQuestionConfig

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "qstn-2023-04";
const updateBody: UpdateQuestionConfigBody = {
  // הוכחה לשדות אופציונליים
  customOptions: [
    {
      id: "opt-001",
      label: "Extra Details",
      required: true,
    },
  ],
  renderingType: "markdown",
};
const response: UpdateQuestionConfigResponse = await updateQuestionConfig(
  tenantId,
  questionId,
  updateBody
);

יצירת תוצאת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createQuestionResultBody	CreateQuestionResultBody	כן

תגובה

מחזיר: CreateQuestionResultResponse1

דוגמה

דוגמה createQuestionResult

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]
  // שדות אופציונליים כגון הערות הושמטו
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

מחיקת תוצאת שאלה

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

מחזיר: DeleteQuestionResultResponse

Example

deleteQuestionResult דוגמה

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

קבלת תוצאת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetQuestionResultResponse1

דוגמה

דוגמת getQuestionResult

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

קבלת תוצאות שאלות

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

תגובה

מחזיר: GetQuestionResultsResponse1

דוגמה

דוגמה getQuestionResults

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

עדכון תוצאת שאלה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

תגובה

מחזיר: UpdateQuestionResultResponse

דוגמה

דוגמה ל‑updateQuestionResult

Copy

async function runUpdate() {
    const tenantId: string = "acme-corp-01";
    const id: string = "qr-20230915-001";
    const updateQuestionResultBody: UpdateQuestionResultBody = {
        // שדות נדרשים
        answer: "No",
        // שדות אופציונליים
        comment: "User clarified their response",
        // anotherOptionalField?: value,
    };
    const result: UpdateQuestionResultResponse = await updateQuestionResult(
        tenantId,
        id,
        updateQuestionResultBody
    );
    console.log(result);
}
runUpdate();

אגרגציית תוצאות שאלות

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

תגובה

מחזיר: AggregateQuestionResultsResponse1

דוגמה

דוגמת aggregateQuestionResults

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

אגרגציה בכמות של תוצאות שאלות

Parameters

Name	Type	Required
tenantId	string	כן
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	כן
forceRecalculate	boolean	לא

Response

מחזיר: BulkAggregateQuestionResultsResponse1

Example

bulkAggregateQuestionResults דוגמה

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

שילוב תגובות עם תוצאות שאלות

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

תגובה

מחזיר: CombineCommentsWithQuestionResultsResponse

דוגמה

combineCommentsWithQuestionResults דוגמה

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

הוספת משתמש SSO

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
createAPISSOUserData	CreateAPISSOUserData	כן

תגובה

Returns: AddSSOUserAPIResponse

דוגמה

דוגמת addSSOUser

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

מחיקת משתמש SSO

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

Response

מחזיר: DeleteSSOUserAPIResponse

Example

דוגמת deleteSSOUser

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

קבלת משתמש SSO לפי אימייל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
email	string	כן

תגובה

מחזיר: GetSSOUserByEmailAPIResponse

דוגמה

דוגמה getSSOUserByEmail

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

קבלת משתמש SSO לפי מזהה

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetSSOUserByIdAPIResponse

דוגמה

דוגמה של getSSOUserById

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

קבלת משתמשי SSO

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetSSOUsersResponse

דוגמה

דוגמה ל‑getSSOUsers

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    // קריאה ללא `skip` האופציונלי
    const firstPage: GetSSOUsersResponse = await getSSOUsers(tenantId);
    // קריאה עם `skip` האופציונלי
    const secondPage: GetSSOUsersResponse = await getSSOUsers(tenantId, 100);
    console.log(firstPage, secondPage);
}
runExample();

עדכון חלקי של משתמש SSO

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
updateAPISSOUserData	UpdateAPISSOUserData	כן
updateComments	boolean	לא

תגובה

מחזיר: PatchSSOUserAPIResponse

דוגמה

patchSSOUser דוגמה

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

החלפת משתמש SSO

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

תגובה

מחזיר: PutSSOUserAPIResponse

דוגמה

דוגמת putSSOUser

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

יצירת מנוי

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	כן

תגובה

מחזיר: CreateSubscriptionAPIResponse

דוגמה

createSubscription דוגמה

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const subscriptionData: CreateAPIUserSubscriptionData = {
        userId: "user-456",
        planId: "premium-monthly",
        startDate: new Date(),
        trialPeriodDays: 14 // שדה אופציונלי
    };
    const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, subscriptionData);
    console.log(result);
})();

מחיקת מנוי

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
userId	string	No

תגובה

מחזיר: DeleteSubscriptionAPIResponse

דוגמה

דוגמת deleteSubscription

Copy

(async () => {
  const tenantId: string = "tenant_9876";
  const subscriptionId: string = "sub_54321";
  const userId: string = "user_abc123";
  // עם userId אופציונלי
  const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  // ללא userId אופציונלי
  const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
})();

קבלת מנויים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
userId	string	לא

תשובה

מחזיר: GetSubscriptionsAPIResponse

דוגמה

דוגמה ל‑getSubscriptions

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

עדכון מנוי

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	כן
userId	string	לא

תגובה

מחזיר: UpdateSubscriptionAPIResponse

דוגמה

דוגמת updateSubscription

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

קבלת שימוש יומי של שוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
yearNumber	number	לא
monthNumber	number	לא
dayNumber	number	לא
skip	number	לא

תגובה

מחזיר: GetTenantDailyUsagesResponse1

דוגמה

getTenantDailyUsages דוגמה

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // מאי
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // שימוש רק בפרמטרים הדרושים ובאחד מהפרמטרים האופציונליים
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

יצירת חבילת שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	Yes

תגובה

מחזירה: CreateTenantPackageResponse1

דוגמה

createTenantPackage דוגמה

Copy

(async () => {
  const tenantId: string = "tenant-9876";
  const body: CreateTenantPackageBody = {
    packageName: "Standard",
    quota: 5000,
    // שדה אופציונלי
    description: "Standard package for medium traffic",
  };
  const result: CreateTenantPackageResponse1 = await createTenantPackage(tenantId, body);
  console.log(result);
})();

מחיקת חבילת שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: DeleteTenantPackageResponse

דוגמה

דוגמת deleteTenantPackage

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // השתמש בתוצאה לפי הצורך
}
removeTenantPackage();

קבלת חבילת שוכר

פרמטרים

שם	טיפוס	חובה	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזירה: GetTenantPackageResponse1

דוגמה

דוגמת getTenantPackage

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);
    // שדות אופציונליים בתגובה
    const tenantPackage: TenantPackage | undefined = response.tenantPackage;
    const customConfig: CustomConfigParameters | undefined = response.customConfigParameters;
}

קבלת חבילות שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetTenantPackagesResponse1

דוגמה

דוגמת getTenantPackages

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

החלפת חבילת שוכר

פרמטרים

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

תגובה

מחזיר: ReplaceTenantPackageResponse

דוגמה

replaceTenantPackage דוגמה

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // שדות קונפיגורציה מותאמים כאן
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // קונפיגורציה מותאמת אופציונלית
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

עדכון חבילת שוכר

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
id	string	Yes
updateTenantPackageBody	UpdateTenantPackageBody	Yes

תגובה

מחזיר: UpdateTenantPackageResponse

דוגמה

דוגמת updateTenantPackage

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

יצירת משתמש שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createTenantUserBody	CreateTenantUserBody	כן

תגובה

מחזיר: CreateTenantUserResponse1

דוגמה

דוגמה של createTenantUser

Copy

const tenantId: string = "a1b2c3d4-5678-90ab-cdef-1234567890ab";
const newUser: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "admin",
  // פרמטרים אופציונליים
  phoneNumber: "+15551234567",
  isActive: true,
};
const result: CreateTenantUserResponse1 = await createTenantUser(tenantId, newUser);

מחיקת משתמש שוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
deleteComments	string	No
commentDeleteMode	string	No

תגובה

מחזיר: DeleteTenantUserResponse

דוגמה

deleteTenantUser דוגמה

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // למחוק את המשתמש ואת כל ההערות שלו, תוך שימוש במצב מחיקה קשה
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // למחוק את המשתמש מבלי להסיר הערות (התנהגות ברירת מחדל)
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

קבלת משתמש שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: GetTenantUserResponse1

דוגמה

דוגמת getTenantUser

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

קבלת משתמשי שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetTenantUsersResponse1

דוגמה

דוגמת getTenantUsers

Copy

(async () => {
  const tenantId: string = "tenant_9f7a2c";
  const skip: number = 25;
  const usersPage: GetTenantUsersResponse1 = await getTenantUsers(tenantId, skip);
  const allUsers: GetTenantUsersResponse1 = await getTenantUsers(tenantId);
})();

החלפת משתמש שוכר

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
replaceTenantUserBody	ReplaceTenantUserBody	Yes
updateComments	string	No

Response

Returns: ReplaceTenantUserResponse

Example

replaceTenantUser דוגמה

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

שליחת קישור כניסה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
redirectURL	string	No

תגובה

מחזיר: SendLoginLinkResponse

דוגמה

sendLoginLink דוגמה

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

עדכון משתמש שוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
updateTenantUserBody	UpdateTenantUserBody	Yes
updateComments	string	No

תגובה

מחזיר: UpdateTenantUserResponse

דוגמה

דוגמת updateTenantUser

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

יצירת שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
createTenantBody	CreateTenantBody	Yes

תגובה

מחזיר: CreateTenantResponse1

דוגמה

דוגמת createTenant

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // שדות נדרשים
    name: 'Acme International',
    // ניתן להוסיף שדות אופציונליים לפי הצורך, למשל:
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

מחיקת שוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
sure	string	No

תגובה

מחזיר: DeleteTenantResponse

דוגמה

deleteTenant דוגמה

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // קריאה עם פרמטר 'sure' אופציונלי
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // קריאה ללא פרמטר 'sure' אופציונלי
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

קבלת שוכר

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: GetTenantResponse1

דוגמה

דוגמת getTenant

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

קבלת שוכרים

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
meta	string	לא
skip	number	לא

תגובה

מחזירה: GetTenantsResponse1

דוגמה

דוגמת getTenants

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

עדכון שוכר

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
id	string	Yes
updateTenantBody	UpdateTenantBody	Yes

תגובה

Returns: UpdateTenantResponse

דוגמה

דוגמת updateTenant

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

שינוי סטטוס כרטיס

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
userId	string	Yes
id	string	Yes
changeTicketStateBody	ChangeTicketStateBody	Yes

תגובה

מחזיר: ChangeTicketStateResponse1

דוגמה

changeTicketState דוגמה

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-97123";
const ticketId: string = "ticket-45001";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  // שדה אופציונלי בגוף
  comment: "Issue resolved after code fix"
};
const response: ChangeTicketStateResponse1 = await changeTicketState(
  tenantId,
  userId,
  ticketId,
  changeTicketStateBody
);

יצירת כרטיס

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	כן
createTicketBody	CreateTicketBody	כן

תגובה

מחזיר: CreateTicketResponse1

דוגמה

createTicket דוגמה

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string הוא אופציונלי ומושמט
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// דוגמה לשימוש בשדה אופציונלי מהתגובה
// console.log(response.ticket?.id);

קבלת כרטיס

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
id	string	Yes
userId	string	No

תשובה

מחזירה: GetTicketResponse1

דוגמה

דוגמת getTicket

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

קבלת כרטיסים

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
state	number	No
skip	number	No
limit	number	No

Response

מחזיר: GetTicketsResponse1

Example

דוגמת getTickets

Copy

async function loadTickets() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const state: number = 2; // לדוגמה, סגור
  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();

קבלת תרגומים

פרמטרים

שם	סוג	נדרש
namespace	string	כן
component	string	כן
locale	string	לא
useFullTranslationIds	boolean	לא

תגובה

מחזיר: GetTranslationsResponse1

דוגמה

דוגמה getTranslations

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

העלאת תמונה

העלאה ושינוי גודל של תמונה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

תגובה

מחזירה: UploadImageResponse

דוגמה

דוגמת uploadImage

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

קבלת התקדמות תג משתמש לפי מזהה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: GetUserBadgeProgressByIdResponse

דוגמה

דוגמת getUserBadgeProgressById

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

קבלת התקדמות תג משתמש לפי מזהה משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
userId	string	Yes

תגובה

מחזיר: GetUserBadgeProgressByUserIdResponse

דוגמה

getUserBadgeProgressByUserId דוגמה

Copy

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

קבלת רשימת התקדמות תגי משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	לא
limit	number	לא
skip	number	לא

תשובה

מחזיר: GetUserBadgeProgressListResponse

דוגמה

getUserBadgeProgressList דוגמה

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

יצירת תג משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createUserBadgeParams	CreateUserBadgeParams	כן

תגובה

מחזיר: CreateUserBadgeResponse

דוגמה

createUserBadge דוגמה

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // תיאור הוא אופציונלי ווסר כאן
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

מחיקת תג משתמש

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: DeleteUserBadgeResponse

דוגמה

דוגמת deleteUserBadge

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

קבלת תג משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

Returns: GetUserBadgeResponse

דוגמה

דוגמת getUserBadge

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);
  // גישה לשדות אופציונליים באופן בטוח
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

קבלת תגי משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	לא
badgeId	string	לא
type	number	לא
displayedOnComments	boolean	לא
limit	number	לא
skip	number	לא

תגובה

מחזיר: GetUserBadgesResponse

דוגמה

דוגמת getUserBadges

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

עדכון תג משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateUserBadgeParams	UpdateUserBadgeParams	כן

תגובה

מחזיר: UpdateUserBadgeResponse

דוגמא

דוגמא ל‑updateUserBadge

Copy

async function applyBadge() {
    const tenantId: string = "acme-corp-tenant";
    const userId: string = "user-98765";
    const params: UpdateUserBadgeParams = {
        badgeId: "gold-contributor",
        // דוגמה לשדה אופציונלי
        expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
    };
    const result: UpdateUserBadgeResponse = await updateUserBadge(tenantId, userId, params);
    console.log(result);
}
applyBadge();

קבלת ספירת התראות משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
sso	string	לא

תגובה

Returns: GetUserNotificationCountResponse1

דוגמה

דוגמת getUserNotificationCount

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // קריאה עם אסימון SSO אופציונלי
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // קריאה ללא אסימון SSO
    const countWithoutSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId
    );
    console.log(countWithSSO, countWithoutSSO);
}

קבלת התראות משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	No
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
includeTenantNotifications	boolean	No
sso	string	No

תגובה

מחזיר: GetUserNotificationsResponse

דוגמה

דוגמת getUserNotifications

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

איפוס ספירת התראות משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
sso	string	No

תשובה

מחזירה: ResetUserNotificationCountResponse

דוגמה

דוגמת resetUserNotificationCount

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // קריאה עם פרמטר sso אופציונלי
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // קריאה ללא פרמטר sso אופציונלי
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

איפוס התראות משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
afterId	string	לא
afterCreatedAt	number	לא
unreadOnly	boolean	לא
dmOnly	boolean	לא
noDm	boolean	לא
sso	string	לא

תגובה

מחזיר: ResetUserNotificationsResponse1

דוגמה

דוגמת resetUserNotifications

Copy

(async () => {
  const tenantId: string = "tenant-001";
  const afterId: string = "notif-123";
  const afterCreatedAt: number = 1697049600; // דוגמת חותמת זמן UNIX
  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);
})();

עדכון סטטוס מנוי התראות על תגובות של המשתמש

Enable or disable notifications for a specific comment.

Parameters

Name	Type	Required
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Response

מחזיר: UpdateUserNotificationCommentSubscriptionStatusResponse

דוגמה

updateUserNotificationCommentSubscriptionStatus דוגמה

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

עדכון סטטוס מנוי התראות על דפים של המשתמש

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

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

Response

Returns: UpdateUserNotificationPageSubscriptionStatusResponse

Example

דוגמה של updateUserNotificationPageSubscriptionStatus

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

עדכון סטטוס התראה של המשתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
notificationId	string	Yes
newStatus	UpdateUserNotificationStatusNewStatusEnum	Yes
sso	string	No

תשובה

מחזיר: UpdateUserNotificationStatusResponse

דוגמה

דוגמת updateUserNotificationStatus

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

קבלת סטטוסי נוכחות משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

תגובה

מחזיר: GetUserPresenceStatusesResponse1

דוגמה

דוגמת getUserPresenceStatuses

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

חיפוש משתמשים

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

תגובה

מחזיר: SearchUsersResponse1

דוגמה

דוגמת searchUsers

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

קבלת משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
id	string	Yes

תגובה

מחזיר: GetUserResponse1

דוגמה

דוגמת getUser

Copy

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

יצירת הצבעה

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
commentId	string	Yes
direction	CreateVoteDirectionEnum	Yes
userId	string	No
anonUserId	string	No

תגובה

מחזיר: CreateVoteResponse

דוגמה

דוגמת createVote

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

מחיקת הצבעה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
editKey	string	No

תגובה

מחזירה: DeleteVoteResponse

דוגמה

דוגמת deleteVote

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

קבלת הצבעות

פרמטרים

שם	סוג	דרוש	תיאור
tenantId	string	Yes
urlId	string	Yes

תגובה

מחזיר: GetVotesResponse1

דוגמה

דוגמת getVotes

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);
  // דוגמה לגישה לשדה אופציונלי בתגובה
  const firstVoteId: string | undefined = response?.votes?.[0]?.id;
}

קבלת הצבעות עבור משתמש

Parameters

שם	סוג	נדרש
tenantId	string	Yes
urlId	string	Yes
userId	string	No
anonUserId	string	No

Response

מחזיר: GetVotesForUserResponse1

Example

דוגמה getVotesForUser

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

צריכים עזרה?

אם אתם נתקלים בבעיות או יש לכם שאלות לגבי ה-JavaScript/TypeScript SDK, אנא:

תרומות

תרומות מתקבלות בברכה! אנא בקרו ב-מאגר GitHub לקבלת הנחיות לתרומה.

שפה 🇮🇱 עברית

התחלה

מפרט API

תיעוד

שימוש

אגרגציה

יומני ביקורת

חסימה מתגובה

בדיקת תגובות חסומות

תגובות

תגובות עבור משתמש

תצורות דומיין

תבניות אימייל

יומן אירועים

פוסטים בפיד

דיווח על תגובה

GIFs

תגיות

בקרה

ממונים

ספירת התראות

התראות

ריאקציות לעמוד

דפים

אירועי webhook תלויים

תצורות שאלה

תוצאות שאלות

אגרגציית תוצאות שאלות

משתמשי SSO

מנויים

שימוש יומי של שוכר

חבילות שוכר

משתמשי שוכר

שוכרים

כרטיסים

תרגומים

העלאת תמונה

התקדמות תג משתמש

תגי משתמש

התראות משתמש

סטטוס נוכחות משתמש

חיפוש משתמש

משתמשים

הצבעות

FastComments SDK ל-JavaScript/TypeScript

מאגר

התקנה

תיעוד ה-API

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

תאימות דפדפן מול שרת

שימוש

שימוש בדפדפן (צד-לקוח)

שימוש בצד השרת (Node.js)

ייבוא טיפוסים בלבד

שימוש במחלקות API בודדות

סביבה בדפדפן

סביבה בצד השרת

API ציבוריים לעומת מאובטחים

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

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

דוגמה: שימוש ב-Moderation API

אינטגרציית SSO (כניסה יחידה)

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

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

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

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

מקרי שימוש נפוצים

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

יצירת תגובה

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

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

אירועים חיים (עדכונים בזמן אמת)

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

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

קבלת userIdWS

מזהי שידור

טיפול בשגיאות

אגרגציה

פרמטרים

תגובה