FastComments JavaScript/TypeScript SDK

npm install fastcomments-sdk

Πλήρης αναφορά API: docs/api/README.md

Αυτό το SDK χρησιμοποιεί διπλά σημεία εισόδου για να εξασφαλίσει βέλτιστη συμβατότητα και να αποτρέψει σφάλματα χρόνου εκτέλεσης:

• fastcomments-sdk/browser - Έκδοση ασφαλής για περιηγητές με ενσωματωμένο fetch
• fastcomments-sdk/server - Πλήρης έκδοση για Node.js με υποστήριξη SSO
• fastcomments-sdk (προεπιλογή) - Μόνο τύποι, ασφαλές για εισαγωγή οπουδήποτε

The SDK παρέχει τρεις κύριες κλάσεις API:

• DefaultApi - Secured endpoints that require your API key for authentication. Use these for server-side operations.
• PublicApi - Public endpoints that can be accessed without an API key. These can be called directly from browsers/mobile devices/etc.
• HiddenApi - Internal/admin endpoints for advanced use cases.

Παράδειγμα: Χρήση Public API (ασφαλές για browsers)

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

const publicApi = new PublicApi();

// Λήψη σχολίων για σελίδα (δεν απαιτείται API key)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Παράδειγμα: Χρήση Default API (μόνο στην πλευρά του διακομιστή)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Κρατήστε το μυστικό!
});
const defaultApi = new DefaultApi(config);

// Λήψη σχολίων με πλήρη διαχειριστική πρόσβαση
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

FastComments υποστηρίζει SSO για ενσωμάτωση με το υπάρχον σύστημα πιστοποίησης χρηστών σας. Η λειτουργία SSO είναι διαθέσιμη μόνο στην έκδοση για διακομιστή καθώς απαιτεί δυνατότητες κρυπτογράφησης του 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 στον κώδικα της πλευράς πελάτη σας
// Ο κώδικας της πλευράς πελάτη μπορεί στη συνέχεια να χρησιμοποιήσει αυτό το token με το browser 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();

// Χρήση με κλήσεις API στον διακομιστή
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Ή στείλτε το ssoConfig στον πελάτη για χρήση στον browser

Χρήση SSO από τον Browser (με Token που δημιουργείται από τον διακομιστή)

// Κώδικας πλευράς πελάτη (browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Λάβετε το SSO token από το endpoint του διακομιστή σας
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

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

SSO με Δημιουργία Σχολίου

// Πλευρά διακομιστή: Δημιουργία 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 Key)

// Αναζήτηση χρηστών (απαιτεί DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Subscribe to live events to get real-time updates for comments, votes, and other activities.

Γεγονότα σε επίπεδο σελίδας

Ακούστε για ζωντανά γεγονότα σε μια συγκεκριμένη σελίδα (σχόλια, ψήφοι, κ.λπ.):

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);
        // Ενημερώστε το UI σας με το νέο σχόλιο
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Ενημερώστε τους μετρητές ψήφων στο UI σας
        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');
  }
);

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

Εγγραφή σε γεγονότα χρήστη

Ακούστε για γεγονότα που αφορούν συγκεκριμένο χρήστη (ειδοποιήσεις, αναφορές, κ.λπ.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Πάρτε αυτό από την απάντηση του getComments
};

// Εγγραφή στο προσωπικό feed του χρήστη
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Εμφανίστε την ειδοποίηση στο UI σας
        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');
  }
);

// Close when done
userSubscription.close();

Λήψη userIdWS

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

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

// Εξαγάγετε το userIdWS από την απάντηση
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Τώρα μπορείτε να εγγραφείτε σε ζωντανά γεγονότα
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε κάποιες κλήσεις API. Όταν λάβετε γεγονότα, θα σας επιστραφεί αυτό το ID, ώστε να ξέρετε να αγνοήσετε το γεγονός αν σκοπεύετε να εφαρμόσετε αλλαγές στον client με 'optimistic' τρόπο (πιθανότατα θα θέλετε να το κάνετε, καθώς προσφέρει την καλύτερη εμπειρία). Δώστε εδώ ένα 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() // Μοναδικό ID για αυτήν την ενέργεια
  }
});

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, κ.λπ.).

