FastComments の JavaScript/TypeScript 用 SDK

これは FastComments の公式 JavaScript/TypeScript SDK です。

Node.js またはブラウザからコメント、ユーザー、SSO、およびモデレーションを管理できます。

リポジトリ

インストール

npm install fastcomments-sdk

API ドキュメント

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

ブラウザとサーバーの互換性

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

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

使い方

この SDK は、最適な互換性とセキュリティを確保するために、ブラウザとサーバー環境それぞれに対して別々のエントリーポイントを提供します:

ブラウザでの使用（クライアント側）

ブラウザ／フロントエンドのアプリケーションでは、Node.js の依存関係を含まないブラウザ用の安全なエクスポートを使用してください:

// ブラウザ安全なインポート（Node.js の依存関係なし）
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// ブラウザ用 SDK インスタンスを作成
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // オプション、デフォルトは https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

公開 API を使用します（API キーは不要 - ブラウザで安全です）

サーバーでの使用（Node.js）

サーバー／バックエンドのアプリケーションでは、SSO や認証機能を含むフル SDK を使用してください:

// サーバー側インポート（SSO を含み、NodeJS で動作するよう設計されています）
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// サーバー用 SDK インスタンスを作成
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // これはサーバー側で秘密にしてください！
  basePath: 'https://fastcomments.com' // オプション、デフォルトは https://fastcomments.com
});

// API キーを使って保護された API を使用します
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

型のみのインポート

TypeScript の型のみが必要で（ランタイムコードは不要な場合）は、デフォルトのインポートを使用してください:

// 型のみ（ランタイム依存なし - どこでも安全）
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と保護されたAPI

SDK は次の API クラスを提供します:

DefaultApi - 認証に API キーを必要とする保護されたエンドポイント。サーバー側の操作に使用してください。
PublicApi - API キーなしでアクセスできる公開エンドポイント。ブラウザやモバイル端末などから直接呼び出せます。
ModerationApi - モデレーターダッシュボードのエンドポイント（コメントモデレーション、バン、バッジ、トラストファクター、検索）。モデレーターのセッションで認証されます。SSO 認証されたモデレーターの場合は sso クエリパラメータを渡してください。
HiddenApi - 高度なユースケース向けの内部／管理者用エンドポイント。

Example: Using Public API (browser-safe)

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

const publicApi = new PublicApi();

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

Example: Using Default API (server-side only)

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

Example: Using 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 機能は 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);
}

ブロードキャストID

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

aggregate

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

Parameters

名前	型	必須
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

Response

Returns: AggregateResponse

Example

集計例

Copy

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

getAuditLogs

パラメータ

名前	型	必須
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

レスポンス

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

blockFromCommentPublic

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
publicBlockFromCommentParams	PublicBlockFromCommentParams	はい
sso	string	いいえ

レスポンス

返却値: 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();

unBlockCommentPublic

パラメータ

Name	Type	Required
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
);

checkedCommentsForBlocked

パラメータ

名前	型	必須
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);
})();

blockUserFromComment

パラメータ

名前	タイプ	必須
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'; // optional parameter
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

createCommentPublic

パラメータ

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

deleteComment

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
contextUserId	string	いいえ
isLive	boolean	いいえ

レスポンス

戻り値: DeleteCommentResponse

例

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

deleteCommentPublic

パラメータ

名前	タイプ	必須
tenantId	string	はい
commentId	string	はい
broadcastId	string	はい
editKey	string	いいえ
sso	string	いいえ

レスポンス

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

deleteCommentVote

パラメータ

名前	タイプ	必須
tenantId	string	はい
commentId	string	はい
voteId	string	はい
urlId	string	はい
broadcastId	string	はい
editKey	string	いいえ
sso	string	いいえ

レスポンス

返却: 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();

flagComment

パラメータ

名前	タイプ	必須
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

レスポンス

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

getComment

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	はい

レスポンス

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

getComments

パラメータ

名前	型	必須
tenantId	string	Yes
page	number	No
limit	number	No
skip	number	No
asTree	boolean	No
skipChildren	number	No
limitChildren	number	No
maxTreeDepth	number	No
urlId	string	No
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No
fromDate	number	No
toDate	number	No

