FastComments の JavaScript/TypeScript SDK

npm install fastcomments-sdk

完全な API リファレンス: docs/api/README.md

この SDK は、最適な互換性を確保し実行時エラーを防ぐために デュアルエントリポイント を使用します:

• fastcomments-sdk/browser - ブラウザ安全版（ネイティブの fetch 使用）
• fastcomments-sdk/server - SSO をサポートするフル Node.js バージョン
• fastcomments-sdk (デフォルト) - 型定義のみ、どこでも安全にインポート可能

The SDK は3つの主要な API クラスを提供します:

• DefaultApi - 認証に API キーを必要とする保護されたエンドポイント。サーバー側の操作に使用してください。
• PublicApi - API キーなしでアクセスできる公開エンドポイント。ブラウザやモバイルデバイスなどから直接呼び出せます。
• HiddenApi - 高度なユースケース向けの内部／管理者用エンドポイント。

例: Public API の使用（ブラウザ対応）

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

const publicApi = new PublicApi();

// ページのコメントを取得（API キー不要）
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

例: Default API の使用（サーバー側のみ）

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

const config = new Configuration({
  apiKey: 'your-api-key' // これは秘密にしてください！
});
const defaultApi = new DefaultApi(config);

// 管理者権限でコメントを取得
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

FastComments は既存のユーザー認証システムと統合するための SSO をサポートしています。SSO 機能は Node.js の crypto 機能を必要とするため、サーバーエクスポートでのみ利用可能です。

Simple SSO（サーバーサイドのみ）

Simple SSO はサーバーサイドで生成してクライアントに送信する必要があります：

// サーバー側のコード (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 組み込みのヘルパーを使って simple 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 で使用できます

Secure SSO（サーバーサイド、推奨）

Secure SSO はサーバーサイドで実装するべきで、より高いセキュリティを提供します：

// サーバー側のコード (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 組み込みのヘルパーを使って secure 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 をクライアントに送ってブラウザで使用

ブラウザからの 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',
};

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Update your UI with the new comment
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Update vote counts in your UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

ユーザーイベントを購読

ユーザー固有のイベント（通知、メンションなど）を監視します:

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

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

// Subscribe to user's personal 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);
        // Show notification in your 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'
});

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

You'll see you're supposed to pass a broadcastId in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client (which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.

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

戻り値: Aggregate200Response

Example

aggregate の例

Copy

1

2const tenantId: string = 'tenant_78a9';

3const parentTenantId: string = 'parent_tenant_01';

4const includeStats: boolean = true;

5const aggregationRequest: AggregationRequest = {

6 operation: { type: 'COUNT' },

7 groupBy: ['pageUrl'],

8 predicate: { field: 'status', operator: 'EQUALS', value: 'approved' },

9 sort: [{ field: 'count', direction: 'DESC' }],

10 limit: 25

11};

12const result: Aggregate200Response = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

13

パラメータ

レスポンス

戻り値: GetAuditLogs200Response

例

getAuditLogs の例

Copy

1

2const tenantId: string = 'tenant_5f8d7c3a';

3const limit: number = 100;

4const skip: number = 0;

5const order: SORTDIR = 'DESC' as SORTDIR;

6const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 1週間前

7const before: number = Date.now();

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

9

パラメータ

レスポンス

戻り値: BlockFromCommentPublic200Response

例

blockFromCommentPublic の例

Copy

1

2const tenantId: string = 'tenant_6b3f9a2d';

3const commentId: string = 'cmt_8f4b12a9';

4const publicBlockFromCommentParams: PublicBlockFromCommentParams = {

5 reason: 'Repeated promotional links',

6 durationMinutes: 60 * 24 * 30, // 30日間

7 escalateToModeration: true

8};

9const sso: string = 'sso_token_3fH7kLw';

10

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

12

パラメータ

レスポンス

戻り値: UnBlockCommentPublic200Response

例

unBlockCommentPublic の例

Copy

1

2const tenantId: string = "tenant-42-production";

3const commentId: string = "comment_7f3b2a9d";

4const publicBlockFromCommentParams: PublicBlockFromCommentParams = {

5 reason: "flag reviewed and determined not to violate policy",

6 restoredBy: "moderator_jane",

7 restoredAt: new Date().toISOString()

8};

9const sso: string = "sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";

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

11

パラメータ

レスポンス

戻り値: CheckedCommentsForBlocked200Response

例

checkedCommentsForBlocked の例

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_fa3b2c9e';

4 const commentIds: string = 'cmt_112233,cmt_445566';

5 const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0Njc4IiwidGVuYW50IjoidGVuYW50X2ZhM2IifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

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

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

8 console.log(resultWithSSO, resultWithoutSSO);

9})();