Parameters

Response

Επιστρέφει: AggregationResponse

Παράμετροι

Απάντηση

Επιστρέφει: GetAuditLogs200Response

Παράμετροι

Απόκριση

Επιστρέφει: BlockFromCommentPublic200Response

Παράμετροι

Απάντηση

Επιστρέφει: UnBlockCommentPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: CheckedCommentsForBlocked200Response

Παράμετροι

Απόκριση

Επιστρέφει: BlockFromCommentPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: CreateCommentPublic200Response

Παράμετροι

Απάντηση

Επιστρέφει: DeleteComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: DeleteCommentPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: DeleteCommentVote200Response

Παράμετροι

Απάντηση

Επιστρέφει: FlagComment200Response

Παράμετροι

Απάντηση

Επιστρέφει: GetComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: GetComments200Response

req tenantId urlId

Παράμετροι

Απόκριση

Επιστρέφει: GetCommentsPublic200Response

Παράμετροι

Απάντηση

Επιστρέφει: GetCommentText200Response

Παράμετροι

Απόκριση

Επιστρέφει: GetCommentVoteUserNames200Response

Παράμετροι

Απόκριση

Επιστρέφει: LockComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: PinComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: SaveComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: Array<SaveComment200Response

Parameters

Response

Επιστρέφει: SetCommentText200Response

Παράμετροι

Απόκριση

Επιστρέφει: UnBlockCommentPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: FlagComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: LockComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: PinComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: VoteComment200Response

Παράμετροι

Απόκριση

Επιστρέφει: AddDomainConfig200Response

Παράμετροι

Απόκριση

Επιστρέφει: DeleteDomainConfig200Response

Παράμετροι

Απόκριση

Επιστρέφει: GetDomainConfig200Response

Παράμετροι

Απόκριση

Επιστρέφει: GetDomainConfigs200Response

Παράμετροι

Απόκριση

Επιστρέφει: GetDomainConfig200Response

Παράμετροι

Απόκριση

Επιστρέφει: GetDomainConfig200Response

Παράμετροι

Απόκριση

Επιστρέφει: CreateEmailTemplate200Response

Παράδειγμα

Παράδειγμα createEmailTemplate

Copy

1

2const tenantId: string = "tenant_7a9f2b3d";

3

4const createEmailTemplateBody: CreateEmailTemplateBody = {

5 name: "Comment Notification",

6 subject: "New comment on your article: ",

7 htmlBody: "<p> left a comment:</p><blockquote></blockquote>",

8 enabled: true,

9 defaultLocale: "en-US",

10 metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // προαιρετικά επιπλέον δεδομένα

11};

12

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

14

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deleteEmailTemplate

Copy

1

2const tenantId: string = "tenant_4b2f6a-4b2f6a2d";

3const templateId: string = "email_template_9f8b7c3e";

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

5const status: APIStatus | undefined = result?.status

6

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deleteEmailTemplateRenderError

Copy

1

2const tenantId: string = "tenant_8f3b2a9c";

3const id: string = "template_4a1c9f7e";

4const errorId: string = "err_20260112_abc123";

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

6

Παράμετροι

Απόκριση

Επιστρέφει: GetEmailTemplate200Response

Παράδειγμα

Παράδειγμα getEmailTemplate

Copy

1

2(async () => {

3 const tenantId: string = 'acme-enterprises-123';

4 const id: string = 'welcome-email-template-v2';

5 const locale: string | undefined = 'en-US'; // παράδειγμα προαιρετικής παραμέτρου

6 const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);

7 console.log(template, locale);

8})();

9

Παράμετροι

Απόκριση

