FastComments PHP SDK

これは FastComments の公式 PHP SDK です。

FastComments API 用の公式 PHP SDK

リポジトリ

GitHubで表示

インストールと使用方法

要件

PHP 7.4 以降。 PHP 8.0 でも動作するはずです。

Composer

バインディングを Composer 経由でインストールするには、次を composer.json に追加してください:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/fastcomments/fastcomments-php.git"
    }
  ],
  "require": {
    "fastcomments/fastcomments-php": "*@dev"
  }
}

その後、composer install を実行してください

手動インストール

ファイルをダウンロードして autoload.php を読み込んでください:

<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');

はじめに

まずinstallation procedureに従ってください。その後、以下を実行してください:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: api_key
// APIキー認証を設定: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには下の行のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタムHTTPクライアントを使用する場合は、`GuzzleHttp\ClientInterface`を実装するクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これは任意です。デフォルトでは`GuzzleHttp\Client`が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams

try {
    $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}

API クライアント

The SDKは3つのAPIクライアントクラスを提供します:

DefaultApi - サーバー側で使用するためのAPIキー認証メソッドです。APIキーの設定方法はGetting Startedをご参照ください。
PublicApi - APIキーを必要としない公開メソッドで、ブラウザやモバイルアプリから安全に呼び出すことができます。
ModerationApi - ライブで高速なモデレーションAPIの包括的なスイートです。すべての ModerationApi メソッドは $sso パラメータを受け取り、SSOまたは FastComments.com のセッションクッキーで認証できます。

PublicApi の使用

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// 公開メソッドは API キーを必要としません。
$apiInstance = new FastComments\Client\Api\PublicApi(
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列

try {
    $result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}

ModerationApi の使用

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new FastComments\Client\Api\ModerationApi(
    new GuzzleHttp\Client()
);
$sso = 'sso_example'; // 文字列 - モデレーターを認証する SSO ペイロード

try {
    $result = $apiInstance->getCount([
        'sso' => $sso,
    ]);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}

API メソッド

すべてのURIは https://fastcomments.com に対する相対パスです

Class	Method	HTTP request
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}
PublicApi	getEventLog	GET /event-log/{tenantId}
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online
PublicApi	getPagesPublic	GET /pages/{tenantId}
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

モデル

認可

API に定義されている認証スキーム:

api_key

種類: APIキー
APIキーのパラメーター名: x-api-key
場所: HTTP ヘッダー

作成者

support@fastcomments.com

集計

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
異なる操作（例: sum、countDistinct、avg など）がサポートされています。

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
parentTenantId	string	query	いいえ
includeStats	boolean	query	いいえ

応答

戻り値: AggregateResponse

例

集計例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
$options = [
    'parent_tenant_id' => 'parent_tenant_id_example', // string
    'include_stats' => True, // bool
];
try {
    $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
}

監査ログを取得

パラメータ

名前	型	位置	必須
tenantId	string	query	はい
limit	number	query	いいえ
skip	number	query	いいえ
order	string	query	いいえ
after	number	query	いいえ
before	number	query	いいえ

レスポンス

Returns: GetAuditLogsResponse

例

getAuditLogs の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'limit' => 3.4, // 浮動小数点数
    'skip' => 3.4, // 浮動小数点数
    'order' => new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(), // \FastComments\Client\Model\SORTDIR
    'after' => 3.4, // 浮動小数点数
    'before' => 3.4, // 浮動小数点数
];
try {
    $result = $apiInstance->getAuditLogs($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
}

公開ログアウト

レスポンス

戻り値: APIEmptyResponse

例

logoutPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
try {
    $result = $apiInstance->logoutPublic();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->logoutPublic: ', $e->getMessage(), PHP_EOL;
}

コメントからブロック

Parameters

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Response

返却: BlockSuccess

Example

blockFromCommentPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
}

公開コメントのブロック解除

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Response

戻り値: UnblockSuccess

Example

unBlockCommentPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sss);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
}

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

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
commentIds	string	query	はい	コメント ID のカンマ区切りリスト。
sso	string	query	いいえ

レスポンス

Returns: CheckBlockedCommentsResponse

例

checkedCommentsForBlocked の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_ids = 'comment_ids_example'; // 文字列 | コメント ID のカンマ区切りリスト。
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
}

ユーザーをコメントからブロック

Parameters

名前	タイプ	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Response

戻り値: BlockSuccess

Example

blockUserFromComment 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
}

公開コメントを作成

パラメータ

名前	種類	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
broadcastId	string	query	はい
sessionId	string	query	いいえ
sso	string	query	いいえ

レスポンス

Returns: SaveCommentsResponseWithPresence

例

createCommentPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$broadcast_id = 'broadcast_id_example'; // 文字列
$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
$options = [
    'session_id' => 'session_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
}

コメントを削除

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
id	string	path	はい
contextUserId	string	query	いいえ
isLive	boolean	query	いいえ

レスポンス

戻り値: DeleteCommentResult

例

deleteComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを解除してAPIキーのプレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$options = [
    'context_user_id' => 'context_user_id_example', // 文字列
    'is_live' => True, // ブール
];
try {
    $result = $apiInstance->deleteComment($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
}

公開コメントを削除

パラメータ

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

応答

戻り値: PublicAPIDeleteCommentResponse

例

deleteCommentPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$options = [
    'edit_key' => 'edit_key_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
}

コメントの投票を削除

パラメータ

Name	Type	Location	Required
tenantId	string	path	Yes
commentId	string	path	Yes
voteId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

レスポンス

戻り値: VoteDeleteResponse

例

deleteCommentVote の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$vote_id = 'vote_id_example'; // string
$url_id = 'url_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$options = [
    'edit_key' => 'edit_key_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
}

コメントを通報

パラメータ

名前	タイプ	ロケーション	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

Returns: FlagCommentResponse

例

flagComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認可を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->flagComment($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
}

コメントを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返り値: APIGetCommentResponse

例

getComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して APIキー のプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getComment($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
}

コメント一覧を取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
page	integer	query	No
limit	integer	query	No
skip	integer	query	No
asTree	boolean	query	No
skipChildren	integer	query	No
limitChildren	integer	query	No
maxTreeDepth	integer	query	No
urlId	string	query	No
userId	string	query	No
anonUserId	string	query	No
contextUserId	string	query	No
hashTag	string	query	No
parentId	string	query	No
direction	string	query	No
fromDate	integer	query	No
toDate	integer	query	No

レスポンス

返却: APIGetCommentsResponse

例

getComments の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを外して API キーのプレフィックス（例: Bearer）を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'page' => 56, // int
    'limit' => 56, // int
    'skip' => 56, // int
    'as_tree' => True, // bool
    'skip_children' => 56, // int
    'limit_children' => 56, // int
    'max_tree_depth' => 56, // int
    'url_id' => 'url_id_example', // string
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
    'context_user_id' => 'context_user_id_example', // string
    'hash_tag' => 'hash_tag_example', // string
    'parent_id' => 'parent_id_example', // string
    'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
    'from_date' => 56, // int
    'to_date' => 56, // int
];
try {
    $result = $apiInstance->getComments($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
}

公開コメント一覧を取得

req tenantId urlId

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
page	integer	query	No
direction	string	query	No
sso	string	query	No
skip	integer	query	No
skipChildren	integer	query	No
limit	integer	query	No
limitChildren	integer	query	No
countChildren	boolean	query	No
fetchPageForCommentId	string	query	No
includeConfig	boolean	query	No
countAll	boolean	query	No
includei10n	boolean	query	No
locale	string	query	No
modules	string	query	No
isCrawler	boolean	query	No
includeNotificationCount	boolean	query	No
asTree	boolean	query	No
maxTreeDepth	integer	query	No
useFullTranslationIds	boolean	query	No
parentId	string	query	No
searchText	string	query	No
hashTags	array	query	No
userId	string	query	No
customConfigStr	string	query	No
afterCommentId	string	query	No
beforeCommentId	string	query	No

応答

戻り値: GetCommentsResponseWithPresencePublicComment

例

getCommentsPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$options = [
    'page' => 56, // 整数
    'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
    'sso' => 'sso_example', // 文字列
    'skip' => 56, // 整数
    'skip_children' => 56, // 整数
    'limit' => 56, // 整数
    'limit_children' => 56, // 整数
    'count_children' => True, // ブール
    'fetch_page_for_comment_id' => 'fetch_page_for_comment_id_example', // 文字列
    'include_config' => True, // ブール
    'count_all' => True, // ブール
    'includei10n' => True, // ブール
    'locale' => 'locale_example', // 文字列
    'modules' => 'modules_example', // 文字列
    'is_crawler' => True, // ブール
    'include_notification_count' => True, // ブール
    'as_tree' => True, // ブール
    'max_tree_depth' => 56, // 整数
    'use_full_translation_ids' => True, // ブール
    'parent_id' => 'parent_id_example', // 文字列
    'search_text' => 'search_text_example', // 文字列
    'hash_tags' => array('hash_tags_example'), // string[]
    'user_id' => 'user_id_example', // 文字列
    'custom_config_str' => 'custom_config_str_example', // 文字列
    'after_comment_id' => 'after_comment_id_example', // 文字列
    'before_comment_id' => 'before_comment_id_example', // 文字列
];
try {
    $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}

コメント本文を取得

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
editKey	string	query	No
sso	string	query	No

応答

返り値: PublicAPIGetCommentTextResponse

例

getCommentText の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'edit_key' => 'edit_key_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getCommentText($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
}