返却

Returns: 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; // 1 週間前
const toDate: number = Date.now();
const commentsResponse: GetCommentsResponse = await getComments({
  tenantId,
  page,
  limit,
  asTree,
  urlId,
  direction,
  fromDate,
  toDate,
});

getCommentsPublic

リクエスト
tenantId
urlId

パラメータ

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

応答

戻り値: 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
  );
}

getCommentText

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
editKey	string	いいえ
sso	string	いいえ

レスポンス

戻り値: 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();

getCommentVoteUserNames

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
dir	number	はい
sso	string	いいえ

レスポンス

戻り値: 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);
}

lockComment

Parameters

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

Response

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

pinComment

パラメータ

名前	タイプ	必須
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

レスポンス

戻り値: 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);
})();

saveComment

パラメータ

名前	型	必須
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,   // isLive
    false   // doSpamCheck
  );
  console.log(response);
}
submitComment();

saveCommentsBulk

パラメータ

名前	型	必須
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

レスポンス

返り値: 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,      // ライブ
  false,     // スパムチェック
  true,      // メール送信
  undefined  // populateNotifications (デフォルトを使用)
);

setCommentText

パラメータ

名前	型	必須
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);
})();

unBlockUserFromComment

パラメータ

名前	型	必須
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 は省略
  );
  console.log(result);
}
demoUnblock();

unFlagComment

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
userId	string	いいえ
anonUserId	string	いいえ

レスポンス

返り値: 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);

unLockComment

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
broadcastId	string	はい
sso	string	いいえ

レスポンス

返却: 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();

unPinComment

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
broadcastId	string	はい
sso	string	いいえ

レスポンス

返り値: 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)
})()

updateComment

パラメータ

名前	型	必須
tenantId	string	Yes
id	string	Yes
updatableCommentParams	UpdatableCommentParams	Yes
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

返り値

返り値: 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
);

voteComment

パラメータ

名前	型	必須
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
);

getCommentsForUser

パラメータ

名前	タイプ	必須
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);
}

addDomainConfig

パラメータ

名前	タイプ	必須	説明
tenantId	string	はい
addDomainConfigParams	AddDomainConfigParams	はい

レスポンス

戻り値: AddDomainConfigResponse

例

addDomainConfig の例

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // description はオプションで、ここでは省略されています
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

deleteDomainConfig

パラメータ

名前	型	必須	説明
tenantId	string	はい
domain	string	はい

レスポンス

戻り値: 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();

getDomainConfig

パラメータ

名前	型	必須	説明
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();

getDomainConfigs

パラメータ

名前	型	必須	説明
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);
}

patchDomainConfig

パラメータ

名前	型	必須
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();

putDomainConfig

パラメータ

名前	型	必須
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();

createEmailTemplate

パラメータ

名前	型	必須	説明
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	Yes

レスポンス

返却: CreateEmailTemplateResponse1

例

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

deleteEmailTemplate

パラメータ

Name	Type	Required	Description
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;
}();

deleteEmailTemplateRenderError

パラメータ

名前	タイプ	必須
tenantId	string	はい
id	string	はい
errorId	string	はい

レスポンス

返却: DeleteEmailTemplateRenderErrorResponse

例

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

getEmailTemplate

パラメータ

名前	型	必須	説明
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;
}

getEmailTemplateDefinitions

パラメータ

名前	型	必須	説明
tenantId	string	Yes

レスポンス

戻り値: GetEmailTemplateDefinitionsResponse1

例

getEmailTemplateDefinitions の例

Copy

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

getEmailTemplateRenderErrors

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
skip	number	いいえ

レスポンス

返却: 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
);

getEmailTemplates

パラメータ

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

レスポンス

返り値: GetEmailTemplatesResponse1

例

getEmailTemplates の例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // オプションの 'skip' を省いて呼び出す
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // オプションの 'skip' パラメータを指定して呼び出す
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

renderEmailTemplate

パラメータ

名前	型	必須
tenantId	string	はい
renderEmailTemplateBody	RenderEmailTemplateBody	はい
locale	string	いいえ

レスポンス

返り値: RenderEmailTemplateResponse1

例

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