Επιστρέφει: GetEmailTemplateDefinitions200Response

Παράδειγμα

Παράδειγμα getEmailTemplateDefinitions

Copy

1

2const tenantId: string = 'acme-enterprises-78f2';

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

4

Παράμετροι

Απόκριση

Επιστρέφει: GetEmailTemplateRenderErrors200Response

Παράδειγμα

Παράδειγμα getEmailTemplateRenderErrors

Copy

1

2const tenantId: string = "tenant_7b3f2a9c";

3const id: string = "tmpl_4f1b2c9e";

4const skip: number = 25;

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

6

Παράμετροι

Απόκριση

Επιστρέφει: GetEmailTemplates200Response

Παράδειγμα

Παράδειγμα getEmailTemplates

Copy

1

2const tenantId: string = 'tenant_8f4d2b7c';

3const responseWithoutSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId);

4const skip: number = 20;

5const responseWithSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

6

Παράμετροι

Απόκριση

Επιστρέφει: RenderEmailTemplate200Response

Παράδειγμα

Παράδειγμα renderEmailTemplate

Copy

1

2const tenantId: string = 'acme-corp-7f3';

3const renderEmailTemplateBody: RenderEmailTemplateBody = {

4 templateId: 'new-comment-notification',

5 recipientEmail: 'jane.doe@acme.com',

6 variables: {

7 commenterName: 'Samir Patel',

8 commentText: 'I found this article really helpful — thanks for sharing!',

9 threadUrl: 'https://acme.com/blog/123#comments'

10 },

11 includeUnsubscribeLink: true

12};

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

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

15

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα updateEmailTemplate

Copy

1

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

3const id: string = 'email_tpl_42b7a9';

4const updateEmailTemplateBody: UpdateEmailTemplateBody = {

5 name: 'Comment Flag Notification',

6 subject: 'A comment was flagged on acme.com',

7 html: '<p>A comment by was flagged. Review at </p>',

8 replyTo: 'noreply@acme.com', // προαιρετικό πεδίο (παράδειγμα)

9 enabled: true,

10 customConfig: { priority: 'high' } // προαιρετικές προσαρμοσμένες παράμετροι

11};

12const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

13

req tenantId urlId userIdWS

Παράμετροι

Απόκριση

Επιστρέφει: GetEventLog200Response

req tenantId urlId userIdWS

Παράμετροι

Απόκριση

Επιστρέφει: GetEventLog200Response

Παράμετροι

Απόκριση

Επιστρέφει: CreateFeedPost200Response

Παράμετροι

Απόκριση

Επιστρέφει: CreateFeedPostPublic200Response

Parameters

Response

Επιστρέφει: DeleteFeedPostPublic200Response

req tenantId afterId

Παράμετροι

Απόκριση

Επιστρέφει: GetFeedPosts200Response

req tenantId afterId

Παράμετροι

Απόκριση

Επιστρέφει: GetFeedPostsPublic200Response

Παράμετροι

Απάντηση

Επιστρέφει: GetFeedPostsStats200Response

Παράμετροι

Απάντηση

Επιστρέφει: GetUserReactsPublic200Response

Παράμετροι

Απάντηση

Επιστρέφει: ReactFeedPostPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: CreateFeedPostPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράμετροι

Απόκριση

Επιστρέφει: AddHashTag200Response

Παράδειγμα

Παράδειγμα addHashTag

Copy

1

2const tenantId: string = 'tenant_7b2f6c2b';

3const createBody: CreateHashTagBody = {

4 tag: 'feature-request',

5 label: 'Feature Request',

6 description: 'Requests for new functionality in the web client',

7 isActive: true,

8 visibility: 'public',

9 allowedDomains: ['example.com', 'internal.example.com']

10};

11const result: AddHashTag200Response = await addHashTag(tenantId, createBody);