コメント投票者のユーザー名を取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
dir	integer	query	Yes
sso	string	query	No

レスポンス

Returns: GetCommentVoteUserNamesSuccessResponse

例

getCommentVoteUserNames 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$dir = 56; // int
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
}

コメントをロック

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

レスポンス

返却: APIEmptyResponse

例

lockComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
}

コメントをピン留め

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

レスポンス

戻り値: ChangeCommentPinStatusResponse

例

pinComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$broadcast_id = 'broadcast_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
}

コメントを保存

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

応答

Returns: APISaveCommentResponse

例

saveComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
$options = [
    'is_live' => True, // bool
    'do_spam_check' => True, // bool
    'send_emails' => True, // bool
    'populate_notifications' => True, // bool
];
try {
    $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
}

コメントを一括保存

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	はい
isLive	boolean	query	いいえ
doSpamCheck	boolean	query	いいえ
sendEmails	boolean	query	いいえ
populateNotifications	boolean	query	いいえ

レスポンス

戻り値: SaveCommentsBulkResponse

例

saveCommentsBulk の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
$options = [
    'is_live' => True, // bool
    'do_spam_check' => True, // bool
    'send_emails' => True, // bool
    'populate_notifications' => True, // bool
];
try {
    $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
}

コメント本文を設定

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

レスポンス

返却: PublicAPISetCommentTextResponse

例

setCommentText の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
$options = [
    'edit_key' => 'edit_key_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
}

コメントからユーザーのブロック解除

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

応答

返却: UnblockSuccess

例

unBlockUserFromComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
$options = [
    'user_id' => 'user_id_example', // 文字列
    'anon_user_id' => 'anon_user_id_example', // 文字列
];
try {
    $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
}

コメントの通報を解除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

戻り値: FlagCommentResponse

例

unFlagComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプリフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->unFlagComment($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
}

コメントのロック解除

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

レスポンス

戻り値: APIEmptyResponse

例

unLockComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
}

コメントのピン留め解除

Parameters

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

Response

返却: ChangeCommentPinStatusResponse

Example

unPinComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
}

コメントを更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
contextUserId	string	query	いいえ
doSpamCheck	boolean	query	いいえ
isLive	boolean	query	いいえ

応答

戻り値: APIEmptyResponse

例

updateComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$updatable_comment_params = new \FastComments\Client\Model\UpdatableCommentParams(); // \FastComments\Client\Model\UpdatableCommentParams
$options = [
    'context_user_id' => 'context_user_id_example', // string
    'do_spam_check' => True, // bool
    'is_live' => True, // bool
];
try {
    $result = $apiInstance->updateComment($tenant_id, $id, $updatable_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
}

コメントに投票

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

応答

返却: VoteResponse

例

voteComment 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$url_id = 'url_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
$options = [
    'session_id' => 'session_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
}

ユーザーのためのコメントを取得

パラメータ

Name	Type	Location	Required
userId	string	query	No
direction	string	query	No
repliesToUserId	string	query	No
page	number	query	No
includei10n	boolean	query	No
locale	string	query	No
isCrawler	boolean	query	No

レスポンス

返却: GetCommentsForUserResponse

例

getCommentsForUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$options = [
    'user_id' => 'user_id_example', // string
    'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
    'replies_to_user_id' => 'replies_to_user_id_example', // string
    'page' => 3.4, // float
    'includei10n' => True, // bool
    'locale' => 'locale_example', // string
    'is_crawler' => True, // bool
];
try {
    $result = $apiInstance->getCommentsForUser($options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentsForUser: ', $e->getMessage(), PHP_EOL;
}

ドメイン設定を追加

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

返り値: AddDomainConfigResponse

例

addDomainConfig の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
try {
    $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}

ドメイン設定を削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
domain	string	path	Yes

レスポンス

戻り値: DeleteDomainConfigResponse

例

deleteDomainConfig の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// APIキー認証を設定: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、以下のコメントを外してAPIキーのプレフィックス（例: Bearer）を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これはオプショナルです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
// 文字列
$domain = 'domain_example'; // string
// 文字列
try {
    $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
}

ドメイン設定を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
domain	string	path	Yes

レスポンス

返却: GetDomainConfigResponse

例

getDomainConfig の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、以下のコメントアウトを解除して API キーのプレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$domain = 'domain_example'; // string
try {
    $result = $apiInstance->getDomainConfig($tenant_id, $domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
}

ドメイン設定一覧を取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	Yes

レスポンス

戻り値: GetDomainConfigsResponse

例

getDomainConfigs の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
try {
    $result = $apiInstance->getDomainConfigs($tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
}

ドメイン設定を部分更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

応答

返却: PatchDomainConfigResponse

例

patchDomainConfig の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は下記のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$domain_to_update = 'domain_to_update_example'; // string
$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
try {
    $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
}

ドメイン設定を置換

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
domainToUpdate	string	path	はい

レスポンス

戻り値: PutDomainConfigResponse

例

putDomainConfig の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
// 必要なら、以下のコメントのコメントアウトを解除し、APIキーのプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$domain_to_update = 'domain_to_update_example'; // string
$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
try {
    $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
}

メールテンプレートを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

返却: CreateEmailTemplateResponse

例

createEmailTemplate の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定します: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
try {
    $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

メールテンプレートを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

応答

返却: APIEmptyResponse

例

deleteEmailTemplate の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

メールテンプレートのレンダーエラーを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
errorId	string	path	Yes

レスポンス

戻り値: APIEmptyResponse

例

deleteEmailTemplateRenderError の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$error_id = 'error_id_example'; // 文字列
try {
    $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
}

メールテンプレートを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

応答

返却: GetEmailTemplateResponse

例

getEmailTemplate 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getEmailTemplate($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

メールテンプレート定義を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

返却: GetEmailTemplateDefinitionsResponse

例

getEmailTemplateDefinitions の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを解除して API キーのプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
try {
    $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
}

メールテンプレートのレンダーエラーを取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
id	string	path	はい
skip	number	query	いいえ

応答

返り値: GetEmailTemplateRenderErrorsResponse

例

getEmailTemplateRenderErrors 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$skip = 3.4; // 浮動小数点数
try {
    $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
}

メールテンプレート一覧を取得

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes
skip	number	query	No

Response

Returns: GetEmailTemplatesResponse

Example

getEmailTemplates の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// API キー認証を設定: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$skip = 3.4; // float
try {
    $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
}

メールテンプレートをレンダリング

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	クエリ	はい
locale	string	クエリ	いいえ

レスポンス

返却: RenderEmailTemplateResponse

例

renderEmailTemplate の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証の設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
$locale = 'locale_example'; // string
try {
    $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

メールテンプレートを更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

updateEmailTemplate の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、下記のコメントを解除して APIキーのプレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_email_template_body = new \FastComments\Client\Model\UpdateEmailTemplateBody(); // \FastComments\Client\Model\UpdateEmailTemplateBody
try {
    $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

イベントログを取得

リクエスト tenantId urlId userIdWS

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
userIdWS	string	query	はい
startTime	integer	query	はい
endTime	integer	query	いいえ

レスポンス

返却: GetEventLogResponse

例

getEventLog の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$user_id_ws = 'user_id_ws_example'; // 文字列
$start_time = 56; // int
$end_time = 56; // int
try {
    $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
}

グローバルイベントログを取得

req tenantId urlId userIdWS

パラメーター

名前	タイプ	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
userIdWS	string	query	Yes
startTime	integer	query	Yes
endTime	integer	query	No

レスポンス

戻り値: GetEventLogResponse

例

getGlobalEventLog の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$user_id_ws = 'user_id_ws_example'; // 文字列
$start_time = 56; // 整数
$end_time = 56; // 整数
try {
    $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
}

フィード投稿を作成

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

レスポンス

戻り値: CreateFeedPostsResponse

例

createFeedPost の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'is_live' => True, // bool
    'do_spam_check' => True, // bool
    'skip_dup_check' => True, // bool
];
try {
    $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
}

公開フィード投稿を作成

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

応答

返却: CreateFeedPostResponse

例

createFeedPostPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

公開フィード投稿を削除

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

Returns: DeleteFeedPostPublicResponse

例

deleteFeedPostPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$post_id = 'post_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

フィード投稿一覧を取得

req tenantId afterId

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
afterId	string	query	No
limit	integer	query	No
tags	array	query	No

レスポンス

返却: GetFeedPostsResponse

例

getFeedPosts の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'after_id' => 'after_id_example', // string
    'limit' => 56, // int
    'tags' => array('tags_example'), // string[]
];
try {
    $result = $apiInstance->getFeedPosts($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
}

公開フィード投稿一覧を取得

req tenantId afterId

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
afterId	string	query	いいえ
limit	integer	query	いいえ
tags	array	query	いいえ
sso	string	query	いいえ
isCrawler	boolean	query	いいえ
includeUserInfo	boolean	query	いいえ

レスポンス

戻り値: PublicFeedPostsResponse

例

getFeedPostsPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'after_id' => 'after_id_example', // 文字列
    'limit' => 56, // 整数
    'tags' => array('tags_example'), // 文字列配列
    'sso' => 'sso_example', // 文字列
    'is_crawler' => True, // ブール
    'include_user_info' => True, // ブール
];
try {
    $result = $apiInstance->getFeedPostsPublic($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
}

フィード投稿の統計を取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
postIds	array	query	Yes
sso	string	query	No

応答

戻り値: FeedPostsStatsResponse

例

getFeedPostsStats の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$post_ids = array('post_ids_example'); // string[]
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
}

公開ユーザーのリアクションを取得

パラメータ

名前	型	場所	必須
tenantId	string	パス	はい
postIds	array	クエリ	いいえ
sso	string	クエリ	いいえ

応答

戻り値: UserReactsResponse

例

getUserReactsPublic 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'post_ids' => array('post_ids_example'), // string[]
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getUserReactsPublic($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
}

フィード投稿に公開でリアクション

パラメータ

Name	Type	Location	Required
tenantId	string	path	Yes
postId	string	path	Yes
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

応答

戻り値: ReactFeedPostResponse

例

reactFeedPostPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$post_id = 'post_id_example'; // 文字列
$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
$options = [
    'is_undo' => True, // ブール
    'broadcast_id' => 'broadcast_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

フィード投稿を更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返り値: APIEmptyResponse

例

updateFeedPost 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを解除して API キーのプレフィックス (例: Bearer) を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
try {
    $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
}

公開フィード投稿を更新

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	はい
postId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

応答

戻り値: CreateFeedPostResponse

例

updateFeedPostPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$post_id = 'post_id_example'; // string
$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

公開コメントを通報

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	Yes
commentId	string	path	Yes
isFlagged	boolean	query	Yes
sso	string	query	No

レスポンス

Returns: APIEmptyResponse

例

flagCommentPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$is_flagged = True; // 真偽値
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
}

大きいGIFを取得

Parameters

名前	型	場所	必須	説明
tenantId	string	path	はい
largeInternalURLSanitized	string	query	はい

Response

返り値: GifGetLargeResponse

Example

getGifLarge の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$large_internal_url_sanitized = 'large_internal_url_sanitized_example'; // string
try {
    $result = $apiInstance->getGifLarge($tenant_id, $large_internal_url_sanitized);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGifLarge: ', $e->getMessage(), PHP_EOL;
}

GIF検索を取得

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
search	string	query	はい
locale	string	query	いいえ
rating	string	query	いいえ
page	number	query	いいえ

応答

返却: GetGifsSearchResponse

例

getGifsSearch の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$search = 'search_example'; // string
$options = [
    'locale' => 'locale_example', // string
    'rating' => 'rating_example', // string
    'page' => 3.4, // float
];
try {
    $result = $apiInstance->getGifsSearch($tenant_id, $search, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGifsSearch: ', $e->getMessage(), PHP_EOL;
}

トレンドのGIFを取得

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
locale	string	query	No
rating	string	query	No
page	number	query	No

レスポンス

返却: GetGifsTrendingResponse

例

getGifsTrending の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'locale' => 'locale_example', // 文字列
    'rating' => 'rating_example', // 文字列
    'page' => 3.4, // 浮動小数点数
];
try {
    $result = $apiInstance->getGifsTrending($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGifsTrending: ', $e->getMessage(), PHP_EOL;
}

ハッシュタグを追加

パラメータ

名前	種類	場所	必須	説明
tenantId	string	query	はい

レスポンス

返却: CreateHashTagResponse

例

addHashTag の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
try {
    $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
}

ハッシュタグを一括追加

Parameters

名前	型	場所	必須	説明
tenantId	string	query	Yes

Response

返却: BulkCreateHashTagsResponse

Example

addHashTagsBulk の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
try {
    $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
}

ハッシュタグを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
tag	string	path	はい

応答

返却: APIEmptyResponse

例

deleteHashTag の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定する場合は以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$tag = 'tag_example'; // string
$delete_hash_tag_request_body = new \FastComments\Client\Model\DeleteHashTagRequestBody(); // \FastComments\Client\Model\DeleteHashTagRequestBody
try {
    $result = $apiInstance->deleteHashTag($tenant_id, $tag, $delete_hash_tag_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'DefaultApi->deleteHashTag の呼び出し時の例外: ', $e->getMessage(), PHP_EOL;
}

ハッシュタグ一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
page	number	query	いいえ

レスポンス

返却: GetHashTagsResponse

例

getHashTags の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$page = 3.4; // float
try {
    $result = $apiInstance->getHashTags($tenant_id, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
}

ハッシュタグを部分更新

パラメータ

Name	Type	Location	Required	Description
tenantId	string	クエリ	はい
tag	string	パス	はい

応答

Returns: UpdateHashTagResponse

例

patchHashTag の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定するには、下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$tag = 'tag_example'; // string
$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
try {
    $result = $apiInstance->patchHashTag($tenant_id, $tag, $update_hash_tag_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
}

モデレーション投票を削除

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

応答

戻り値: VoteDeleteResponse

例

deleteModerationVote の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$vote_id = 'vote_id_example'; // 文字列
$options = [
    'broadcast_id' => 'broadcast_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->deleteModerationVote($tenant_id, $comment_id, $vote_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->deleteModerationVote: ', $e->getMessage(), PHP_EOL;
}

APIコメントを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

レスポンス

返却: ModerationAPIGetCommentsResponse

例

getApiComments の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'page' => 3.4, // float
    'count' => 3.4, // float
    'text_search' => 'text_search_example', // string
    'by_ip_from_comment' => 'by_ip_from_comment_example', // string
    'filters' => 'filters_example', // string
    'search_filters' => 'search_filters_example', // string
    'sorts' => 'sorts_example', // string
    'demo' => True, // bool
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getApiComments($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getApiComments: ', $e->getMessage(), PHP_EOL;
}

APIエクスポート状況を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
batchJobId	string	query	No
sso	string	query	No

レスポンス

返却: ModerationExportStatusResponse

例

getApiExportStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'batch_job_id' => 'batch_job_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getApiExportStatus($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getApiExportStatus: ', $e->getMessage(), PHP_EOL;
}

API ID を取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
afterId	string	query	No
demo	boolean	query	No
sso	string	query	No

レスポンス

戻り値: ModerationAPIGetCommentIdsResponse

例

getApiIds の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'text_search' => 'text_search_example', // string
    'by_ip_from_comment' => 'by_ip_from_comment_example', // string
    'filters' => 'filters_example', // string
    'search_filters' => 'search_filters_example', // string
    'after_id' => 'after_id_example', // string
    'demo' => True, // bool
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getApiIds($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getApiIds: ', $e->getMessage(), PHP_EOL;
}

コメントからの禁止ユーザーを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

応答

戻り値: GetBannedUsersFromCommentResponse

例

getBanUsersFromComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->getBanUsersFromComment($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getBanUsersFromComment: ', $e->getMessage(), PHP_EOL;
}

コメントの禁止状況を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

返却: GetCommentBanStatusResponse

例

getCommentBanStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->getCommentBanStatus($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCommentBanStatus: ', $e->getMessage(), PHP_EOL;
}

コメントの子コメントを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

応答

返り値: ModerationAPIChildCommentsResponse

例

getCommentChildren の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getCommentChildren($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCommentChildren: ', $e->getMessage(), PHP_EOL;
}

カウントを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filter	string	query	No
searchFilters	string	query	No
demo	boolean	query	No
sso	string	query	No

レスポンス

戻り値: ModerationAPICountCommentsResponse

例

getCount の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'text_search' => 'text_search_example', // 文字列
    'by_ip_from_comment' => 'by_ip_from_comment_example', // 文字列
    'filter' => 'filter_example', // 文字列
    'search_filters' => 'search_filters_example', // 文字列
    'demo' => True, // ブール
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->getCount($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}

複数のカウントを取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
sso	string	query	No

レスポンス

戻り値: GetBannedUsersCountResponse

例

getCounts の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getCounts($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCounts: ', $e->getMessage(), PHP_EOL;
}

ログを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

返却: ModerationAPIGetLogsResponse

例

getLogs の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->getLogs($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getLogs: ', $e->getMessage(), PHP_EOL;
}

手動バッジを取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	Yes
sso	string	query	No

レスポンス

戻り値: GetTenantManualBadgesResponse

例

getManualBadges の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getManualBadges($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getManualBadges: ', $e->getMessage(), PHP_EOL;
}

ユーザーのための手動バッジを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

応答

Returns: GetUserManualBadgesResponse

例

getManualBadgesForUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'badges_user_id' => 'badges_user_id_example', // 文字列
    'comment_id' => 'comment_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->getManualBadgesForUser($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getManualBadgesForUser: ', $e->getMessage(), PHP_EOL;
}

モデレーション対象のコメントを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

レスポンス

返り値: ModerationAPICommentResponse

例

getModerationComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$options = [
    'include_email' => True, // ブール
    'include_ip' => True, // ブール
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->getModerationComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getModerationComment: ', $e->getMessage(), PHP_EOL;
}

モデレーションコメント本文を取得

Parameters

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Response

返却: GetCommentTextResponse

Example

getModerationCommentText の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->getModerationCommentText($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getModerationCommentText: ', $e->getMessage(), PHP_EOL;
}

事前禁止サマリーを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

レスポンス

返却: PreBanSummary

例

getPreBanSummary の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$options = [
    'include_by_user_id_and_email' => True, // 真偽値
    'include_by_ip' => True, // 真偽値
    'include_by_email_domain' => True, // 真偽値
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->getPreBanSummary($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getPreBanSummary: ', $e->getMessage(), PHP_EOL;
}

検索コメントのサマリーを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
value	string	query	No
filters	string	query	No
searchFilters	string	query	No
sso	string	query	No

レスポンス

戻り値: ModerationCommentSearchResponse

例

getSearchCommentsSummary の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'value' => 'value_example', // string
    'filters' => 'filters_example', // string
    'search_filters' => 'search_filters_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchCommentsSummary($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchCommentsSummary: ', $e->getMessage(), PHP_EOL;
}

検索ページを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
value	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: ModerationPageSearchResponse

例

getSearchPages の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'value' => 'value_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchPages($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchPages: ', $e->getMessage(), PHP_EOL;
}

検索サイトを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

レスポンス

返却: ModerationSiteSearchResponse

例

getSearchSites の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'value' => 'value_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->getSearchSites($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchSites: ', $e->getMessage(), PHP_EOL;
}

検索サジェストを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
text-search	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: ModerationSuggestResponse

例

getSearchSuggest の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'text_search' => 'text_search_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchSuggest($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchSuggest: ', $e->getMessage(), PHP_EOL;
}

検索ユーザーを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
value	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: ModerationUserSearchResponse

例

getSearchUsers の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'value' => 'value_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchUsers($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchUsers: ', $e->getMessage(), PHP_EOL;
}

信頼係数を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
userId	string	query	No
sso	string	query	No

レスポンス

返却: GetUserTrustFactorResponse

例

getTrustFactor の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // 省略可能です。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'user_id' => 'user_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->getTrustFactor($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getTrustFactor: ', $e->getMessage(), PHP_EOL;
}

ユーザーの禁止設定を取得

パラメータ

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

レスポンス

戻り値: APIModerateGetUserBanPreferencesResponse

例

getUserBanPreference の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->getUserBanPreference($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getUserBanPreference: ', $e->getMessage(), PHP_EOL;
}

ユーザー内部プロファイルを取得

パラメータ

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

レスポンス

返却: GetUserInternalProfileResponse

例

getUserInternalProfile の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これは任意で、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'comment_id' => 'comment_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getUserInternalProfile($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getUserInternalProfile: ', $e->getMessage(), PHP_EOL;
}

コメント投票の調整を投稿

パラメータ

名前	タイプ	場所	必須
tenantId	string	クエリ	はい
commentId	string	パス	はい
broadcastId	string	クエリ	いいえ
sso	string	クエリ	いいえ

レスポンス

返却: AdjustVotesResponse

例

postAdjustCommentVotes の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$adjust_comment_votes_params = new \FastComments\Client\Model\AdjustCommentVotesParams(); // \FastComments\Client\Model\AdjustCommentVotesParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->postAdjustCommentVotes($tenant_id, $comment_id, $adjust_comment_votes_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postAdjustCommentVotes: ', $e->getMessage(), PHP_EOL;
}

APIエクスポートを投稿

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

レスポンス

戻り値: ModerationExportResponse

例

postApiExport の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'text_search' => 'text_search_example', // 文字列
    'by_ip_from_comment' => 'by_ip_from_comment_example', // 文字列
    'filters' => 'filters_example', // 文字列
    'search_filters' => 'search_filters_example', // 文字列
    'sorts' => 'sorts_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->postApiExport($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postApiExport: ', $e->getMessage(), PHP_EOL;
}