updateEmailTemplate

パラメータ

名前	型	必須
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);
})();

getEventLog

req tenantId urlId userIdWS

パラメータ

名前	型	必須
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	Yes
startTime	number	Yes
endTime	number	No

応答

返却: 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; // 1 週間前
    const endTime: number = Date.now();
    const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);
})();

getGlobalEventLog

req tenantId urlId userIdWS

パラメータ

名前	タイプ	必須
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	Yes
startTime	number	Yes
endTime	number	No

レスポンス

戻り値: 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);
})();

createFeedPost

パラメータ

名前	型	必須
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

応答

戻り値: 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();

createFeedPostPublic

パラメータ

名前	タイプ	必須
tenantId	string	はい
createFeedPostParams	CreateFeedPostParams	はい
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

返却: 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
  );
}

deleteFeedPostPublic

パラメータ

名前	型	必須
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);
})();

getFeedPosts

req tenantId afterId

パラメータ

Name	Type	Required
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No

レスポンス

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

getFeedPostsPublic

req tenantId afterId

パラメータ

名前	型	必須
tenantId	string	はい
afterId	string	いいえ
limit	number	いいえ
tags	Array	いいえ
sso	string	いいえ
isCrawler	boolean	いいえ
includeUserInfo	boolean	いいえ

レスポンス

返却: 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();

getFeedPostsStats

パラメータ

名前	型	必須
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();

getUserReactsPublic

パラメータ

名前	型	必須
tenantId	string	はい
postIds	Array	いいえ
sso	string	いいえ

応答

返却: 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();

reactFeedPostPublic

パラメーター

名前	型	必須
tenantId	string	Yes
postId	string	Yes
reactBodyParams	ReactBodyParams	Yes
isUndo	boolean	No
broadcastId	string	No
sso	string	No

応答

返却: ReactFeedPostPublicResponse

例

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

updateFeedPost

パラメータ

名前	タイプ	必須
tenantId	string	Yes
id	string	Yes
feedPost	FeedPost	Yes

レスポンス

返却: UpdateFeedPostResponse

例

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

updateFeedPostPublic

パラメータ

名前	型	必須
tenantId	string	はい
postId	string	はい
updateFeedPostParams	UpdateFeedPostParams	はい
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

返り値: 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
  );
}

flagCommentPublic

パラメータ

名前	型	必須
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();

getGifLarge

パラメータ

Name	Type	Required	Description
tenantId	string	Yes
largeInternalURLSanitized	string	Yes

レスポンス

返り値: 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);
})();

getGifsSearch

パラメータ

名前	型	必須
tenantId	string	Yes
search	string	Yes
locale	string	No
rating	string	No
page	number	No

レスポンス

戻り値: 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();

getGifsTrending

パラメータ

Name	Type	Required
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();

addHashTag

パラメータ

名前	タイプ	必須	説明
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

レスポンス

返却: AddHashTagResponse

例

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

addHashTagsBulk

パラメータ

名前	型	必須	説明
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

応答

戻り値: 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);
}();

deleteHashTag

パラメータ

名前	型	必須
tag	string	Yes
tenantId	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

レスポンス

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

getHashTags

パラメータ

名前	型	必須	説明
tenantId	string	Yes
page	number	No

応答

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

patchHashTag

パラメータ

名前	型	必須
tag	string	はい
tenantId	string	いいえ
updateHashTagBody	UpdateHashTagBody	いいえ

レスポンス

戻り値: 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
);

deleteModerationVote

パラメータ

名前	型	必須
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
);

getApiComments

パラメータ

名前	型	必須
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

応答

返り値: GetApiCommentsResponse

例

getApiComments の例

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // page
    25,                    // count
    "feedback",           // textSearch
    "192.168.1.100",      // byIPFromComment
    "approved",           // filters
    "hasReplies",         // searchFilters
    "dateDesc",           // sorts
    false,                // demo
    "tenant-abc123",      // tenantId
    "sso-token-xyz"       // sso
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

getApiExportStatus

パラメータ

名前	型	必須
batchJobId	string	No
tenantId	string	No
sso	string	No

レスポンス

戻り値: 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);
}

getApiIds

パラメータ