10

パラメータ

レスポンス

戻り値: BlockFromCommentPublic200Response

例

blockUserFromComment の例

Copy

1

2const tenantId: string = "tenant_7f3b4c";

3const id: string = "comment_9a8b7c6d";

4const blockFromCommentParams: BlockFromCommentParams = {

5 reason: "Repeated spam links",

6 durationHours: 168,

7 notifyModerators: true

8};

9const userId: string | undefined = "user_42";

10const anonUserId: string | undefined = undefined;

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

12

パラメーター

レスポンス

返却値: CreateCommentPublic200Response

例

createCommentPublic の例

Copy

1

2const tenantId: string = 'tenant_9a1b2c';

3const urlId: string = 'https://www.news-site.com/article/67890';

4const broadcastId: string = 'broadcast_2026-06-15-01';

5const sessionId: string | undefined = 'sess_abc123xyz';

6const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiam9yZGFuIiwiaWF0IjoxNjI0MDAwMDB9.signature';

7const commentData: CommentData = {

8 content: 'Insightful piece — I appreciated the data-backed points and sources cited.',

9 authorDisplayName: 'Jordan Miles'

10} as CommentData;

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

12

パラメータ

レスポンス

戻り値: DeleteComment200Response

例

deleteComment の例

Copy

1

2const tenantId: string = 'tenant_84a9f2';

3const id: string = 'comment_5f3b21';

4const contextUserId: string | undefined = 'user_1122';

5const isLive: boolean | undefined = true;

6

7async function run(): Promise<void> {

8 const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);

9 console.log(result);

10}

11

12run();

13

パラメータ

レスポンス

戻り値: DeleteCommentPublic200Response

例

deleteCommentPublic の例

Copy

1

2const tenantId: string = 'tenant_acme_42';

3const commentId: string = 'c0mment-9f8b7a6';

4const broadcastId: string = 'site_homepage_2026-06-15';

5const editKey: string = 'ek_3b7a1f59-4d2c-11eb-8dcd-0242ac130003';

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

7

8const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

9

パラメータ

レスポンス

戻り値: DeleteCommentVote200Response

例

deleteCommentVote の例

Copy

1

2const tenantId: string = 'tenant_8f3a2b7c';

3const commentId: string = 'cmt-5a1f3d92';

4const voteId: string = 'vote-3b9c7e1a';

5const urlId: string = 'articles/2026/06/typescript-best-practices';

6const broadcastId: string = 'broadcast-77f4d2';

7const editKey: string = 'edk-9b2f4c';

8const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';

9const result: DeleteCommentVote200Response = await deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, editKey, sso);

10

パラメータ

レスポンス

戻り値: FlagComment200Response

例

flagComment の例

Copy

1

2const tenantId: string = "tenant_4f21c9a";

3const commentId: string = "cmt_7a12b3e9";

4const userId: string = "user_82bd123";

5const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

6

Parameters

Response

戻り値: GetComment200Response

Example

getComment の例

Copy

1

2const tenantId: string = 'tenant_6f1a2b';

3const commentId: string = 'cmt_4d9e8f';

4const includeReplies: boolean | undefined = true; // オプションパラメータの例（getCommentには渡されません）

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

6console.log('Fetched comment for tenant:', tenantId, 'comment id:', commentId);