12const resultWithoutTenant: AddHashTag200Response = await addHashTag(undefined, {

13 tag: 'bug',

14 label: 'Bug',

15 description: 'Use for reproducible bugs reported by users',

16 isActive: true,

17 visibility: 'public'

18});

19

Παράμετροι

Απόκριση

Επιστρέφει: AddHashTagsBulk200Response

Παράδειγμα

Παράδειγμα addHashTagsBulk

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_3f2b9a';

4 const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {

5 tags: [

6 { name: 'performance', description: 'Comments about site performance', visibleToModeratorsOnly: false },

7 { name: 'feature-request', description: 'Requests for new features', visibleToModeratorsOnly: true }

8 ]

9 };

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

11 const resultWithNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

12 console.log(result, resultWithNoTenant);

13})();

14

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deleteHashTag

Copy

1

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

3const tenantId: string = 'tenant_42';

4const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;

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

6

Παράμετροι

Απόκριση

Επιστρέφει: GetHashTags200Response

Παράδειγμα

Παράδειγμα getHashTags

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp-7a9f";

4 const tagsPage1: GetHashTags200Response = await getHashTags(tenantId);

5 const tagsPage2: GetHashTags200Response = await getHashTags(tenantId, 2);

6 console.log(tagsPage1, tagsPage2);

7})();

8

Παράμετροι

Απάντηση

Επιστρέφει: PatchHashTag200Response

Παράδειγμα

Παράδειγμα patchHashTag

Copy

1

2const tag: string = 'release-2026';

3const tenantId: string = 'tenant_42';

4const updateHashTagBody: UpdateHashTagBody = {

5 displayName: 'Release 2026',

6 description: 'Discussions and notes for the 2026 product release',

7 isActive: true

8};

9const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

10

Παράμετροι

Απόκριση

Επιστρέφει: CreateModerator200Response

Παράδειγμα

Παράδειγμα createModerator

Copy

1

2const tenantId: string = "tenant_prod_us-east_01";

3const createModeratorBody: CreateModeratorBody = {

4 email: "maria.lopez+mod@fastcompany.com",

5 username: "mlopez_mod",

6 displayName: "Maria Lopez",

7 roles: ["content_moderator"],

8 notifyOnReports: true,

9 metadata: { region: "us-east", team: "community" }

10};

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

12

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

deleteModerator Παράδειγμα

Copy

1

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

3const moderatorId: string = 'mod-78b2c9a4-3f1e-4d6a';

4const sendEmail: string = 'true';

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

6

Παράμετροι

Απόκριση

Επιστρέφει: GetModerator200Response

Παράδειγμα

Παράδειγμα getModerator

Copy

1

2const tenantId: string = "tenant_eu_4f8d2b9e";

3const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // προαιρετική πηγή (μπορεί να είναι undefined)

4const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

5

Παράμετροι

Απόκριση

Επιστρέφει: GetModerators200Response

Παράδειγμα

Παράδειγμα getModerators

Copy

1

2const tenantId: string = "tenant_corp_7f9b2a";

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

4const skip: number = 50;

5const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

6

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα sendInvite

Copy

1

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

3const id: string = 'comment_9b7f3a2c';

4const fromName: string = 'María Hernández';

5const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

6

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα updateModerator

Copy

1

2const tenantId: string = '4f8a9c2e-3b6d-4d9e-8c2f-1a2b3c4d5e6f';

3const id: string = 'mod_92a7c4';

4const updateModeratorBodyMinimal: UpdateModeratorBody = { displayName: 'Sophia Patel' };

5const updateModeratorBodyWithOptional: UpdateModeratorBody = {

6 displayName: 'Sophia Patel',

7 email: 'sophia.patel@newsroom.example',

8 permissions: ['remove_comments', 'ban_user'],

9 notifyOnFlag: true // προαιρετική παράμετρος (παράδειγμα)

10};

11const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);

12

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deleteNotificationCount

Copy

1

2const tenantId: string = 'tenant_7f3a1b2c4d9e';