名前	型	必須
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

応答

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

getBanUsersFromComment

パラメータ

名前	型	必須
commentId	string	はい
tenantId	string	いいえ
sso	string	いいえ

レスポンス

返却: 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();

getCommentBanStatus

パラメータ

名前	型	必須
commentId	string	Yes
tenantId	string	No
sso	string	No

レスポンス

戻り値: 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');
}

getCommentChildren

パラメータ

名前	型	必須
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);

getCount

パラメータ

名前	型	必須
textSearch	string	いいえ
byIPFromComment	string	いいえ
filter	string	いいえ
searchFilters	string	いいえ
demo	boolean	いいえ
tenantId	string	いいえ
sso	string	いいえ

レスポンス

返却: 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();

getCounts

パラメータ

名前	型	必須	説明
tenantId	string	No
sso	string	No

レスポンス

返り値: 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();

getLogs

パラメータ

名前	型	必須
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);
}

getManualBadges

パラメータ

名前	型	必須	説明
tenantId	string	いいえ
sso	string	いいえ

レスポンス

返却: 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();

getManualBadgesForUser

パラメータ

Name	Type	Required
badgesUserId	string	いいえ
commentId	string	いいえ
tenantId	string	いいえ
sso	string	いいえ

応答

戻り値: 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);
})();

getModerationComment

パラメータ

名前	型	必須
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");
  // 必要に応じて結果を使用してください...
}

getModerationCommentText

パラメータ

名前	型	必須
commentId	string	はい
tenantId	string	いいえ
sso	string	いいえ

応答

返却: GetModerationCommentTextResponse

例

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

getPreBanSummary

パラメータ

名前	タイプ	必須
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
);

getSearchCommentsSummary

パラメータ

名前	型	必須
value	string	No
filters	string	No
searchFilters	string	No
tenantId	string	No
sso	string	No

レスポンス

返却: 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();

getSearchPages

パラメータ

名前	型	必須
value	string	No
tenantId	string	No
sso	string	No

レスポンス

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

getSearchSites

Parameters

Name	Type	Required
value	string	いいえ
tenantId	string	いいえ
sso	string	いいえ

Response

返り値: GetSearchSitesResponse

Example

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

getSearchSuggest

パラメータ

名前	型	必須
textSearch	string	No
tenantId	string	No
sso	string	No

レスポンス

戻り値: 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();

getSearchUsers

パラメータ

名前	型	必須
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);
}

getTrustFactor

パラメータ

名前	型	必須
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();

getUserBanPreference

パラメータ

名前	型	必須	説明
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();

getUserInternalProfile

パラメータ

名前	タイプ	必須
commentId	string	いいえ
tenantId	string	いいえ
sso	string	いいえ

応答

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

postAdjustCommentVotes

パラメータ

名前	タイプ	必須
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

レスポンス

戻り値: 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
);

postApiExport

Parameters

名前	型	必須
textSearch	string	いいえ
byIPFromComment	string	いいえ
filters	string	いいえ
searchFilters	string	いいえ
sorts	string	いいえ
tenantId	string	いいえ
sso	string	いいえ

Response

返却: 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)
})()

postBanUserFromComment

パラメータ

名前	タイプ	必須
commentId	string	はい
banEmail	boolean	いいえ
banEmailDomain	boolean	いいえ
banIP	boolean	いいえ
deleteAllUsersComments	boolean	いいえ
bannedUntil	string	いいえ
isShadowBan	boolean	いいえ
updateId	string	いいえ
banReason	string	いいえ
tenantId	string	いいえ
sso	string	いいえ

レスポンス

返却: PostBanUserFromCommentResponse

例

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

postBanUserUndo

パラメータ

名前	型	必須
banUserUndoParams	BanUserUndoParams	はい
tenantId	string	いいえ
sso	string	いいえ

応答

戻り値: 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();

postBulkPreBanSummary

パラメータ

名前	型	必須
bulkPreBanParams	BulkPreBanParams	はい
includeByUserIdAndEmail	boolean	いいえ
includeByIP	boolean	いいえ
includeByEmailDomain	boolean	いいえ
tenantId	string	いいえ
sso	string	いいえ

レスポンス