7console.log('API response received:', result);

8

パラメータ

レスポンス

戻り値: GetComments200Response

例

getComments の例

Copy

1

2const tenantId: string = "tenant_9a12b3";

3const response: GetComments200Response = await getComments(tenantId, 1, 20, 0, true, 0, 3, 2, "https://mysite.com/posts/678", undefined, undefined, undefined, undefined, "parent_987", undefined, 1716873600000, 1719552000000);

4

req tenantId urlId

パラメータ

レスポンス

戻り値: GetCommentsPublic200Response

例

getCommentsPublic の例

Copy

1

2const tenantId: string = 'acme-news';

3const urlId: string = '/articles/2026/fastcomments-update';

4const page: number = 1;

5const skip: number = 0;

6const limit: number = 25;

7const countChildren: boolean = true;

8const includeConfig: boolean = true;

9const result: GetCommentsPublic200Response = await getCommentsPublic(

10 tenantId,

11 urlId,

12 page,

13 undefined,

14 undefined,

15 skip,

16 undefined,

17 limit,

18 undefined,

19 countChildren,

20 undefined,

21 includeConfig

22);

23

パラメータ

レスポンス

返り値: GetCommentText200Response

例

getCommentText の例

Copy

1

2const tenantId: string = 'tenant_42b7e9';

3const commentId: string = 'cmt_9f3a2b';

4const editKey: string = 'edk_3f1b7c9d';

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

6

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

8

パラメータ

レスポンス

戻り値: GetCommentVoteUserNames200Response

例

getCommentVoteUserNames の例

Copy

1

2const tenantId: string = "tenant_67890";

3const commentId: string = "comment_abc123";

4const dir: number = 1;

5const ssoToken: string = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";

6

7const responseWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);

8const responseWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

9

パラメータ

レスポンス

戻り値: LockComment200Response

例

lockCommentの例

Copy

1

2const tenantId: string = 'tenant_42f6c1';

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

4const broadcastId: string = 'brd_2026_06_15';

5const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTY1MDAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

6

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

8const lockedWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

9

パラメータ

レスポンス

返却値: PinComment200Response

例

pinComment の例

Copy

1

2const tenantId: string = "acme-corp-tenant-72";

3const commentId: string = "cmt_8f3a2b4c9d";

4const broadcastId: string = "live_2026-06-15_21z";

5const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload.signature";

6

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

8const responseWithSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, ssoToken);

9

パラメータ

レスポンス

戻り値: SaveComment200Response

例

saveComment の例

Copy

1

2const tenantId: string = "fastcomments-tenant-42";

3const createCommentParams: CreateCommentParams = {

4 threadId: "article-2026-06-0142",

5 content: "Great write-up — I followed the migration steps and everything worked as described.",

6 userId: "u_9c72b",

7 userName: "Ava R.",

8 userAvatarUrl: "https://cdn.example.com/avatars/u_9c72b.png",

9 metadata: { platform: "web", locale: "en-US" }

10};

11const isLive: boolean = true;

12const doSpamCheck: boolean = true;

13const sendEmails: boolean = false;

14const populateNotifications: boolean = true;

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

16

パラメータ

レスポンス

戻り値: Array<SaveComment200Response

例

saveCommentsBulk の例

Copy

1

2const tenantId: string = "tenant_42a1b7";

3const mentions: CommentUserMentionInfo[] = [{ userId: "user_2b9", displayName: "Alex Chen" }];

4const hashtags: CommentUserHashTagInfo[] = [{ tag: "performance" }];

5const createCommentParams: CreateCommentParams[] = [

6 {

7 content: "Thanks for the detailed article — the alternative approach worked for me.",

8 authorId: "user_8f3c2",

9 authorName: "Maya Patel",

10 authorEmail: "maya.patel@example.com",

11 url: "/articles/optimizing-ts-performance",

12 createdAt: new Date().toISOString(),

13 mentions,

14 hashtags

15 }

16];

17const isLive: boolean = true;