コメントからユーザーを禁止にする

パラメーター

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

応答

戻り値: BanUserFromCommentResult

例

postBanUserFromComment 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$options = [
    'ban_email' => True, // ブール
    'ban_email_domain' => True, // ブール
    'ban_ip' => True, // ブール
    'delete_all_users_comments' => True, // ブール
    'banned_until' => 'banned_until_example', // 文字列
    'is_shadow_ban' => True, // ブール
    'update_id' => 'update_id_example', // 文字列
    'ban_reason' => 'ban_reason_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->postBanUserFromComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postBanUserFromComment: ', $e->getMessage(), PHP_EOL;
}

ユーザー禁止を元に戻す

パラメータ

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

レスポンス

返却: APIEmptyResponse

例

postBanUserUndo の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$ban_user_undo_params = new \FastComments\Client\Model\BanUserUndoParams(); // \FastComments\Client\Model\BanUserUndoParams
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->postBanUserUndo($tenant_id, $ban_user_undo_params, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postBanUserUndo: ', $e->getMessage(), PHP_EOL;
}

一括事前禁止サマリーを投稿

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

レスポンス

返り値: BulkPreBanSummary

例

postBulkPreBanSummary の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$bulk_pre_ban_params = new \FastComments\Client\Model\BulkPreBanParams(); // \FastComments\Client\Model\BulkPreBanParams
$options = [
    'include_by_user_id_and_email' => True, // bool
    'include_by_ip' => True, // bool
    'include_by_email_domain' => True, // bool
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postBulkPreBanSummary($tenant_id, $bulk_pre_ban_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postBulkPreBanSummary: ', $e->getMessage(), PHP_EOL;
}

IDによるコメント群を投稿

パラメータ

名前	型	場所	必須	説明
tenantId	string	クエリ	はい
sso	string	クエリ	いいえ

応答

Returns: ModerationAPIChildCommentsResponse

例

postCommentsByIds 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comments_by_ids_params = new \FastComments\Client\Model\CommentsByIdsParams(); // \FastComments\Client\Model\CommentsByIdsParams
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->postCommentsByIds($tenant_id, $comments_by_ids_params, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postCommentsByIds: ', $e->getMessage(), PHP_EOL;
}

コメントを通報（投稿）

Parameters

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

Response

返却: APIEmptyResponse

Example

postFlagComment 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postFlagComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postFlagComment: ', $e->getMessage(), PHP_EOL;
}

コメント削除を投稿

Parameters

名前	タイプ	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: PostRemoveCommentApiResponse

例

postRemoveComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postRemoveComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postRemoveComment: ', $e->getMessage(), PHP_EOL;
}

削除済みコメントを復元（投稿）

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

応答

返り値: APIEmptyResponse

例

postRestoreDeletedComment 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$options = [
    'broadcast_id' => 'broadcast_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->postRestoreDeletedComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postRestoreDeletedComment: ', $e->getMessage(), PHP_EOL;
}

コメント承認ステータスを設定（投稿）

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	はい
commentId	string	path	はい
approved	boolean	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: SetCommentApprovedResponse

例

postSetCommentApprovalStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'approved' => True, // bool
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postSetCommentApprovalStatus($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postSetCommentApprovalStatus: ', $e->getMessage(), PHP_EOL;
}

コメントレビュー状態を設定（投稿）

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
reviewed	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

応答

返却: APIEmptyResponse

例

postSetCommentReviewStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$options = [
    'reviewed' => True, // ブール
    'broadcast_id' => 'broadcast_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->postSetCommentReviewStatus($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postSetCommentReviewStatus: ', $e->getMessage(), PHP_EOL;
}