返却: 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();

postCommentsByIds

パラメータ

名前	型	必須
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
);

postFlagComment

パラメータ

名前	型	必須
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
);

postRemoveComment

パラメータ

Name	Type	Required
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);
}

postRestoreDeletedComment

パラメータ

名前	型	必須
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();

postSetCommentApprovalStatus

パラメータ

名前	タイプ	必須
commentId	string	Yes
approved	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

レスポンス

返り値: 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();

postSetCommentReviewStatus

パラメータ

名前	型	必須
commentId	string	Yes
reviewed	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

応答

返り値: 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);
}

postSetCommentSpamStatus

パラメータ

名前	型	必須
commentId	string	Yes
spam	boolean	No
permNotSpam	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

レスポンス

返却: PostSetCommentSpamStatusResponse

例

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

postSetCommentText

パラメータ

名前	型	必須
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);
})();

postUnFlagComment

パラメータ

名前	型	必須
commentId	string	はい
broadcastId	string	いいえ
tenantId	string	いいえ
sso	string	いいえ

レスポンス

返却: PostUnFlagCommentResponse

例

postUnFlagComment の例

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // commentId
    "brd_67890",          // broadcastId（オプション）
    "tenant_abc",         // tenantId（オプション）
    "sso_user_token_789"  // sso（オプション）
  );
};

postVote

パラメータ

名前	型	必須
commentId	string	はい
direction	string	いいえ
broadcastId	string	いいえ
tenantId	string	いいえ
sso	string	いいえ

レスポンス

返却: 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');

putAwardBadge

パラメータ

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

レスポンス

返り値: 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)
})()

putCloseThread

パラメータ

名前	型	必須
urlId	string	Yes
tenantId	string	No
sso	string	No

レスポンス

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

putRemoveBadge

パラメータ

Name	Type	Required
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
);

putReopenThread

パラメータ

名前	型	必須
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);
}

setTrustFactor

パラメータ

名前	タイプ	必須
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);
})();

createModerator

パラメータ

名前	型	必須	説明
tenantId	string	はい
createModeratorBody	CreateModeratorBody	はい

レスポンス

返却: 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();

deleteModerator

パラメータ

名前	型	必須
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);
}

getModerator

パラメータ

名前	型	必須	説明
tenantId	string	Yes
id	string	Yes

レスポンス

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

getModerators

パラメータ

名前	タイプ	必須	説明
tenantId	string	はい
skip	number	いいえ

レスポンス

戻り値: 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);
}

sendInvite

パラメータ

名前	型	必須
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);

updateModerator

パラメータ

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateModeratorBody	UpdateModeratorBody	Yes

応答

返り値: 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();

deleteNotificationCount

パラメータ

名前	型	必須	説明
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();

getCachedNotificationCount

パラメータ

名前	型	必須	説明
tenantId	string	Yes
id	string	Yes

応答

戻り値: 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);

getNotificationCount

パラメータ

名前	型	必須
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

レスポンス

返却: 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();

getNotifications

パラメータ

名前	型	必須
tenantId	string	はい
userId	string	いいえ
urlId	string	いいえ
fromCommentId	string	いいえ
viewed	boolean	いいえ
type	string	いいえ
skip	number	いいえ

レスポンス

返却: 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();

updateNotification

パラメータ

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateNotificationBody	UpdateNotificationBody	Yes
userId	string	No

応答

返り値: 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
);

createV1PageReact

パラメータ

名前	型	必須
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);

createV2PageReact

パラメータ

名前	型	必須
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);
})();

deleteV1PageReact

パラメータ

名前	型	必須	説明
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);

deleteV2PageReact

パラメータ

名前	型	必須
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

レスポンス

戻り値: 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);

getV1PageLikes

パラメータ

名前	型	必須	説明
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);
}

getV2PageReacts

パラメータ

名前	型	必須	説明
tenantId	string	Yes
urlId	string	Yes

レスポンス

返却: 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();

getV2PageReactUsers

パラメータ

名前	タイプ	必須
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();

addPage

パラメータ

名前	種類	必須	説明
tenantId	string	はい
createAPIPageData	CreateAPIPageData	はい

応答

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