18const doSpamCheck: boolean = false;

19const sendEmails: boolean = true;

20const populateNotifications: boolean = true;

21const result: Array<SaveComment200Response> = await saveCommentsBulk(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

22

パラメータ

レスポンス

返却値: SetCommentText200Response

例

setCommentText の例

Copy

1

2const tenantId: string = 'tenant_4f9a2b'

3const commentId: string = 'cmt-8421'

4const broadcastId: string = 'brd-2026-06-15'

5const commentTextUpdateRequest: CommentTextUpdateRequest = { text: 'Updated comment text to clarify the schedule.', mentions: [], hashtags: [] }

6const editKey: string = 'editkey_9b12'

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

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

9

パラメータ

レスポンス

戻り値: UnBlockCommentPublic200Response

例

unBlockUserFromComment の例

Copy

1

2const tenantId: string = 'tenant_7b9c2a';

3const id: string = 'comment_4f8e1d';

4const unBlockFromCommentParams: UnBlockFromCommentParams = {

5 reason: 'User submitted appeal and provided additional context',

6 effectiveAt: new Date().toISOString()

7};

8const userId: string = 'user_92a3f6';

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

10

パラメータ

レスポンス

戻り値: FlagComment200Response

例

unFlagComment の例

Copy

1

2const tenantId: string = 'tenant_8f3b2a1f';

3const commentId: string = 'cmt_20250614_01';

4const userId: string = 'user_47d2b9';

5const result: FlagComment200Response = await unFlagComment(tenantId, commentId, userId);

6

パラメータ

レスポンス

戻り値: LockComment200Response

例

unLockComment の例

Copy

1

2const tenantId: string = "tenant-8f3b2c4a";

3const commentId: string = "cmt_92a7f3e6";

4const broadcastId: string = "brd_1b4c9d20";

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

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

7

パラメータ

レスポンス

戻り値: PinComment200Response

例

unPinComment の例

Copy

1

2const tenantId: string = "tenant_9f3b2c1a";

3const commentId: string = "comment_4d2e8a7f";

4const broadcastId: string = "broadcast_live_2026_06_15_18";

5const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.invalid-signature";

6const response: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

7console.log(response);

8

パラメータ

レスポンス

戻り値: FlagCommentPublic200Response

例

updateComment の例

Copy

1

2const tenantId: string = 'tenant_7f3c1b2a';

3const commentId: string = 'cmt_8d9f2a4b';

4const updatableCommentParams: UpdatableCommentParams = {

5 body: 'Updating this comment to clarify the feature behavior and include a timestamp.',

6 metadata: { category: 'support', editedReason: 'clarify instructions' },

7 visible: true

8};

9const contextUserId: string = 'user_42';

10const doSpamCheck: boolean = true;

11const result: FlagCommentPublic200Response = await updateComment(tenantId, commentId, updatableCommentParams, contextUserId, doSpamCheck);

12

パラメータ

レスポンス

戻り値: VoteComment200Response

例

voteComment の例

Copy

1

2const tenantId: string = 'tenant_7f9d2e';

3const commentId: string = '5a1d3f9b-2c4e-4a2b-bf7b-1234567890ab';

4const urlId: string = 'articles/2026/06/15/typescript-api-patterns';

5const broadcastId: string = 'broadcast-20260615-01';

6const voteBodyParams: VoteBodyParams = { vote: 'up' };

7const sessionId: string = 'sess_9d2f3b45';

8const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY5NzE2MDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

9

10const response: VoteComment200Response = await voteComment(

11 tenantId,

12 commentId,

13 urlId,

14 broadcastId,

15 voteBodyParams,

16 sessionId,

17 sso

18);

19

パラメータ

レスポンス

返却値: GetCommentsForUser200Response

例

getCommentsForUser の例

Copy

1

2const userId: string = "550e8400-e29b-41d4-a716-446655440000";

3const page: number = 2;

4const includei10n: boolean = true;

5const locale: string = "en-US";

6const isCrawler: boolean = false;

7

8const comments: GetCommentsForUser200Response = await getCommentsForUser(

9 userId,

10 undefined, // direction を省略

11 undefined, // repliesToUserId を省略

12 page,

13 includei10n,

14 locale,

15 isCrawler

16);

17

18console.log(comments);

19

パラメータ

レスポンス

戻り値: AddDomainConfig200Response

パラメータ

レスポンス

戻り値: DeleteDomainConfig200Response

パラメータ

レスポンス

戻り値: GetDomainConfig200Response

パラメータ

レスポンス

戻り値: GetDomainConfigs200Response

パラメータ

レスポンス

戻り値: GetDomainConfig200Response

パラメータ

レスポンス

戻り値: GetDomainConfig200Response

パラメータ

レスポンス

返却: CreateEmailTemplate200Response

例

createEmailTemplate の例

Copy

1

2const tenantId: string = "tenant_4f2b1c9e";

3const createEmailTemplateBody: CreateEmailTemplateBody = {

4 name: "New Comment Notification",

5 subject: "Someone replied to your discussion",

6 fromName: "Community Team",

7 fromAddress: "no-reply@community.example.com",

8 htmlBody: "<p>\{{comment.author}} replied: \{{comment.text}}</p>",

9 plaintextBody: "\{{comment.author}} replied: \{{comment.text}}",

10 previewText: "A new reply on a discussion you follow",

11 isDefault: false // 任意パラメータの使用例を示すオプションのフラグ

12};

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

14

パラメータ

レスポンス

戻り値: FlagCommentPublic200Response

例

deleteEmailTemplate の例

Copy

1

2const tenantId: string = "tenant_9c4f1b2a";

3const id: string = "emailtmpl_4d2b9a5e";

4const requestorNote: string | undefined = undefined; // オプションのメタデータ（関数で必須ではありません）

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

6

パラメータ

レスポンス

戻り値: FlagCommentPublic200Response

例

deleteEmailTemplateRenderError の例

Copy

1

2const tenantId: string = 'tenant-72f3b4';

3const templateId: string = 'email_template-9c3a1';

4let providedErrorId: string | undefined = undefined; // オプションの値で、別の場所で設定される可能性があります

5const errorId: string = providedErrorId ?? 'render_err-5d2f7';

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

7

パラメータ

レスポンス

戻り値: GetEmailTemplate200Response

例

getEmailTemplate の例

Copy

1

2const tenantId: string = 'tenant_7f3b2c';

3const templateId: string = 'welcome-email-2024';

4const includeDrafts: boolean | undefined = undefined;

5const emailTemplate: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

6

パラメータ

レスポンス

戻り値: GetEmailTemplateDefinitions200Response

例

getEmailTemplateDefinitions の例

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_acme_001';

4 const options: { includeDrafts?: boolean } = { includeDrafts: true }; // オプションパラメータの例

5 const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId, options);