コメントスパム状態を設定（投稿）

Parameters

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

返却: APIEmptyResponse

例

postSetCommentSpamStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'spam' => True, // bool
    'perm_not_spam' => True, // bool
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postSetCommentSpamStatus($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postSetCommentSpamStatus: ', $e->getMessage(), PHP_EOL;
}

コメント本文を設定（投稿）

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

返り値: SetCommentTextResponse

例

postSetCommentText 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$comment_id = 'comment_id_example'; // 文字列
$set_comment_text_params = new \FastComments\Client\Model\SetCommentTextParams(); // \FastComments\Client\Model\SetCommentTextParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // 文字列
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->postSetCommentText($tenant_id, $comment_id, $set_comment_text_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'ModerationApi->postSetCommentText の呼び出し時の例外: ', $e->getMessage(), PHP_EOL;
}

通報解除を投稿

Parameters

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Response

Returns: APIEmptyResponse

Example

postUnFlagComment の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postUnFlagComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postUnFlagComment: ', $e->getMessage(), PHP_EOL;
}

投票を投稿

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
direction	string	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: VoteResponse

例

postVote の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'direction' => 'direction_example', // string
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postVote($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postVote: ', $e->getMessage(), PHP_EOL;
}

バッジを付与（PUT）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
badgeId	string	query	はい
userId	string	query	いいえ
commentId	string	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: AwardUserBadgeResponse

例

putAwardBadge 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$badge_id = 'badge_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'comment_id' => 'comment_id_example', // string
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->putAwardBadge($tenant_id, $badge_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putAwardBadge: ', $e->getMessage(), PHP_EOL;
}

スレッドを閉鎖（PUT）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
urlId	string	query	はい
sso	string	query	いいえ

応答

返却: APIEmptyResponse

例

putCloseThread の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->putCloseThread($tenant_id, $url_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putCloseThread: ', $e->getMessage(), PHP_EOL;
}

バッジを削除（PUT）

パラメータ

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

レスポンス

戻り値: RemoveUserBadgeResponse

例

putRemoveBadge の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$badge_id = 'badge_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'comment_id' => 'comment_id_example', // string
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->putRemoveBadge($tenant_id, $badge_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putRemoveBadge: ', $e->getMessage(), PHP_EOL;
}

スレッドを再開（PUT）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
urlId	string	query	はい
sso	string	query	いいえ

応答

返却: APIEmptyResponse

例

putReopenThread の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$sso = 'sso_example'; // 文字列
try {
    $result = $apiInstance->putReopenThread($tenant_id, $url_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putReopenThread: ', $e->getMessage(), PHP_EOL;
}

信頼係数を設定

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

レスポンス

戻り値: SetUserTrustFactorResponse

例

setTrustFactor の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
// これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
$apiInstance = new FastComments\Client\Api\ModerationApi(
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'trust_factor' => 'trust_factor_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->setTrustFactor($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->setTrustFactor: ', $e->getMessage(), PHP_EOL;
}

モデレーターを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

返り値: CreateModeratorResponse

例

createModerator の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証の設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
try {
    $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
}

モデレーターを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
sendEmail	string	query	いいえ

レスポンス

返却: APIEmptyResponse

例

deleteModerator の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて下のコメントを外し、APIキーのプレフィックス（例: Bearer）を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$send_email = 'send_email_example'; // 文字列
try {
    $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
}

モデレーターを取得

Parameters

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

Response

戻り値: GetModeratorResponse

Example

getModerator の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->getModerator($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
}

モデレーター一覧を取得

パラメータ

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

レスポンス

返却: GetModeratorsResponse

例

getModerators の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$skip = 3.4; // 浮動小数点
try {
    $result = $apiInstance->getModerators($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
}

招待を送信

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
id	string	path	はい
fromName	string	query	はい

応答

返却: APIEmptyResponse

例

sendInvite の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$from_name = 'from_name_example'; // string
try {
    $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
}

モデレーターを更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: APIEmptyResponse

例

updateModerator の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
try {
    $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
}

通知数を削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

応答

返却: APIEmptyResponse

例

deleteNotificationCount の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
}

キャッシュされた通知数を取得

Parameters

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

Response

返り値: GetCachedNotificationCountResponse

例

getCachedNotificationCount の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、下のコメントアウトを解除して APIキーのプレフィックス（例: Bearer）を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
}

通知数を取得

パラメータ

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

レスポンス

返却: GetNotificationCountResponse

例