3const notificationId: string = 'notif_8c9d0a1b2f3e4b7';

4const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);

5

Παράμετροι

Απόκριση

Επιστρέφει: GetCachedNotificationCount200Response

Παράδειγμα

Παράδειγμα getCachedNotificationCount

Copy

1

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

3const baseNotificationId: string = 'notif-000123';

4const idSuffix: string | undefined = undefined; // παράδειγμα προαιρετικής παραμέτρου

5const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;

6const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);

7console.log(result);

8

Παράμετροι

Απόκριση

Επιστρέφει: GetNotificationCount200Response

Παράδειγμα

Παράδειγμα getNotificationCount

Copy

1

2const tenantId: string = 'tenant_8a9b7c';

3const userId: string = 'user_42b3c';

4const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';

5const fromCommentId: string | undefined = undefined;

6const viewed: boolean = false;

7const type: string = 'mention';

8const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

9

Παράμετροι

Απόκριση

Επιστρέφει: GetNotifications200Response

Παράδειγμα

Παράδειγμα getNotifications

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_8f3b1a2c';

4 const userId: string = 'user_42';

5 const urlId: string = 'https://news.example.com/articles/2026/01/11/comment-thread';

6 const fromCommentId: string = 'cmt_9a7b';

7 const viewed: boolean = false;

8 const type: string = 'mention';

9 const skip: number = 0;

10 const response: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

11 console.log(response);

12})();

13

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα updateNotification

Copy

1

2const tenantId: string = "tenant_86a7b3";

3const id: string = "notif_20260112_01";

4const userId: string = "moderator_42";

5const updateNotificationBody: UpdateNotificationBody = {

6 name: "Flagged comment alert",

7 enabled: true,

8 channels: ["email"],

9 recipients: ["mod-team@news-site.com"],

10 threshold: 1

11};

12

13(async () => {

14 const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

15 console.log(result);

16})();

17

Παράμετροι

Απόκριση

Επιστρέφει: AddPageAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: DeletePageAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: GetPageByURLIdAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: GetPagesAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: PatchPageAPIResponse

Παράμετροι

Απάντηση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deletePendingWebhookEvent

Copy

1

2const tenantId: string = 'tenant_7f4e2b';

3const pendingEventId: string = '9f7b6a8c-3b2a-4c0d-a8e5-1234567890ab';

4const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, pendingEventId);

5console.log(result);

6

Παράμετροι

Απόκριση

Επιστρέφει: GetPendingWebhookEventCount200Response

Παράδειγμα

Παράδειγμα getPendingWebhookEventCount

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_9c3b2b';

4 const commentId: string = 'cmt_f4a1b2';

5 const externalId: string = 'ext-789';

6 const eventType: string = 'comment.created';

7 const type: string = 'delivery';

8 const domain: string = 'app.example.com';

9 const attemptCountGT: number = 2;

10

11 const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(

12 tenantId,

13 commentId,

14 externalId,

15 eventType,

16 type,

17 domain,

18 attemptCountGT

19 );

20

21 console.log(result);

22})();

23

Παράμετροι

Απόκριση

Επιστρέφει: GetPendingWebhookEvents200Response

Παράδειγμα

Παράδειγμα getPendingWebhookEvents

Copy

1

2const tenantId: string = "tenant_78b2f1";

3const commentId: string = "cmt_0042";

4const eventType: string = "comment.created";

5const domain: string = "blog.example.com";

6const attemptCountGT: number = 1;

7const skip: number = 0;

8

9const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(

10 tenantId,

11 commentId,

12 undefined, // externalId

13 eventType,

14 undefined, // type

15 domain,

16 attemptCountGT,

17 skip

18);

19

Παράμετροι

Απάντηση

Επιστρέφει: CreateQuestionConfig200Response

Παράδειγμα

Παράδειγμα createQuestionConfig

Copy

1

2const tenantId: string = "tenant_live_7f8b3c2a";