deletePage

パラメータ

Name	Type	Required	Description
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();

getOfflineUsers

過去にページ上でコメントしたが、現在オンラインではないユーザー。displayName でソートされます。
/users/online をすべて使用し終えた後、"Members" セクションを表示するために使用します。
commenterName に対するカーソルページネーション: サーバーは部分的な {tenantId, urlId, commenterName} インデックスを afterName から $gt で前方向に走査し、$skip コストはかかりません。

Parameters

名前	型	必須
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Response

返却: GetOfflineUsersResponse

Example

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

getOnlineUsers

現在オンラインのページ閲覧者: 現在ページにサブスクライブされている WebSocket セッションを持つユーザーです。
anonCount と totalCount（部屋全体の購読者数、匿名閲覧者は列挙しません）を合計して返します。

Parameters

名前	型	必須
tenantId	string	はい
urlId	string	はい
afterName	string	いいえ
afterUserId	string	いいえ

Response

返却: 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);
}

getPageByURLId

パラメータ

名前	型	必須	説明
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;
})();

getPages

パラメータ

名前	型	必須	説明
tenantId	string	はい

応答

戻り値: 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);
})();

getPagesPublic

List pages for a tenant. Used by the FChat desktop client to populate its room list.
テナントのページを一覧取得します。FChat デスクトップクライアントが部屋リストを表示するために使用します。

Requires enableFChat to be true on the resolved custom config for each page.
各ページの解決されたカスタム設定で enableFChat が true である必要があります。

Pages that require SSO are filtered against the requesting user's group access.
SSO が必要なページは、リクエストするユーザーのグループアクセスに基づいてフィルタリングされます。

Parameters

名前	型	必須
tenantId	string	はい
cursor	string	いいえ
limit	number	いいえ
q	string	いいえ
sortBy	PagesSortBy	いいえ
hasComments	boolean	いいえ

Response

返却: GetPagesPublicResponse

Example

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

getUsersInfo

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	Yes
ids	string	Yes

Response

Returns: GetUsersInfoResponse

Example

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

patchPage

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
updateAPIPageData	UpdateAPIPageData	はい

レスポンス

戻り値: 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);
})();

deletePendingWebhookEvent

パラメータ

名前	タイプ	必須	説明
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();

getPendingWebhookEventCount

パラメータ

名前	タイプ	必須
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);
})();

getPendingWebhookEvents

パラメータ

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

レスポンス

返り値: 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();

createQuestionConfig

パラメータ

名前	型	必須	説明
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

応答

返り値: CreateQuestionConfigResponse1

例

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

deleteQuestionConfig

パラメータ

名前	型	必須	説明
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();

getQuestionConfig

パラメータ

名前	型	必須	説明
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);

getQuestionConfigs

Parameters

名前	型	必須	説明
tenantId	string	はい
skip	number	いいえ

レスポンス

戻り値: 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);
}

updateQuestionConfig

パラメータ

名前	タイプ	必須
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
);

createQuestionResult

パラメータ

名前	型	必須	説明
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

レスポンス

返却: 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]
  // optional fields such as notes are omitted
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

deleteQuestionResult

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	はい

レスポンス

返却: DeleteQuestionResultResponse

例

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

getQuestionResult

パラメータ

名前	型	必須	説明
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);
}

getQuestionResults

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	いいえ
userId	string	いいえ
startDate	string	いいえ
questionId	string	いいえ
questionIds	string	いいえ
skip	number	いいえ

レスポンス

戻り値: 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);
})();

updateQuestionResult

パラメータ

名前	型	必須
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

レスポンス

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

aggregateQuestionResults

パラメータ

名前	型	必須
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);
})();

bulkAggregateQuestionResults

パラメータ

名前	型	必要
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Yes
forceRecalculate	boolean	No

レスポンス

返却: BulkAggregateQuestionResultsResponse1

例

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

combineCommentsWithQuestionResults

パラメータ

名前	型	必須
tenantId	string	はい
questionId	string	いいえ
questionIds	Array	いいえ
urlId	string	いいえ
startDate	Date	いいえ
forceRecalculate	boolean	いいえ
minValue	number	いいえ
maxValue	number	いいえ
limit	number	いいえ