getNotificationCount の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認可を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'user_id' => 'user_id_example', // 文字列
    'url_id' => 'url_id_example', // 文字列
    'from_comment_id' => 'from_comment_id_example', // 文字列
    'viewed' => True, // ブール
    'type' => 'type_example', // 文字列
];
try {
    $result = $apiInstance->getNotificationCount($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
}

通知一覧を取得

パラメータ

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

応答

戻り値: GetNotificationsResponse

例

getNotifications の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認可を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // 文字列
    'url_id' => 'url_id_example', // 文字列
    'from_comment_id' => 'from_comment_id_example', // 文字列
    'viewed' => True, // ブール
    'type' => 'type_example', // 文字列
    'skip' => 3.4, // 浮動小数点
];
try {
    $result = $apiInstance->getNotifications($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
}

通知を更新

パラメータ

名前	タイプ	ロケーション	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

レスポンス

返却: APIEmptyResponse

例

updateNotification の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// API キー認証を設定: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて下の行のコメントを外し、プレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // 省略可能です。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
$user_id = 'user_id_example'; // 文字列
try {
    $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
}

V1 ページリアクションを作成

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
title	string	query	いいえ

レスポンス

Returns: CreateV1PageReact

例

createV1PageReact 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$title = 'title_example'; // 文字列
try {
    $result = $apiInstance->createV1PageReact($tenant_id, $url_id, $title);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createV1PageReact: ', $e->getMessage(), PHP_EOL;
}

V2 ページリアクションを作成

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes
title	string	query	No

レスポンス

戻り値: CreateV1PageReact

例

createV2PageReact の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$id = 'id_example'; // 文字列
$title = 'title_example'; // 文字列
try {
    $result = $apiInstance->createV2PageReact($tenant_id, $url_id, $id, $title);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createV2PageReact: ', $e->getMessage(), PHP_EOL;
}

V1 ページリアクションを削除

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	path	はい
urlId	string	query	はい

レスポンス

返却: CreateV1PageReact

例

deleteV1PageReact の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
    $result = $apiInstance->deleteV1PageReact($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteV1PageReact: ', $e->getMessage(), PHP_EOL;
}

V2 ページリアクションを削除

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

レスポンス

戻り値: CreateV1PageReact

例

deleteV2PageReact 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deleteV2PageReact($tenant_id, $url_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteV2PageReact: ', $e->getMessage(), PHP_EOL;
}

V1 ページいいねを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes

応答

返却: GetV1PageLikes

例

getV1PageLikes の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
try {
    $result = $apiInstance->getV1PageLikes($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getV1PageLikes: ', $e->getMessage(), PHP_EOL;
}

V2 ページリアクションを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes

レスポンス

戻り値: GetV2PageReacts

例

getV2PageReacts 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
    $result = $apiInstance->getV2PageReacts($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getV2PageReacts: ', $e->getMessage(), PHP_EOL;
}

V2 ページリアクションのユーザーを取得

Parameters

名前	タイプ	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

Response

戻り値: GetV2PageReactUsersResponse

Example

getV2PageReactUsers の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id = 'url_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->getV2PageReactUsers($tenant_id, $url_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getV2PageReactUsers: ', $e->getMessage(), PHP_EOL;
}

ページを追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

戻り値

戻り値: AddPageAPIResponse

例

addPage の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
try {
    $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
}

ページを削除

Parameters

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

Response

返却: DeletePageAPIResponse

Example

deletePage の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deletePage($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
}

オフラインユーザーを取得

Past commenters on the page who are NOT currently online. Sorted by displayName.
ページ上で過去にコメントしたが、現在オンラインではないユーザー。displayNameでソートされます。

Use this after exhausting /users/online to render a "Members" section.
/users/online をすべて使い切った後に、"Members" セクションを表示するために使用します。

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
commenterName に対するカーソルページング: サーバーは部分的な {tenantId, urlId, commenterName} インデックスを afterName 以降へ $gt で進めます。$skip のコストはかかりません。

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	ページ URL 識別子（サーバー側でクリーンアップされたもの）。
afterName	string	query	No	カーソル: 前回のレスポンスから `nextAfterName` を渡します。
afterUserId	string	query	No	カーソルのタイブレーカー: 前回のレスポンスから `nextAfterUserId` を渡します。`afterName` が設定されている場合に必要で、名前が同じ場合にエントリが落ちないようにします。

Response

Returns: PageUsersOfflineResponse

Example

getOfflineUsers の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトで `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string | ページ URL 識別子（サーバー側でクリーンアップされたもの）。
$options = [
    'after_name' => 'after_name_example', // string | カーソル: 前回のレスポンスから `nextAfterName` を渡します。
    'after_user_id' => 'after_user_id_example', // string | カーソルのタイブレーカー: 前回のレスポンスから `nextAfterUserId` を渡します。`afterName` が設定されている場合に必要で、名前が同じ場合にエントリが落ちないようにします。
];
try {
    $result = $apiInstance->getOfflineUsers($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getOfflineUsers: ', $e->getMessage(), PHP_EOL;
}

オンラインユーザーを取得

現在ページをオンラインで閲覧しているユーザー: 現在、ウェブソケットセッションがそのページに購読されている人々。
返却: anonCount + totalCount（部屋全体の購読者数で、匿名ビューアーも含まれますが、列挙は行いません）。

Parameters

名前	型	場所	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes	ページ URL 識別子（サーバー側でクリーンアップされたもの）。
afterName	string	query	No	カーソル: 前回のレスポンスから nextAfterName を渡す。
afterUserId	string	query	No	カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。

Response

返却: PageUsersOnlineResponse

Example

getOnlineUsers の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string | ページ URL 識別子（サーバー側でクリーンアップされたもの）。
$options = [
    'after_name' => 'after_name_example', // string | カーソル: 前回のレスポンスから nextAfterName を渡す。
    'after_user_id' => 'after_user_id_example', // string | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。
];
try {
    $result = $apiInstance->getOnlineUsers($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getOnlineUsers: ', $e->getMessage(), PHP_EOL;
}

URL ID でページを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
urlId	string	query	Yes

レスポンス

戻り値: GetPageByURLIdAPIResponse

例

getPageByURLId の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外してプレフィックス（例: Bearer）を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
    $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
}

ページ一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

返却: GetPagesAPIResponse

例

getPages 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
try {
    $result = $apiInstance->getPages($tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
}

公開ページ一覧を取得

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

テナントのページを一覧取得します。FChat デスクトップクライアントが部屋リストを埋めるために使用します。
各ページの解決されたカスタム設定で enableFChat が true である必要があります。
SSO が必要なページは、リクエストユーザーのグループアクセスに基づいてフィルタリングされます。

Parameters

名前	型	場所	必須	説明
tenantId	string	path	Yes
cursor	string	query	No	前回のリクエストで `nextCursor` として返された不透明なページネーションカーソル。同じ `sortBy` に関連付けられます。
limit	integer	query	No	1..200、デフォルトは 50
q	string	query	No	オプションの大文字小文字を区別しないタイトルプレフィックスフィルタ。
sortBy	string	query	No	ソート順。`updatedAt`（デフォルト、最新が最初）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
hasComments	boolean	query	No	true の場合、少なくとも1つのコメントがあるページのみを返します。

Response

Returns: GetPublicPagesResponse

Example

getPagesPublic の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'cursor' => 'cursor_example', // string | 前回のリクエストで `nextCursor` として返された不透明なページネーションカーソル。同じ `sortBy` に関連付けられます。
    'limit' => 56, // int | 1..200、デフォルトは 50
    'q' => 'q_example', // string | オプションの大文字小文字を区別しないタイトルプレフィックスフィルタ。
    'sort_by' => new \FastComments\Client\Model\\FastComments\Client\Model\PagesSortBy(), // \FastComments\Client\Model\PagesSortBy | ソート順。`updatedAt`（デフォルト、最新が最初）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
    'has_comments' => True, // bool | true の場合、少なくとも1つのコメントがあるページのみを返します。
];
try {
    $result = $apiInstance->getPagesPublic($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getPagesPublic: ', $e->getMessage(), PHP_EOL;
}

ユーザー情報を取得

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	path	Yes
ids	string	query	Yes	カンマ区切りの userIds.

Response

Returns: PageUsersInfoResponse

Example

getUsersInfo の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$ids = 'ids_example'; // 文字列 | カンマ区切りの userIds.
try {
    $result = $apiInstance->getUsersInfo($tenant_id, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUsersInfo: ', $e->getMessage(), PHP_EOL;
}

ページを部分更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

応答

返却: PatchPageAPIResponse

例

patchPage 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
try {
    $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
}

保留中のWebhookイベントを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

deletePendingWebhookEvent の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを外してプレフィックス（例: Bearer）を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これは省略可能で、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
}

保留中のWebhookイベント数を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

応答

Returns: GetPendingWebhookEventCountResponse

例

getPendingWebhookEventCount の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定します: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'comment_id' => 'comment_id_example', // string
    'external_id' => 'external_id_example', // string
    'event_type' => 'event_type_example', // string
    'type' => 'type_example', // string
    'domain' => 'domain_example', // string
    'attempt_count_gt' => 3.4, // float
];
try {
    $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
}

保留中のWebhookイベント一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	query	いいえ
externalId	string	query	いいえ
eventType	string	query	いいえ
type	string	query	いいえ
domain	string	query	いいえ
attemptCountGT	number	query	いいえ
skip	number	query	いいえ

レスポンス

返り値: GetPendingWebhookEventsResponse

例

getPendingWebhookEvents の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、`GuzzleHttp\Client` がデフォルトで使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'comment_id' => 'comment_id_example', // string
    'external_id' => 'external_id_example', // string
    'event_type' => 'event_type_example', // string
    'type' => 'type_example', // string
    'domain' => 'domain_example', // string
    'attempt_count_gt' => 3.4, // float
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getPendingWebhookEvents($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
}

質問設定を作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

返却: CreateQuestionConfigResponse

例

createQuestionConfig 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを解除してプレフィックス (例: Bearer) を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
try {
    $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

質問設定を削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

Returns: APIEmptyResponse

例

deleteQuestionConfig の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証の設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定する場合は、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

質問設定を取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetQuestionConfigResponse

例

getQuestionConfig の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getQuestionConfig($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

質問設定一覧を取得

パラメータ

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

レスポンス

返り値: GetQuestionConfigsResponse

例

getQuestionConfigs の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$skip = 3.4; // 浮動小数点数
try {
    $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
}

質問設定を更新

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

Returns: APIEmptyResponse

例

updateQuestionConfig 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$update_question_config_body = new \FastComments\Client\Model\UpdateQuestionConfigBody(); // \FastComments\Client\Model\UpdateQuestionConfigBody
try {
    $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

質問結果を作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

応答

返却: CreateQuestionResultResponse

例

createQuestionResult の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
try {
    $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
}

質問結果を削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

deleteQuestionResult の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
}

質問結果を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

Returns: GetQuestionResultResponse

例

getQuestionResult の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合はコメントアウトを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getQuestionResult($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
}

質問結果一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	No
userId	string	query	No
startDate	string	query	No
questionId	string	query	No
questionIds	string	query	No
skip	number	query	No

レスポンス

戻り値: GetQuestionResultsResponse

例

getQuestionResults 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、コメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'url_id' => 'url_id_example', // 文字列
    'user_id' => 'user_id_example', // 文字列
    'start_date' => 'start_date_example', // 文字列
    'question_id' => 'question_id_example', // 文字列
    'question_ids' => 'question_ids_example', // 文字列
    'skip' => 3.4, // 浮動小数点数
];
try {
    $result = $apiInstance->getQuestionResults($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
}

質問結果を更新

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

応答

返却: APIEmptyResponse

例

updateQuestionResult の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
try {
    $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
}

質問結果を集計

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

応答

返却: AggregateQuestionResultsResponse

例

aggregateQuestionResults の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'question_id' => 'question_id_example', // 文字列
    'question_ids' => array('question_ids_example'), // 文字列[]
    'url_id' => 'url_id_example', // 文字列
    'time_bucket' => new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(), // \FastComments\Client\Model\AggregateTimeBucket
    'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
    'force_recalculate' => True, // bool
];
try {
    $result = $apiInstance->aggregateQuestionResults($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
}

質問結果を一括集計

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
forceRecalculate	boolean	query	いいえ

レスポンス

戻り値: BulkAggregateQuestionResultsResponse

例

bulkAggregateQuestionResults の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を構成: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを解除して API キーのプレフィックス（例：Bearer）を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
$force_recalculate = True; // bool
try {
    $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
}

コメントと質問結果を結合

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No
minValue	number	query	No
maxValue	number	query	No
limit	number	query	No

応答

返却: CombineQuestionResultsWithCommentsResponse

例

combineCommentsWithQuestionResults の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認可の設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'question_id' => 'question_id_example', // string
    'question_ids' => array('question_ids_example'), // string[]
    'url_id' => 'url_id_example', // string
    'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
    'force_recalculate' => True, // bool
    'min_value' => 3.4, // float
    'max_value' => 3.4, // float
    'limit' => 3.4, // float
];
try {
    $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
}

SSOユーザーを追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

返却: AddSSOUserAPIResponse

例

addSSOUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
try {
    $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
}

SSOユーザーを削除

Parameters

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
deleteComments	boolean	query	いいえ
commentDeleteMode	string	query	いいえ

Response

返却: DeleteSSOUserAPIResponse

Example

deleteSSOUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は、以下のコメントを外す
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$options = [
    'delete_comments' => True, // bool
    'comment_delete_mode' => 'comment_delete_mode_example', // string
];
try {
    $result = $apiInstance->deleteSSOUser($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
}

メールでSSOユーザーを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
email	string	path	はい

応答

戻り値: GetSSOUserByEmailAPIResponse

例

getSSOUserByEmail 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$email = 'email_example'; // string
try {
    $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
}

IDでSSOユーザーを取得

パラメータ

名前	型	ロケーション	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: GetSSOUserByIdAPIResponse

例

getSSOUserById の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを解除して API キーのプレフィックス (例: Bearer) を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->getSSOUserById($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
}

SSOユーザー一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	integer	query	いいえ

レスポンス

戻り値: GetSSOUsersResponse

例

getSSOUsers 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$skip = 56; // int
try {
    $result = $apiInstance->getSSOUsers($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
}

SSOユーザーを部分更新

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

応答

戻り値: PatchSSOUserAPIResponse

例

patchSSOUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
$update_comments = True; // bool
try {
    $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
}

SSOユーザーを置換

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

レスポンス

返却: PutSSOUserAPIResponse

例

putSSOUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
$update_comments = True; // bool
try {
    $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
}

サブスクリプションを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

応答

返却: CreateSubscriptionAPIResponse

例

createSubscription 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを外してAPIキーのプレフィックス（例: Bearer）を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトで `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
try {
    $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
}

サブスクリプションを削除

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

Response

Returns: DeleteSubscriptionAPIResponse

Example

deleteSubscription の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を構成します: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$user_id = 'user_id_example'; // string
try {
    $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
}

サブスクリプション一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
userId	string	query	いいえ

レスポンス

返却: GetSubscriptionsAPIResponse

例

getSubscriptions の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$user_id = 'user_id_example'; // 文字列
try {
    $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
}

サブスクリプションを更新

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

レスポンス

返り値: UpdateSubscriptionAPIResponse

例

updateSubscription の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認可を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
$user_id = 'user_id_example'; // string
try {
    $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
}

テナントの日次使用量を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
yearNumber	number	query	No
monthNumber	number	query	No
dayNumber	number	query	No
skip	number	query	No

レスポンス

返却: GetTenantDailyUsagesResponse

例

getTenantDailyUsages の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'year_number' => 3.4, // float
    'month_number' => 3.4, // float
    'day_number' => 3.4, // float
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getTenantDailyUsages($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
}

テナントパッケージを作成

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい

レスポンス

返却: CreateTenantPackageResponse

例

createTenantPackage 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
try {
    $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
}

テナントパッケージを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

応答

返却: APIEmptyResponse

例

deleteTenantPackage の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
}