3const customOptions: QuestionConfigCustomOptionsInner[] = [

4 { value: "under18", label: "Under 18" },

5 { value: "18-24", label: "18-24" },

6 { value: "25-34", label: "25-34", defaultSelected: true }

7];

8const createQuestionConfigBody: CreateQuestionConfigBody = {

9 key: "age_range",

10 label: "What is your age range?",

11 required: false, // προαιρετικό: δείχνει παράλειψη έναντι συμπερίληψης προαιρετικών πεδίων

12 renderingType: QuestionRenderingType.Dropdown,

13 options: customOptions,

14 whenSave: QuestionWhenSave.Always

15};

16const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

17

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deleteQuestionConfig

Copy

1

2async function deleteIfPresent(tenantId: string, id?: string): Promise<FlagCommentPublic200Response | null> {

3 if (!id) return null;

4 const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

5 return result;

6}

7const tenantId: string = 'tenant_acme_001';

8const optionalConfigId: string | undefined = 'qcfg_20260112_01';

9(async (): Promise<void> => {

10 const deleted: FlagCommentPublic200Response | null = await deleteIfPresent(tenantId, optionalConfigId);

11 void deleted;

12})();

13

Παράμετροι

Απόκριση

Επιστρέφει: GetQuestionConfig200Response

Παράδειγμα

Παράδειγμα getQuestionConfig

Copy

1

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

3const questionId: string = 'q-2026-01-12-01';

4const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);

5function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {

6 // Το includeMetadata είναι προαιρετικό; η υλοποίηση παραλείπεται για συντομία

7 return undefined;

8}

9const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);

10const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

11

Παράμετροι

Απόκριση

Επιστρέφει: GetQuestionConfigs200Response

Παράδειγμα

Παράδειγμα getQuestionConfigs

Copy

1

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

3const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);

4const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);

5

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα updateQuestionConfig

Copy

1

2const tenantId: string = 'tenant-82b3a';

3const id: string = 'qst-20260112';

4const updateQuestionConfigBody: UpdateQuestionConfigBody = { label: 'Age verification', required: true, renderingType: 'singleChoice', customOptions: [{ value: '18-24', label: '18–24' }] } as UpdateQuestionConfigBody;

5const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

6

Παράμετροι

Απόκριση

Επιστρέφει: CreateQuestionResult200Response

Παράδειγμα

Παράδειγμα createQuestionResult

Copy

1

2const tenantId: string = "fc_tenant_7a3c_us-east-1";

3const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };

4const createQuestionResultBody: CreateQuestionResultBody = {

5 questionId: "q_42",

6 commenterId: "user_1984",

7 answer: "yes",

8 score: 4,

9 meta: [metaItem] // προαιρετικά μεταδεδομένα (παράδειγμα)

10} as CreateQuestionResultBody;

11const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

12

Parameters

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deleteQuestionResult

Copy

1

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

3const questionResultId: string = '6f1a2b3c-4d5e-6789-abcd-ef0123456789';

4const deletedResult: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, questionResultId);

5console.log(deletedResult);

6

Παράμετροι

Απόκριση

Επιστρέφει: GetQuestionResult200Response

Παράδειγμα

Παράδειγμα getQuestionResult

Copy

1

2const tenantId: string = "3fa85f64-5717-4562-b3fc-2c963f66afa6";

3const questionId: string = "question_72f1b9c3a4";

4const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);

5console.log(result);

6

Παράμετροι

Απόκριση

Επιστρέφει: GetQuestionResults200Response

Παράδειγμα

Παράδειγμα getQuestionResults

Copy

1

2const tenantId: string = 'tenant_42';

3const urlId: string = 'news/2025/fastcomments-release';

4const userId: string = 'user_8b7f3c';

5const startDate: string = '2025-01-01T00:00:00Z';

6const questionIds: string = 'q123,q124';

7const skip: number = 20;

8const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

9

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα updateQuestionResult

Copy