6 console.log(templates);

7})();

8

パラメータ

レスポンス

戻り値: GetEmailTemplateRenderErrors200Response

例

getEmailTemplateRenderErrors の例

Copy

1

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

3const id: string = 'tmpl_7f9a2b4c';

4const skip: number = 20;

5

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

7const errorsFirstPage: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id);

8

パラメータ

レスポンス

返却値: GetEmailTemplates200Response

例

getEmailTemplates の例

Copy

1

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

3 const tenantId: string = "acme-marketing-tenant-001";

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

5 const templatesPaged: GetEmailTemplates200Response = await getEmailTemplates(tenantId, 25);

6 console.log(templatesDefault, templatesPaged);

7}

8run();

9

パラメータ

レスポンス

戻り値: RenderEmailTemplate200Response

例

renderEmailTemplate の例

Copy

1

2const tenantId: string = '7f7e2b90-3a2b-4d9b-9df1-5f0b6b2e8a1c';

3const renderEmailTemplateBody: RenderEmailTemplateBody = {

4 templateId: 'welcome_email',

5 recipient: { email: 'jordan.smith@acme.co', name: 'Jordan Smith' },

6 variables: { siteName: 'Acme Forum', verificationUrl: 'https://acme.forum/verify?code=abc123' }

7};

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

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