テナントパッケージを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: GetTenantPackageResponse

例

getTenantPackage の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getTenantPackage($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
}

テナントパッケージ一覧を取得

パラメータ

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

レスポンス

返却: GetTenantPackagesResponse

例

getTenantPackages の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$skip = 3.4; // 浮動小数点数
try {
    $result = $apiInstance->getTenantPackages($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
}

テナントパッケージを置換

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: APIEmptyResponse

例

replaceTenantPackage の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
try {
    $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
}

テナントパッケージを更新

パラメータ

名前	種類	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

updateTenantPackage の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
try {
    $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
}

テナントユーザーを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

返却: CreateTenantUserResponse

例

createTenantUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて以下のコメントを外してプレフィックス (例: Bearer) を設定
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これは任意で、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
try {
    $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
}

テナントユーザーを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
deleteComments	string	query	いいえ
commentDeleteMode	string	query	いいえ

レスポンス

返却: APIEmptyResponse

例

deleteTenantUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$options = [
    'delete_comments' => 'delete_comments_example', // string
    'comment_delete_mode' => 'comment_delete_mode_example', // string
];
try {
    $result = $apiInstance->deleteTenantUser($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
}

テナントユーザーを取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: GetTenantUserResponse

例

getTenantUser 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定します: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これは任意で、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getTenantUser($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
}

テナントユーザー一覧を取得

パラメータ

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

レスポンス

戻り値: GetTenantUsersResponse

例

getTenantUsers の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下の API キーのプレフィックス (例: Bearer) を設定するにはコメントを外します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$skip = 3.4; // float
try {
    $result = $apiInstance->getTenantUsers($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
}

テナントユーザーを置換

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
updateComments	string	query	No

Response

Returns: APIEmptyResponse

Example

replaceTenantUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定します: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて以下のコメントを外してプレフィックス (例: Bearer) を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
$update_comments = 'update_comments_example'; // 文字列
try {
    $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
}

ログインリンクを送信

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
redirectURL	string	query	いいえ

応答

返却: APIEmptyResponse

例

sendLoginLink 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証の設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。`GuzzleHttp\Client` がデフォルトで使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$redirect_url = 'redirect_url_example'; // 文字列
try {
    $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
}

テナントユーザーを更新

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
updateComments	string	query	No

応答

返却: APIEmptyResponse

例

updateTenantUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを外して API キーのプレフィックス (例: Bearer) を設定します
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
$update_comments = 'update_comments_example'; // 文字列
try {
    $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
}

テナントを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

応答

戻り値: CreateTenantResponse

例

createTenant の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
try {
    $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
}

テナントを削除

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
id	string	path	はい
sure	string	query	いいえ

応答

返却: APIEmptyResponse

例

deleteTenant の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は下の行のコメントを解除
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$sure = 'sure_example'; // 文字列
try {
    $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
}

テナントを取得

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

Returns: GetTenantResponse

例

getTenant の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// APIキー認証を設定: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getTenant($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
}

テナント一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
meta	string	query	いいえ
skip	number	query	いいえ

応答

Returns: GetTenantsResponse

例

getTenants の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認可の設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'meta' => 'meta_example', // 文字列
    'skip' => 3.4, // 浮動小数点数
];
try {
    $result = $apiInstance->getTenants($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
}

テナントを更新

Parameters

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

Response

戻り値: APIEmptyResponse

Example

updateTenant の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
try {
    $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
}

チケット状態を変更

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
userId	string	query	はい
id	string	path	はい

レスポンス

返却: ChangeTicketStateResponse

例

changeTicketState の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントアウトを外してプレフィックス (例: Bearer) を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$user_id = 'user_id_example'; // string
$id = 'id_example'; // string
$change_ticket_state_body = new \FastComments\Client\Model\ChangeTicketStateBody(); // \FastComments\Client\Model\ChangeTicketStateBody
try {
    $result = $apiInstance->changeTicketState($tenant_id, $user_id, $id, $change_ticket_state_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->changeTicketState: ', $e->getMessage(), PHP_EOL;
}

チケットを作成

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
userId	string	query	はい

レスポンス

返却: CreateTicketResponse

例

createTicket の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー承認を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメント解除
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$user_id = 'user_id_example'; // 文字列
$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
try {
    $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
}

チケットを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

返却: GetTicketResponse

例

getTicket の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
$user_id = 'user_id_example'; // 文字列
try {
    $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
}

チケット一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
state	number	query	いいえ
skip	number	query	いいえ
limit	number	query	いいえ

レスポンス

返却: GetTicketsResponse

例

getTickets の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を構成: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下のコメントアウトを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'user_id' => 'user_id_example', // 文字列
    'state' => 3.4, // 浮動小数点数
    'skip' => 3.4, // 浮動小数点数
    'limit' => 3.4, // 浮動小数点数
];
try {
    $result = $apiInstance->getTickets($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
}

翻訳を取得

Parameters

Name	Type	Location	Required
namespace	string	path	Yes
component	string	path	Yes
locale	string	query	No
useFullTranslationIds	boolean	query	No

Response

Returns: GetTranslationsResponse

Example

getTranslations の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$namespace = 'namespace_example'; // 文字列
$component = 'component_example'; // 文字列
$options = [
    'locale' => 'locale_example', // 文字列
    'use_full_translation_ids' => True, // ブール
];
try {
    $result = $apiInstance->getTranslations($namespace, $component, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getTranslations: ', $e->getMessage(), PHP_EOL;
}

画像をアップロード

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

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
sizePreset	string	query	No	サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成)
urlId	string	query	No	アップロードが行われているページ ID、設定用

応答

戻り値: UploadImageResponse

例

uploadImage の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$file = '/path/to/file.txt'; // \SplFileObject
$options = [
    'size_preset' => new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(), // \FastComments\Client\Model\SizePreset | サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成)
    'url_id' => 'url_id_example', // string | アップロードが行われているページ ID、設定用
];
try {
    $result = $apiInstance->uploadImage($tenant_id, $file, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
}

バッジ進捗をIDで取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: APIGetUserBadgeProgressResponse

例

getUserBadgeProgressById の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は、以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$id = 'id_example'; // 文字列
try {
    $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
}

ユーザーIDでバッジ進捗を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
userId	string	path	はい

レスポンス

返却: APIGetUserBadgeProgressResponse

例

getUserBadgeProgressByUserId の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、以下のコメントを解除して API キーのプレフィックス (例: Bearer) を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$user_id = 'user_id_example'; // 文字列
try {
    $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
}

ユーザーバッジ進捗一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
limit	number	query	いいえ
skip	number	query	いいえ

応答

戻り値: APIGetUserBadgeProgressListResponse

例

getUserBadgeProgressList の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'limit' => 3.4, // float
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getUserBadgeProgressList($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
}

ユーザーバッジを作成

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい

レスポンス

返却: APICreateUserBadgeResponse

例

createUserBadge 例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて API キーのプレフィックス (例: Bearer) を設定するには、以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
try {
    $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
}

ユーザーバッジを削除

Parameters

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

Response

戻り値: APIEmptySuccessResponse

例

deleteUserBadge の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// 必要に応じて、以下のコメントを外してAPIキーのプレフィックス（例: Bearer）を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deleteUserBadge($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
}

ユーザーバッジを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIGetUserBadgeResponse

例

getUserBadge の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトで `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getUserBadge($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
}

ユーザーバッジ一覧を取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
badgeId	string	query	いいえ
type	number	query	いいえ
displayedOnComments	boolean	query	いいえ
limit	number	query	いいえ
skip	number	query	いいえ

レスポンス

Returns: APIGetUserBadgesResponse

例

getUserBadges の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// API キー認証を設定: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'user_id' => 'user_id_example', // 文字列
    'badge_id' => 'badge_id_example', // 文字列
    'type' => 3.4, // 浮動小数点数
    'displayed_on_comments' => True, // 真偽値
    'limit' => 3.4, // 浮動小数点数
    'skip' => 3.4, // 浮動小数点数
];
try {
    $result = $apiInstance->getUserBadges($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
}

ユーザーバッジを更新

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: APIEmptySuccessResponse

例

updateUserBadge の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外す
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
try {
    $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
}

ユーザーの通知数を取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

返り値: GetUserNotificationCountResponse

例

getUserNotificationCount の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタムの HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
}

ユーザーの通知一覧を取得

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes
urlId	string	query	No	現在のページが購読されているかどうかを判断するために使用されます。
pageSize	integer	query	No
afterId	string	query	No
includeContext	boolean	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
includeTranslations	boolean	query	No
includeTenantNotifications	boolean	query	No
sso	string	query	No

Response

Returns: GetMyNotificationsResponse

Example

getUserNotifications の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'url_id' => 'url_id_example', // string | 現在のページが購読されているかどうかを判断するために使用されます。
    'page_size' => 56, // int
    'after_id' => 'after_id_example', // string
    'include_context' => True, // bool
    'after_created_at' => 56, // int
    'unread_only' => True, // bool
    'dm_only' => True, // bool
    'no_dm' => True, // bool
    'include_translations' => True, // bool
    'include_tenant_notifications' => True, // bool
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getUserNotifications($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
}

ユーザーの通知数をリセット

パラメータ

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

応答

返却: ResetUserNotificationsResponse

例

resetUserNotificationCount の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
}

ユーザーの通知をリセット

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
afterId	string	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
sso	string	query	No

レスポンス

Returns: ResetUserNotificationsResponse

例

resetUserNotifications の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$options = [
    'after_id' => 'after_id_example', // 文字列
    'after_created_at' => 56, // 整数
    'unread_only' => True, // ブール
    'dm_only' => True, // ブール
    'no_dm' => True, // ブール
    'sso' => 'sso_example', // 文字列
];
try {
    $result = $apiInstance->resetUserNotifications($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
}

ユーザーのコメント購読ステータスを更新

Enable or disable notifications for a specific comment.

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
notificationId	string	path	はい
optedInOrOut	string	path	はい
commentId	string	query	はい
sso	string	query	いいえ

応答

戻り値: UpdateUserNotificationCommentSubscriptionStatusResponse

例

updateUserNotificationCommentSubscriptionStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$notification_id = 'notification_id_example'; // string
$opted_in_or_out = 'opted_in_or_out_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
}

ユーザーのページ購読ステータスを更新

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

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	Yes
url	string	query	Yes
pageTitle	string	query	Yes
subscribedOrUnsubscribed	string	path	Yes
sso	string	query	No

レスポンス

戻り値: UpdateUserNotificationPageSubscriptionStatusResponse

例

updateUserNotificationPageSubscriptionStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$url = 'url_example'; // string
$page_title = 'page_title_example'; // string
$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
}

ユーザーの通知ステータスを更新

Parameters

名前	型	場所	必須
tenantId	string	query	Yes
notificationId	string	path	Yes
newStatus	string	path	Yes
sso	string	query	No

Response

返却: UpdateUserNotificationStatusResponse

Example

updateUserNotificationStatus の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$notification_id = 'notification_id_example'; // string
$new_status = 'new_status_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
}

ユーザー在席ステータスを取得

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	はい
urlIdWS	string	query	はい
userIds	string	query	はい

応答

返り値: GetUserPresenceStatusesResponse

例

getUserPresenceStatuses の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // 文字列
$url_id_ws = 'url_id_ws_example'; // 文字列
$user_ids = 'user_ids_example'; // 文字列
try {
    $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
}

ユーザーを検索

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
usernameStartsWith	string	query	No
mentionGroupIds	array	query	No
sso	string	query	No
searchSection	string	query	No

レスポンス

戻り値: SearchUsersResult

例

searchUsers の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // 省略可能で、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$options = [
    'username_starts_with' => 'username_starts_with_example', // string
    'mention_group_ids' => array('mention_group_ids_example'), // string[]
    'sso' => 'sso_example', // string
    'search_section' => 'search_section_example', // string
];
try {
    $result = $apiInstance->searchUsers($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
}

ユーザーを取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: GetUserResponse

例

getUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキーの認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントアウトを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getUser($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
}

投票を作成

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	query	はい
direction	string	query	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

返却: VoteResponse

例

createVote の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 必要に応じて以下の行のコメントを外し、APIキーのプレフィックス（例: Bearer）を設定してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$direction = 'direction_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
}

投票を削除

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
editKey	string	query	No

応答

返り値: VoteDeleteResponse

例

deleteVote の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// APIキー認証を設定: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$edit_key = 'edit_key_example'; // string
try {
    $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
}

投票一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
urlId	string	query	はい

レスポンス

返却: GetVotesResponse

例

getVotes の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API キー認証を構成: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 以下のコメントを外すと、必要に応じて API キーのプレフィックス (例: Bearer) を設定できます
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
    $result = $apiInstance->getVotes($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
}

ユーザーの投票を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

返却: GetVotesForUserResponse

例

getVotesForUser の例

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// APIキー認証を設定: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// 以下のコメントアウトを外して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
    // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
}

ヘルプが必要ですか？

PHP SDK に関して問題が発生した場合や質問がある場合は、次のいずれかを行ってください：

貢献

貢献を歓迎します！貢献ガイドラインについては、GitHub リポジトリをご覧ください。

言語 🇯🇵 日本語

はじめに

API リファレンス

ドキュメント

認証

集計

監査ログ

コメントからのブロック

ブロックされたコメントの確認

コメント

ユーザーのコメント

ドメイン設定

メールテンプレート

イベントログ

フィード投稿

コメントの通報

GIF

ハッシュタグ

モデレーション

モデレーター

通知数

通知

ページリアクション

ページ

保留中のWebhookイベント

質問設定

質問結果

質問結果の集計

SSOユーザー

サブスクリプション

テナントの日次使用量

テナントパッケージ

テナントユーザー

テナント

チケット

翻訳

画像アップロード

ユーザーバッジ進捗

ユーザーバッジ

ユーザーの通知

ユーザー在席ステータス

ユーザー検索

ユーザー

投票

FastComments PHP SDK

リポジトリ

インストールと使用方法

要件

Composer

手動インストール

はじめに

API クライアント

PublicApi の使用

ModerationApi の使用

API メソッド

モデル

認可

api_key

作成者

集計

パラメータ

応答

例

監査ログを取得

パラメータ

レスポンス

例

公開ログアウト

レスポンス

例

コメントからブロック

Parameters

Response

Example

公開コメントのブロック解除

Parameters

Response

Example

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

パラメータ