1

2const tenantId: string = 'tenant_84f2b9';

3const id: string = 'question_3a7c1d';

4const updateQuestionResultBody: UpdateQuestionResultBody = {

5 result: { verdict: 'helpful', confidence: 0.92 },

6 reviewer: { id: 'mod_102', name: 'Aisha Rahman' },

7 notifyUser: true // προαιρετική παράμετρος που συμπεριλαμβάνεται

8};

9const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

10

Παράμετροι

Απόκριση

Επιστρέφει: AggregateQuestionResults200Response

Παράμετροι

Απόκριση

Επιστρέφει: BulkAggregateQuestionResults200Response

Παράμετροι

Απόκριση

Επιστρέφει: CombineCommentsWithQuestionResults200Response

Παράμετροι

Απάντηση

Επιστρέφει: AddSSOUserAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: DeleteSSOUserAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: GetSSOUserByEmailAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: GetSSOUserByIdAPIResponse

Παράμετροι

Response

Επιστρέφει: GetSSOUsers200Response

Παράμετροι

Απόκριση

Επιστρέφει: PatchSSOUserAPIResponse

Παράμετροι

Απάντηση

Επιστρέφει: PutSSOUserAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: CreateSubscriptionAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: DeleteSubscriptionAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: GetSubscriptionsAPIResponse

Παράμετροι

Απόκριση

Επιστρέφει: GetTenantDailyUsages200Response

Παράδειγμα

Παράδειγμα getTenantDailyUsages

Copy

1

2const tenantId: string = "tenant_89f3c2-prod";

3const yearNumber: number = 2026;

4const monthNumber: number = 1;

5const skip: number = 0;

6const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

7

Παράμετροι

Απάντηση

Επιστρέφει: CreateTenantPackage200Response

Παράδειγμα

Παράδειγμα createTenantPackage

Copy

1

2const tenantId: string = "tenant_7f3b1a9c";

3const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };

4const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };

5const createTenantPackageBody: CreateTenantPackageBody = {

6 packageName: "Premium Plus",

7 tenantPackage,

8 customConfig,

9 notes: "Enable advanced moderation and image uploads" // προαιρετική παράμετρος για επίδειξη

10};

11const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

12

Παράμετροι

Απόκριση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα deleteTenantPackage

Copy

1

2const tenantId: string = 'fc-tenant-8a9c2b';

3const packageId: string = 'pkg-47f3c9';

4const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

5

Παράμετροι

Απόκριση

Επιστρέφει: GetTenantPackage200Response

Παράδειγμα

Παράδειγμα getTenantPackage

Copy

1

2const tenantId: string = 'tenant_westus_01';

3const packageId: string = 'pkg_premium_annual_2026';

4interface FetchOptions { includeArchived?: boolean }

5const options: FetchOptions = { includeArchived: false };

6const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

7

Παράμετροι

Απόκριση

Επιστρέφει: GetTenantPackages200Response

Παράδειγμα

Παράδειγμα getTenantPackages

Copy

1

2const tenantId: string = 'tenant_4f3a9c2d';

3const skip: number = 25;

4const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);

5const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

6

Παράμετροι

Απάντηση

Επιστρέφει: FlagCommentPublic200Response

Παράδειγμα

Παράδειγμα replaceTenantPackage

Copy

1

2const tenantId: string = 'tenant-9b72f2';

3const packageId: string = 'pkg-prod-v2';

4const replaceTenantPackageBody: ReplaceTenantPackageBody = {

5 name: 'Premium Moderation Bundle',

6 enabled: true,

7 maxModerators: 4,

8 // προαιρετικά πεδία όπως τα "notes" ή "trialExpiry" έχουν σκόπιμα παραληφθεί εδώ

9} as ReplaceTenantPackageBody;

10const result: FlagCommentPublic200Response = await replaceTenantPackage(

11 tenantId,

12 packageId,

13 replaceTenantPackageBody

14);

15