10

パラメータ

レスポンス

戻り値: FlagCommentPublic200Response

例

updateEmailTemplate の例

Copy

1

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

3const id: string = 'template-789';

4const locale: string | undefined = 'en-US';

5const updateEmailTemplateBody: UpdateEmailTemplateBody = {

6 subject: 'Welcome to Acme — Get started',

7 bodyHtml: '<p>Hi \{{firstName}}, welcome to Acme. Start by visiting your dashboard.</p>',

8 fromName: 'Acme Support',

9 fromEmail: 'support@acme.com',

10 enabled: true,

11 ...(locale ? { locale } : {})

12};

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

14

req tenantId urlId userIdWS

パラメーター

レスポンス

返却: GetEventLog200Response

例

getEventLog の例

Copy

1

2const tenantId: string = 'tenant_9f3a2b';

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

4const userIdWS: string = 'ws_user_48291';

5const startTime: number = Date.now() - 86_400_000;

6const endTime: number = Date.now();

7const result: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

8

req tenantId urlId userIdWS

パラメータ

レスポンス

戻り値: GetEventLog200Response

例

getGlobalEventLog の例

Copy

1

2const tenantId: string = "tenant_639b7f12";

3const urlId: string = "https://www.news-site.com/articles/2026/06/15/important-update-987";

4const userIdWS: string = "user_ws_42b7";

5const startTime: number = new Date("2026-06-14T00:00:00Z").getTime();

6const endTime: number = Date.now();

7

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

9

パラメータ

レスポンス

戻り値: CreateFeedPost200Response

例

createFeedPost の例

Copy

1

2const tenantId: string = 'tenant_4f2b1c';

3const createFeedPostParams: CreateFeedPostParams = {

4 content: 'Launching our summer collection today — check it out!',

5 authorId: 'user_879',

6 media: [

7 {

8 type: 'image',

9 assets: [

10 { url: 'https://cdn.myshop.com/uploads/summer-look.jpg', width: 1200, height: 800 } as FeedPostMediaItemAsset

11 ]

12 } as FeedPostMediaItem

13 ],

14 links: [

15 { url: 'https://myshop.com/new-arrival', title: 'Summer Collection' } as FeedPostLink

16 ],

17 allowComments: true

18};

19const broadcastId: string = 'broadcast-2026-06-15-001';

20const isLive: boolean = false;

21const doSpamCheck: boolean = true;

22const skipDupCheck: boolean = false;

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

24

パラメーター

レスポンス

戻り値: CreateFeedPostPublic200Response

使用例

createFeedPostPublic の例

Copy

1

2(async () => {

3 const tenantId: string = "tenant_9f8b7c";

4 const media: FeedPostMediaItem[] = [{ type: "image", assets: [{ url: "https://cdn.example.com/roadmap.jpg", mimeType: "image/jpeg" }] }];

5 const links: FeedPostLink[] = [{ url: "https://company.example.com/roadmap", title: "Full roadmap" }];

6 const createFeedPostParams: CreateFeedPostParams = {

7 title: "Weekly Product Roadmap Update",

8 body: "This week we shipped enhancements to search relevance and fixed top customer bugs.",

9 authorId: "user_8321",

10 media,

11 links,

12 visibility: "public"

13 };

14 const broadcastId: string = "broadcast_2026_06_15";

15 const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload";

16 const response: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

17 console.log(response);

18})();

19

パラメータ

レスポンス

戻り値: DeleteFeedPostPublic200Response

例

deleteFeedPostPublic の例

Copy

1

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

3const postId: string = 'post_8f3d2a7c';

4const broadcastId: string = 'broadcast_2026-06-15_01';

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

6const response: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

7

req tenantId afterId

パラメータ

レスポンス

返却: GetFeedPosts200Response

例