レスポンス

返却: 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
);

addSSOUser

Parameters

名前	型	必須	説明
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	Yes

レスポンス

返り値: AddSSOUserAPIResponse

例

addSSOUser の例

Copy

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

deleteSSOUser

パラメータ

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

レスポンス

戻り値: DeleteSSOUserAPIResponse

例

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

getSSOUserByEmail

パラメータ

名前	型	必須	説明
tenantId	string	Yes
email	string	Yes

レスポンス

戻り値: 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;
}

getSSOUserById

パラメータ

名前	型	必須	説明
tenantId	string	Yes
id	string	Yes

レスポンス

返却: 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;
}

getSSOUsers

パラメータ

名前	タイプ	必須	説明
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();

patchSSOUser

パラメータ

名前	型	必須
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

レスポンス

返却: 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
);

putSSOUser

パラメータ

名前	タイプ	必須
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);
})();

createSubscription

パラメータ

名前	型	必須	説明
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

レスポンス

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

deleteSubscription

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
userId	string	いいえ

応答

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

getSubscriptions

パラメータ

名前	型	必須	説明
tenantId	string	Yes
userId	string	No

レスポンス

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

updateSubscription

パラメータ

名前	型	必須
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

レスポンス

返却値: 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
);

getTenantDailyUsages

パラメータ

名前	型	必須
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; // 5月
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // 必要なパラメータのみと1つのオプションパラメータを使用
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

createTenantPackage

パラメータ

名前	型	必須	説明
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);
})();

deleteTenantPackage

パラメータ

Name	Type	Required	Description
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();

getTenantPackage

パラメータ

名前	タイプ	必須	説明
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;
}

getTenantPackages

パラメータ

名前	型	必須	説明
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);
})();

replaceTenantPackage

パラメータ

名前	型	必須
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);
})();

updateTenantPackage

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
updateTenantPackageBody	UpdateTenantPackageBody	はい

レスポンス

返却: 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
);

createTenantUser

パラメータ

名前	型	必須	説明
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);

deleteTenantUser

パラメータ

Name	Type	Required
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);
}

getTenantUser

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	はい

レスポンス

返り値: 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);
}

getTenantUsers

パラメータ

名前	型	必須	説明
tenantId	string	Yes
skip	number	No

レスポンス

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

replaceTenantUser

パラメータ

名前	タイプ	必須
tenantId	string	Yes
id	string	Yes
replaceTenantUserBody	ReplaceTenantUserBody	Yes
updateComments	string	No

レスポンス

返り値: ReplaceTenantUserResponse

例

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

sendLoginLink

パラメータ

名前	種類	必須
tenantId	string	はい
id	string	はい
redirectURL	string	いいえ

レスポンス

返却: 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);
}

updateTenantUser

パラメータ

名前	型	必須
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);

createTenant

パラメータ

名前	型	必須	説明
tenantId	string	はい
createTenantBody	CreateTenantBody	はい

レスポンス

戻り値: 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);
}

deleteTenant

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
sure	string	いいえ

レスポンス

返却: 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();

getTenant

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	はい

レスポンス

返却: 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();

getTenants

パラメータ

名前	型	必須
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);
})();

updateTenant

パラメータ

名前	型	必須
tenantId	string	Yes
id	string	Yes
updateTenantBody	UpdateTenantBody	Yes

レスポンス

返却: 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);

changeTicketState

パラメータ

名前	型	必須
tenantId	string	Yes
userId	string	Yes
id	string	Yes
changeTicketStateBody	ChangeTicketStateBody	Yes

Response

返り値: 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
);

createTicket

パラメータ

名前	型	必須
tenantId	string	Yes
userId	string	Yes
createTicketBody	CreateTicketBody	Yes

レスポンス

戻り値: 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);

getTicket

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
userId	string	いいえ

レスポンス

返却: 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);

getTickets

パラメータ

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

応答

Returns: GetTicketsResponse1

例

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

getTranslations

パラメータ

名前	タイプ	必須
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);
})();

uploadImage

画像のアップロードとリサイズ

パラメータ

名前	型	必須
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);

getUserBadgeProgressById

パラメータ