getFeedPosts の例

Copy

1

2const tenantId: string = "tenant_74321";

3const afterId: string = "post_20250610_9b2f3";

4const limit: number = 25;

5const tags: Array<string> = ["product-updates", "announcements"];

6

7const response: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);

8

req tenantId afterId

パラメータ

レスポンス

戻り値: GetFeedPostsPublic200Response

例

getFeedPostsPublic の例

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_acme_01';

4 const afterId: string = 'post_20250610_842';

5 const limit: number = 25;

6 const tags: string[] = ['news', 'technology'];

7 const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1Ni';

8 const isCrawler: boolean = false;

9 const includeUserInfo: boolean = true;

10

11 const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(

12 tenantId,

13 afterId,

14 limit,

15 tags,

16 sso,

17 isCrawler,

18 includeUserInfo

19 );

20

21 console.log(response);

22})();

23

パラメータ

レスポンス

戻り値: GetFeedPostsStats200Response

例

getFeedPostsStats の例

Copy

1

2const tenantId: string = "tenant_98765";

3const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];

4const ssoToken: string = "sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";

5

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

7const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, ssoToken);

8

パラメータ

レスポンス

返却値: GetUserReactsPublic200Response

例

getUserReactsPublic の例

Copy

1

2const tenantId: string = 'fastcomments-tenant-4f2b9c';

3const postIds: Array<string> = ['post_7a1f9e', 'post_2b3c88'];

4const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTYwOTQ0MDAwMH0.signature';

5

6const response: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

7

パラメータ

レスポンス

戻り値: ReactFeedPostPublic200Response

例

reactFeedPostPublic の例

Copy

1

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

3const postId: string = 'feedpost_78901';

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

5const isUndo: boolean = false;

6const broadcastId: string = 'broadcast_2026_06_15_01';

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

8

9const response: ReactFeedPostPublic200Response = await reactFeedPostPublic(

10 tenantId,

11 postId,

12 reactBodyParams,

13 isUndo,

14 broadcastId,

15 sso

16);

17

パラメータ

レスポンス

戻り値: FlagCommentPublic200Response

例

updateFeedPost の例

Copy

1

2const tenantId: string = "tenant_72f3b4c9";

3const id: string = "post_ba4f6e18-2d3c-4b7a-91f2-8c0e3a6b5d4f";

4

5const feedPost: FeedPost = {

6 title: "June feature rollout",

7 body: "Announcing performance improvements and moderation updates available to all sites.",

8 authorName: "Platform Team",

9 mediaItems: [

10 {

11 type: "image",

12 caption: "Release banner",

13 asset: { url: "https://cdn.fastcomments.com/assets/june-banner.jpg", mimeType: "image/jpeg", width: 1200, height: 600 }

14 }

15 ],

16 links: [{ title: "Release notes", url: "https://docs.fastcomments.com/releases/june-2026" }]

17} as FeedPost;

18

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

20

パラメータ

レスポンス

戻り値: CreateFeedPostPublic200Response

例

updateFeedPostPublic の例

Copy

1

2const tenantId: string = 'tenant_acme_01';

3const postId: string = 'post_20260615_001';

4const updateFeedPostParams: UpdateFeedPostParams = {

5 title: 'Weekly Update: Product Launch',

6 content: 'We shipped the 2.0 release today — highlights and links below.',

7 media: [{ url: 'https://cdn.acme.com/releases/launch.jpg', type: 'image' }],

8 tags: ['release', 'product'],

9 isPublic: true

10};

11const broadcastId: string = 'broadcast_live_42';

12const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';

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

14

パラメータ

レスポンス

返却値: FlagCommentPublic200Response

例

flagCommentPublic の例

Copy

1

2const tenantId: string = "tenant_4f1b2a9c";

3const commentId: string = "comment_8d3e6f12";

4const isFlagged: boolean = true;

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

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

7

パラメータ

レスポンス

戻り値: GetGifLarge200Response

例

getGifLarge の例

Copy

1