名前	型	必須	説明
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();

getUserBadgeProgressByUserId

パラメータ

名前	型	必須	説明
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);
})();

getUserBadgeProgressList

パラメータ

名前	型	必須
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();

createUserBadge

パラメーター

名前	型	必須	説明
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

レスポンス

返却: 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);

deleteUserBadge

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	はい

レスポンス

返却: 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();

getUserBadge

パラメータ

名前	型	必須	説明
tenantId	string	Yes
id	string	Yes

応答

戻り値: 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();

getUserBadges

パラメータ

名前	型	必須
tenantId	string	Yes
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

レスポンス

戻り値: 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();

updateUserBadge

パラメータ

名前	タイプ	必須
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();

getUserNotificationCount

パラメータ

名前	型	必須	説明
tenantId	string	Yes
sso	string	No

レスポンス

戻り値: 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);
}

getUserNotifications

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	いいえ
pageSize	number	いいえ
afterId	string	いいえ
includeContext	boolean	いいえ
afterCreatedAt	number	いいえ
unreadOnly	boolean	いいえ
dmOnly	boolean	いいえ
noDm	boolean	いいえ
includeTranslations	boolean	いいえ
includeTenantNotifications	boolean	いいえ
sso	string	いいえ

レスポンス

返却: 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);
}

resetUserNotificationCount

Parameters

名前	型	必須	説明
tenantId	string	はい
sso	string	いいえ

Response

戻り値: ResetUserNotificationCountResponse

Example

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

resetUserNotifications

パラメータ

名前	型	必須
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);
})();

updateUserNotificationCommentSubscriptionStatus

特定のコメントの通知を有効化または無効化します。

パラメータ

名前	型	必須
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

レスポンス

返却: 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
  );

updateUserNotificationPageSubscriptionStatus

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

戻り値: 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
  );
})();

updateUserNotificationStatus

パラメータ

名前	型	必須
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
);

getUserPresenceStatuses

パラメータ

名前	型	必須
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);
}

searchUsers

パラメータ

Name	Type	Required
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();

getUser

パラメータ

名前	型	必須	説明
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);
})();

createVote

パラメータ

名前	型	必須
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
);

deleteVote

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
editKey	string	いいえ

応答

戻り値: 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);
})();

getVotes

パラメータ

名前	タイプ	必須	説明
tenantId	string	はい
urlId	string	はい

レスポンス

返却: 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;
}

getVotesForUser

パラメータ

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

レスポンス

返却: GetVotesForUserResponse1

例

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 リファレンス

ドキュメント

使い方

集計

監査ログ

コメントからブロック

ブロック済みコメントの確認

コメント

ユーザーのコメント

ドメイン設定

メールテンプレート

イベントログ

フィード投稿

コメントのフラグ

GIF

ハッシュタグ

モデレーション

モデレーター

通知数

通知

ページリアクション

ページ

保留中のWebhookイベント

質問設定

アンケート結果

アンケート結果の集計

SSOユーザー

サブスクリプション

テナント日次使用量

テナントパッケージ

テナントユーザー

テナント

チケット

翻訳

画像アップロード

バッジ進捗

ユーザーバッジ

ユーザー通知

ユーザーの在席状況

ユーザー検索

ユーザー

投票

FastComments の JavaScript/TypeScript 用 SDK

リポジトリ

インストール

API ドキュメント

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

ブラウザとサーバーの互換性

使い方

ブラウザでの使用（クライアント側）

サーバーでの使用（Node.js）

型のみのインポート

個別の API クラスの使用

ブラウザ環境

サーバー環境

公開APIと保護されたAPI

Example: Using Public API (browser-safe)

Example: Using Default API (server-side only)

Example: Using Moderation API

SSO（シングルサインオン）連携

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

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

ブラウザからの SSO の使用（サーバー生成トークンあり）

コメント作成時の SSO

一般的なユースケース

ページのコメントを取得する

コメントを作成する

コメントに投票する

ユーザー管理 (APIキーが必要)

ライブイベント（リアルタイム更新）

ページレベルのイベント

ユーザーイベントを購読

userIdWS の取得

ブロードキャストID

エラー処理

aggregate

Parameters

Response