2const tenantId: string = "tenant_9f8b7c";

3const largeInternalURLSanitized: string = "https://cdn.fastcomments.com/gifs/07d3f6_large.gif";

4const preferWebP: boolean | undefined = true; // 任意の優先設定

5const urlToUse: string = preferWebP ? largeInternalURLSanitized.replace(".gif", ".webp") : largeInternalURLSanitized;

6const response: GetGifLarge200Response = await getGifLarge(tenantId, urlToUse);

7

パラメータ

レスポンス

戻り値: GetGifsSearch200Response

例

getGifsSearch の例

Copy

1

2const tenantId: string = "tenant_acme_9876";

3const search: string = "cat playing piano";

4const locale: string = "en-US";

5const rating: string = "pg";

6const page: number = 1;

7const result: GetGifsSearch200Response = await getGifsSearch(tenantId, search, locale, rating, page);

8

パラメータ

レスポンス

戻り値: GetGifsTrending200Response

例

getGifsTrending の例

Copy

1

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

3 const tenantId: string = 'tenant_8b3f2c';

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

5 const rating: string = 'pg';

6 const page: number = 1;

7 const result: GetGifsTrending200Response = await getGifsTrending(tenantId, locale, rating, page);

8 console.log(result);

9}

10main();

11

パラメータ

レスポンス

戻り値: AddHashTag200Response

例

addHashTag の例

Copy

1

2const tenantId: string | undefined = "tenant_3c9f7b";

3const createHashTagBody: CreateHashTagBody = {

4 name: "support",

5 title: "Support",

6 description: "Questions about product usage, bugs, and account issues",

7 color: "#0066CC",

8 isActive: true,

9 aliases: ["help", "customer-service"]

10};

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

12

パラメータ

レスポンス

返却値: AddHashTagsBulk200Response

例

addHashTagsBulk の例

Copy

1

2const tenantId: string = "tenant_acme_corp_987";

3const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {

4 tags: [

5 { name: "product-update", description: "Announcements about new product releases", visible: true },

6 { name: "customer-support", description: "Customer support related discussions", visible: false }

7 ],

8 createdBy: "moderator_jane"

9};

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

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

12

パラメータ

レスポンス

返却値: FlagCommentPublic200Response

例

deleteHashTag の例

Copy

1

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

3const tenantId: string = "tenant_72a1";

4const deleteHashTagRequest: DeleteHashTagRequest = {

5 reason: "consolidate-duplicates",

6 requestedBy: "moderator@dailypress.com",

7 forceDelete: true

8};

9const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

10

パラメータ

レスポンス

戻り値: GetHashTags200Response

例

getHashTags の例

Copy

1

2const tenantId: string = 'tenant_7f4b2c3a';

3const tagsFirstPage: GetHashTags200Response = await getHashTags(tenantId);

4const tagsSecondPage: GetHashTags200Response = await getHashTags(tenantId, 2);

5console.log(tagsFirstPage, tagsSecondPage);

6

パラメータ

レスポンス

返却: PatchHashTag200Response

例

patchHashTag の例

Copy

1

2const tag: string = "feature-request";

3const tenantId: string = "tenant_8f7a3b2c";

4const updateHashTagBody: UpdateHashTagBody = {

5 displayName: "Feature Request",

6 description: "Use this tag for requests to add new features to the product",

7 enabled: true

8};

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

10

パラメータ

レスポンス

戻り値: CreateModerator200Response

例

createModerator の例

Copy

1

2const tenantId: string = 'tenant_9f3b21';

3const createModeratorBody: CreateModeratorBody = {

4 moderator: {

5 name: 'Alex Rivera',

6 email: 'alex.rivera@fastcomments.io',

7 role: 'global_moderator',

8 enabled: true,

9 },

10 // オプションのパラメータの例:

11 notifyUser: true,

12 permissions: ['delete_comment', 'edit_comment', 'ban_user'],

13 customConfig: { dashboardTheme: 'dark' } as unknown as CustomConfigParameters

14};

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

16