FastComments PHP SDK
これは FastComments の公式 PHP SDK です。
FastComments API 用の公式 PHP SDK
リポジトリ
AI コーディングエージェント 
FastComments のコンテキスト（ウィジェット、設定、Secure SSO、REST API、SDK）をコーディングエージェントに提供します:
npx skills add fastcomments/skillsClaude Code、Codex、Cursor、Copilot、Gemini、そして他のすべてのエージェントで、skills CLI がサポートされています。
インストールと使用方法
要件
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 | Description |
|---|---|---|---|
| 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 |
モデル
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponseAnyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchMatchedOnValue
- BannedUserMatchType
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponseResultsInner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
- DeleteHashTagRequestBody
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponseAnyOf
- GetDomainConfigsResponseAnyOf1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplatesResponse
- GetEventLogResponse
- GetFeedPostsResponse
- GetGifsSearchResponse
- GetGifsTrendingResponse
- GetHashTagsResponse
- GetModeratorResponse
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetPublicPagesResponse
- GetQuestionConfigResponse
- GetQuestionConfigsResponse
- GetQuestionResultResponse
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsersResponse
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantManualBadgesResponse
- GetTenantPackageResponse
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUsersResponse
- GetTenantsResponse
- GetTicketResponse
- GetTicketsResponse
- GetTranslationsResponse
- GetUserInternalProfileResponse
- GetUserInternalProfileResponseProfile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponseImagesInnerInner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- ModerationAPIChildCommentsResponse
- ModerationAPIComment
- ModerationAPICommentLog
- ModerationAPICommentResponse
- ModerationAPICountCommentsResponse
- ModerationAPIGetCommentIdsResponse
- ModerationAPIGetCommentsResponse
- ModerationAPIGetLogsResponse
- ModerationCommentSearchResponse
- ModerationExportResponse
- ModerationExportStatusResponse
- ModerationFilter
- ModerationPageSearchProjected
- ModerationPageSearchResponse
- ModerationSiteSearchProjected
- ModerationSiteSearchResponse
- ModerationSuggestResponse
- ModerationUserSearchProjected
- ModerationUserSearchResponse
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PageUserEntry
- PageUsersInfoResponse
- PageUsersOfflineResponse
- PageUsersOnlineResponse
- PagesSortBy
- PatchDomainConfigParams
- PatchDomainConfigResponse
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PostRemoveCommentResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveCommentResponseOptimized
- SaveCommentsBulkResponse
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsersResult
- SearchUsersSectionedResponse
- SetCommentApprovedResponse
- SetCommentTextParams
- SetCommentTextResponse
- SetCommentTextResult
- SetUserTrustFactorResponse
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantBadge
- TenantHashTag
- TenantPackage
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadgeParams
- UpdateUserNotificationCommentSubscriptionStatusResponse
- UpdateUserNotificationPageSubscriptionStatusResponse
- UpdateUserNotificationStatusResponse
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- UsersListLocation
- VoteBodyParams
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
認可
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 
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// APIキー認証を設定: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタムHTTPクライアントを使用したい場合、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
13 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
20$options = [
21 'parent_tenant_id' => 'parent_tenant_id_example', // string
22 'include_stats' => True, // bool
23];
24
25
26try {
27 $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
31}
32
取得監査ログ
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ | |
| order | string | query | いいえ | |
| after | number | query | いいえ | |
| before | number | query | いいえ |
レスポンス
Returns: GetAuditLogsResponse
例
getAuditLogs の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$options = [
21 'limit' => 3.4, // 浮動小数点数
22 'skip' => 3.4, // 浮動小数点数
23 'order' => new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(), // \FastComments\Client\Model\SORTDIR
24 'after' => 3.4, // 浮動小数点数
25 'before' => 3.4, // 浮動小数点数
26];
27
28
29try {
30 $result = $apiInstance->getAuditLogs($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
34}
35
ログアウト（公開）
レスポンス
戻り値: APIEmptyResponse
例
logoutPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13
14
15try {
16 $result = $apiInstance->logoutPublic();
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->logoutPublic: ', $e->getMessage(), PHP_EOL;
20}
21
コメントからブロック（公開）
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
返却: BlockSuccess
Example
blockFromCommentPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25
コメントブロック解除（公開）
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
戻り値: UnblockSuccess
Example
unBlockCommentPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
16$sso = 'sso_example'; // 文字列
17
18
19try {
20 $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sss);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25
ブロック済みコメントのチェック
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentIds | string | query | はい | コメント ID のカンマ区切りリスト。 |
| sso | string | query | いいえ |
レスポンス
Returns: CheckBlockedCommentsResponse
例
checkedCommentsForBlocked の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_ids = 'comment_ids_example'; // 文字列 | コメント ID のカンマ区切りリスト。
15$sso = 'sso_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
23}
24
コメントからユーザーをブロック
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
戻り値: BlockSuccess
Example
blockUserFromComment 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
22$options = [
23 'user_id' => 'user_id_example', // string
24 'anon_user_id' => 'anon_user_id_example', // string
25];
26
27
28try {
29 $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34
コメント作成（公開）
パラメータ
| 名前 | 種類 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| sessionId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
Returns: SaveCommentsResponseWithPresence
例
createCommentPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$broadcast_id = 'broadcast_id_example'; // 文字列
16$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
17$options = [
18 'session_id' => 'session_id_example', // 文字列
19 'sso' => 'sso_example', // 文字列
20];
21
22
23try {
24 $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
28}
29
コメント削除
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| isLive | boolean | query | いいえ |
レスポンス
戻り値: DeleteCommentResult
例
deleteComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// APIキー認証を設定: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// 必要に応じて、以下のコメントアウトを解除してAPIキーのプレフィックス（例: Bearer）を設定します
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
13 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // 文字列
19$id = 'id_example'; // 文字列
20$options = [
21 'context_user_id' => 'context_user_id_example', // 文字列
22 'is_live' => True, // ブール
23];
24
25
26try {
27 $result = $apiInstance->deleteComment($tenant_id, $id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
31}
32
コメント削除（公開）
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
応答
戻り値: PublicAPIDeleteCommentResponse
例
deleteCommentPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$options = [
17 'edit_key' => 'edit_key_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
27}
28
コメント投票削除
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$vote_id = 'vote_id_example'; // string
16$url_id = 'url_id_example'; // string
17$broadcast_id = 'broadcast_id_example'; // string
18$options = [
19 'edit_key' => 'edit_key_example', // string
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
29}
30
コメント通報
パラメータ
| 名前 | タイプ | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
Returns: FlagCommentResponse
例
flagComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認可を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->flagComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
32}
33
コメント取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例
getComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外して APIキー のプレフィックス (例: Bearer) を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getComment($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
28}
29
コメント一覧取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 |
レスポンス
例
getComments の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを外して API キーのプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'page' => 56, // int
22 'limit' => 56, // int
23 'skip' => 56, // int
24 'as_tree' => True, // bool
25 'skip_children' => 56, // int
26 'limit_children' => 56, // int
27 'max_tree_depth' => 56, // int
28 'url_id' => 'url_id_example', // string
29 'user_id' => 'user_id_example', // string
30 'anon_user_id' => 'anon_user_id_example', // string
31 'context_user_id' => 'context_user_id_example', // string
32 'hash_tag' => 'hash_tag_example', // string
33 'parent_id' => 'parent_id_example', // string
34 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
35 'from_date' => 56, // int
36 'to_date' => 56, // int
37];
38
39
40try {
41 $result = $apiInstance->getComments($tenant_id, $options);
42 print_r($result);
43} catch (Exception $e) {
44 echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
45}
46
コメント一覧取得（公開）
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$options = [
16 'page' => 56, // 整数
17 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
18 'sso' => 'sso_example', // 文字列
19 'skip' => 56, // 整数
20 'skip_children' => 56, // 整数
21 'limit' => 56, // 整数
22 'limit_children' => 56, // 整数
23 'count_children' => True, // ブール
24 'fetch_page_for_comment_id' => 'fetch_page_for_comment_id_example', // 文字列
25 'include_config' => True, // ブール
26 'count_all' => True, // ブール
27 'includei10n' => True, // ブール
28 'locale' => 'locale_example', // 文字列
29 'modules' => 'modules_example', // 文字列
30 'is_crawler' => True, // ブール
31 'include_notification_count' => True, // ブール
32 'as_tree' => True, // ブール
33 'max_tree_depth' => 56, // 整数
34 'use_full_translation_ids' => True, // ブール
35 'parent_id' => 'parent_id_example', // 文字列
36 'search_text' => 'search_text_example', // 文字列
37 'hash_tags' => array('hash_tags_example'), // string[]
38 'user_id' => 'user_id_example', // 文字列
39 'custom_config_str' => 'custom_config_str_example', // 文字列
40 'after_comment_id' => 'after_comment_id_example', // 文字列
41 'before_comment_id' => 'before_comment_id_example', // 文字列
42];
43
44
45try {
46 $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $options);
47 print_r($result);
48} catch (Exception $e) {
49 echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
50}
51
コメントテキスト取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
応答
返り値: PublicAPIGetCommentTextResponse
例
getCommentText の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'edit_key' => 'edit_key_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->getCommentText($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
26}
27
コメント投票ユーザー名取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
レスポンス
Returns: GetCommentVoteUserNamesSuccessResponse
例
getCommentVoteUserNames 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$dir = 56; // int
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
24}
25
コメントロック
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
レスポンス
返却: APIEmptyResponse
例
lockComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
24}
25
コメント固定
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: ChangeCommentPinStatusResponse
例
pinComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$broadcast_id = 'broadcast_id_example'; // 文字列
16$sso = 'sso_example'; // 文字列
17
18
19try {
20 $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
24}
25
コメント保存
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
応答
Returns: APISaveCommentResponse
例
saveComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
21$options = [
22 'is_live' => True, // bool
23 'do_spam_check' => True, // bool
24 'send_emails' => True, // bool
25 'populate_notifications' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
34}
35
コメント一括保存
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
例
saveCommentsBulk の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
21$options = [
22 'is_live' => True, // bool
23 'do_spam_check' => True, // bool
24 'send_emails' => True, // bool
25 'populate_notifications' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
34}
35
コメントテキスト設定
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
レスポンス
返却: PublicAPISetCommentTextResponse
例
setCommentText の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
17$options = [
18 'edit_key' => 'edit_key_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
28}
29
コメントからユーザーのブロック解除
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
応答
返却: UnblockSuccess
例
unBlockUserFromComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
22$options = [
23 'user_id' => 'user_id_example', // 文字列
24 'anon_user_id' => 'anon_user_id_example', // 文字列
25];
26
27
28try {
29 $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34
コメント通報解除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: FlagCommentResponse
例
unFlagComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプリフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->unFlagComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
32}
33
コメントロック解除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: APIEmptyResponse
例
unLockComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
24}
25
コメント固定解除
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
Response
返却: ChangeCommentPinStatusResponse
Example
unPinComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
24}
25
コメント更新
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| isLive | boolean | query | いいえ |
応答
戻り値: APIEmptyResponse
例
updateComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$updatable_comment_params = new \FastComments\Client\Model\UpdatableCommentParams(); // \FastComments\Client\Model\UpdatableCommentParams
22$options = [
23 'context_user_id' => 'context_user_id_example', // string
24 'do_spam_check' => True, // bool
25 'is_live' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->updateComment($tenant_id, $id, $updatable_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
34}
35
コメント投票
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$url_id = 'url_id_example'; // string
16$broadcast_id = 'broadcast_id_example'; // string
17$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
18$options = [
19 'session_id' => 'session_id_example', // string
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
29}
30
ユーザーのコメント取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$options = [
14 'user_id' => 'user_id_example', // string
15 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
16 'replies_to_user_id' => 'replies_to_user_id_example', // string
17 'page' => 3.4, // float
18 'includei10n' => True, // bool
19 'locale' => 'locale_example', // string
20 'is_crawler' => True, // bool
21];
22
23
24try {
25 $result = $apiInstance->getCommentsForUser($options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->getCommentsForUser: ', $e->getMessage(), PHP_EOL;
29}
30
ドメイン設定追加
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例
addDomainConfig の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
21
22
23try {
24 $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
28}
29
ドメイン設定削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
レスポンス
戻り値: DeleteDomainConfigResponse
例
deleteDomainConfig の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// APIキー認証を設定: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// 必要に応じて、以下のコメントを外してAPIキーのプレフィックス（例: Bearer）を設定してください
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // これはオプショナルです。デフォルトでは `GuzzleHttp\Client` が使用されます。
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23// 文字列
24$domain = 'domain_example'; // string
25// 文字列
26
27
28try {
29 $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
33}
34
ドメイン設定取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
レスポンス
例
getDomainConfig の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// APIキー認証を設定: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// 必要に応じて、以下のコメントアウトを解除して API キーのプレフィックス（例: Bearer）を設定します
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
19 new GuzzleHttp\Client(),
20 $config
21);
22
23$tenant_id = 'tenant_id_example'; // string
24$domain = 'domain_example'; // string
25
26
27try {
28 $result = $apiInstance->getDomainConfig($tenant_id, $domain);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
32}
33
ドメイン設定一覧取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例
getDomainConfigs の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20
21
22try {
23 $result = $apiInstance->getDomainConfigs($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
27}
28
ドメイン設定パッチ
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
応答
例
patchDomainConfig の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は下記のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$domain_to_update = 'domain_to_update_example'; // string
21$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
22
23
24try {
25 $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
29}
30
ドメイン設定更新
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
例
putDomainConfig の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7// 必要なら、以下のコメントのコメントアウトを解除し、APIキーのプレフィックス (例: Bearer) を設定
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
13 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$domain_to_update = 'domain_to_update_example'; // string
20$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
21
22
23try {
24 $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
28}
29
メールテンプレート作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却: CreateEmailTemplateResponse
例
createEmailTemplate の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定します: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
21
22
23try {
24 $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
メールテンプレート削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
応答
返却: APIEmptyResponse
例
deleteEmailTemplate の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
メールテンプレートレンダーエラー削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例
deleteEmailTemplateRenderError の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$error_id = 'error_id_example'; // 文字列
22
23
24try {
25 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
29}
30
メールテンプレート取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
応答
例
getEmailTemplate 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getEmailTemplate($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
メールテンプレート定義取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
返却: GetEmailTemplateDefinitionsResponse
例
getEmailTemplateDefinitions の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを解除して API キーのプレフィックス (例: Bearer) を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20
21
22try {
23 $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
27}
28
メールテンプレートレンダーエラー取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| skip | number | query | いいえ |
応答
返り値: GetEmailTemplateRenderErrorsResponse
例
getEmailTemplateRenderErrors 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$skip = 3.4; // 浮動小数点数
22
23
24try {
25 $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
29}
30
メールテンプレート一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
レスポンス
例
getEmailTemplates 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを外してAPIキーのプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$skip = 3.4; // 浮動小数点数
21
22
23try {
24 $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
28}
29
メールテンプレートレンダー
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| locale | string | クエリ | いいえ |
レスポンス
返却: RenderEmailTemplateResponse
例
renderEmailTemplate の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証の設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
21$locale = 'locale_example'; // string
22
23
24try {
25 $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
29}
30
メールテンプレート更新
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例
updateEmailTemplate の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、下記のコメントを解除して APIキーのプレフィックス（例: Bearer）を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_email_template_body = new \FastComments\Client\Model\UpdateEmailTemplateBody(); // \FastComments\Client\Model\UpdateEmailTemplateBody
22
23
24try {
25 $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
29}
30
イベントログ取得
リクエスト tenantId urlId userIdWS
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | いいえ |
レスポンス
例
getEventLog の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$user_id_ws = 'user_id_ws_example'; // 文字列
16$start_time = 56; // int
17$end_time = 56; // int
18
19
20try {
21 $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
25}
26
全体イベントログ取得
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$user_id_ws = 'user_id_ws_example'; // 文字列
16$start_time = 56; // 整数
17$end_time = 56; // 整数
18
19
20try {
21 $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
25}
26
フィード投稿作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
レスポンス
例
createFeedPost の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
21$options = [
22 'broadcast_id' => 'broadcast_id_example', // string
23 'is_live' => True, // bool
24 'do_spam_check' => True, // bool
25 'skip_dup_check' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
34}
35
フィード投稿作成（公開）
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
例
createFeedPostPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
26}
27
フィード投稿削除（公開）
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
Returns: DeleteFeedPostPublicResponse
例
deleteFeedPostPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
26}
27
フィード投稿取得
req tenantId afterId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
レスポンス
例
getFeedPosts の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'after_id' => 'after_id_example', // string
22 'limit' => 56, // int
23 'tags' => array('tags_example'), // string[]
24];
25
26
27try {
28 $result = $apiInstance->getFeedPosts($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
32}
33
フィード投稿取得（公開）
req tenantId afterId
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ | |
| sso | string | query | いいえ | |
| isCrawler | boolean | query | いいえ | |
| includeUserInfo | boolean | query | いいえ |
レスポンス
例
getFeedPostsPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'after_id' => 'after_id_example', // 文字列
16 'limit' => 56, // 整数
17 'tags' => array('tags_example'), // 文字列配列
18 'sso' => 'sso_example', // 文字列
19 'is_crawler' => True, // ブール
20 'include_user_info' => True, // ブール
21];
22
23
24try {
25 $result = $apiInstance->getFeedPostsPublic($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
29}
30
フィード投稿統計取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | Yes | |
| sso | string | query | No |
応答
例
getFeedPostsStats の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡します。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_ids = array('post_ids_example'); // string[]
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
23}
24
ユーザーリアクション取得（公開）
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | |
| postIds | array | クエリ | いいえ | |
| sso | string | クエリ | いいえ |
応答
戻り値: UserReactsResponse
例
getUserReactsPublic 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'post_ids' => array('post_ids_example'), // string[]
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getUserReactsPublic($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
25}
26
フィード投稿にリアクション（公開）
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
例
reactFeedPostPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$post_id = 'post_id_example'; // 文字列
15$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
16$options = [
17 'is_undo' => True, // ブール
18 'broadcast_id' => 'broadcast_id_example', // 文字列
19 'sso' => 'sso_example', // 文字列
20];
21
22
23try {
24 $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
28}
29
フィード投稿更新
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返り値: APIEmptyResponse
例
updateFeedPost 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを解除して API キーのプレフィックス (例: Bearer) を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
22
23
24try {
25 $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
29}
30
フィード投稿更新（公開）
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
例
updateFeedPostPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
27}
28
コメント通報（公開）
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
レスポンス
Returns: APIEmptyResponse
例
flagCommentPublic の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$is_flagged = True; // 真偽値
16$sso = 'sso_example'; // 文字列
17
18
19try {
20 $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25
大きいGIF取得
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| largeInternalURLSanitized | string | query | はい |
Response
返り値: GifGetLargeResponse
Example
getGifLarge の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$large_internal_url_sanitized = 'large_internal_url_sanitized_example'; // string
15
16
17try {
18 $result = $apiInstance->getGifLarge($tenant_id, $large_internal_url_sanitized);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getGifLarge: ', $e->getMessage(), PHP_EOL;
22}
23
GIF検索取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| search | string | query | はい | |
| locale | string | query | いいえ | |
| rating | string | query | いいえ | |
| page | number | query | いいえ |
応答
例
getGifsSearch の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$search = 'search_example'; // string
15$options = [
16 'locale' => 'locale_example', // string
17 'rating' => 'rating_example', // string
18 'page' => 3.4, // float
19];
20
21
22try {
23 $result = $apiInstance->getGifsSearch($tenant_id, $search, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->getGifsSearch: ', $e->getMessage(), PHP_EOL;
27}
28
トレンドGIF取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
レスポンス
例
getGifsTrending の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'locale' => 'locale_example', // 文字列
16 'rating' => 'rating_example', // 文字列
17 'page' => 3.4, // 浮動小数点数
18];
19
20
21try {
22 $result = $apiInstance->getGifsTrending($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getGifsTrending: ', $e->getMessage(), PHP_EOL;
26}
27
ハッシュタグ追加
パラメータ
| 名前 | 種類 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例
addHashTag の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
21
22
23try {
24 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
28}
29
ハッシュタグ一括追加
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
返却: BulkCreateHashTagsResponse
Example
addHashTagsBulk の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// API キー認証を設定: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
13 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // 文字列
19$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
20
21
22try {
23 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
27}
28
ハッシュタグ削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| tag | string | path | はい |
応答
返却: APIEmptyResponse
例
deleteHashTag の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定する場合は以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$tag = 'tag_example'; // string
21$delete_hash_tag_request_body = new \FastComments\Client\Model\DeleteHashTagRequestBody(); // \FastComments\Client\Model\DeleteHashTagRequestBody
22
23
24try {
25 $result = $apiInstance->deleteHashTag($tenant_id, $tag, $delete_hash_tag_request_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'DefaultApi->deleteHashTag の呼び出し時の例外: ', $e->getMessage(), PHP_EOL;
29}
30
ハッシュタグ取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| page | number | query | いいえ |
レスポンス
例
getHashTags の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$page = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getHashTags($tenant_id, $page);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
28}
29
ハッシュタグパッチ
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| tag | string | パス | はい |
応答
Returns: UpdateHashTagResponse
例
patchHashTag の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定するには、下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$tag = 'tag_example'; // string
21$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
22
23
24try {
25 $result = $apiInstance->patchHashTag($tenant_id, $tag, $update_hash_tag_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
29}
30
モデレーション投票削除
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
戻り値: VoteDeleteResponse
例
deleteModerationVote の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$vote_id = 'vote_id_example'; // 文字列
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // 文字列
18 'sso' => 'sso_example', // 文字列
19];
20
21
22try {
23 $result = $apiInstance->deleteModerationVote($tenant_id, $comment_id, $vote_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->deleteModerationVote: ', $e->getMessage(), PHP_EOL;
27}
28
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'page' => 3.4, // float
16 'count' => 3.4, // float
17 'text_search' => 'text_search_example', // string
18 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
19 'filters' => 'filters_example', // string
20 'search_filters' => 'search_filters_example', // string
21 'sorts' => 'sorts_example', // string
22 'demo' => True, // bool
23 'sso' => 'sso_example', // string
24];
25
26
27try {
28 $result = $apiInstance->getApiComments($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling ModerationApi->getApiComments: ', $e->getMessage(), PHP_EOL;
32}
33
APIエクスポートステータス取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: ModerationExportStatusResponse
例
getApiExportStatus の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'batch_job_id' => 'batch_job_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getApiExportStatus($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getApiExportStatus: ', $e->getMessage(), PHP_EOL;
25}
26
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
17 'filters' => 'filters_example', // string
18 'search_filters' => 'search_filters_example', // string
19 'after_id' => 'after_id_example', // string
20 'demo' => True, // bool
21 'sso' => 'sso_example', // string
22];
23
24
25try {
26 $result = $apiInstance->getApiIds($tenant_id, $options);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling ModerationApi->getApiIds: ', $e->getMessage(), PHP_EOL;
30}
31
コメントからのユーザーバン取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
応答
戻り値: GetBannedUsersFromCommentResponse
例
getBanUsersFromComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$sso = 'sso_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->getBanUsersFromComment($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getBanUsersFromComment: ', $e->getMessage(), PHP_EOL;
23}
24
コメントバンステータス取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
レスポンス
返却: GetCommentBanStatusResponse
例
getCommentBanStatus の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡します。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$sso = 'sso_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->getCommentBanStatus($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getCommentBanStatus: ', $e->getMessage(), PHP_EOL;
23}
24
コメント子取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
応答
返り値: ModerationAPIChildCommentsResponse
例
getCommentChildren の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getCommentChildren($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getCommentChildren: ', $e->getMessage(), PHP_EOL;
23}
24
カウント取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'text_search' => 'text_search_example', // 文字列
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // 文字列
17 'filter' => 'filter_example', // 文字列
18 'search_filters' => 'search_filters_example', // 文字列
19 'demo' => True, // ブール
20 'sso' => 'sso_example', // 文字列
21];
22
23
24try {
25 $result = $apiInstance->getCount($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
29}
30
カウント一覧取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: GetBannedUsersCountResponse
例
getCounts の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getCounts($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getCounts: ', $e->getMessage(), PHP_EOL;
22}
23
ログ取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationAPIGetLogsResponse
例
getLogs の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$sso = 'sso_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->getLogs($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getLogs: ', $e->getMessage(), PHP_EOL;
23}
24
手動バッジ取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: GetTenantManualBadgesResponse
例
getManualBadges の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getManualBadges($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getManualBadges: ', $e->getMessage(), PHP_EOL;
22}
23
ユーザーの手動バッジ取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
応答
Returns: GetUserManualBadgesResponse
例
getManualBadgesForUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'badges_user_id' => 'badges_user_id_example', // 文字列
16 'comment_id' => 'comment_id_example', // 文字列
17 'sso' => 'sso_example', // 文字列
18];
19
20
21try {
22 $result = $apiInstance->getManualBadgesForUser($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->getManualBadgesForUser: ', $e->getMessage(), PHP_EOL;
26}
27
モデレーションコメント取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
レスポンス
返り値: ModerationAPICommentResponse
例
getModerationComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$options = [
16 'include_email' => True, // ブール
17 'include_ip' => True, // ブール
18 'sso' => 'sso_example', // 文字列
19];
20
21
22try {
23 $result = $apiInstance->getModerationComment($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->getModerationComment: ', $e->getMessage(), PHP_EOL;
27}
28
モデレーションコメントテキスト取得
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Example
getModerationCommentText の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$sso = 'sso_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->getModerationCommentText($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getModerationCommentText: ', $e->getMessage(), PHP_EOL;
23}
24
事前バン概要取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$options = [
16 'include_by_user_id_and_email' => True, // 真偽値
17 'include_by_ip' => True, // 真偽値
18 'include_by_email_domain' => True, // 真偽値
19 'sso' => 'sso_example', // 文字列
20];
21
22
23try {
24 $result = $apiInstance->getPreBanSummary($tenant_id, $comment_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->getPreBanSummary: ', $e->getMessage(), PHP_EOL;
28}
29
コメント検索概要取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: ModerationCommentSearchResponse
例
getSearchCommentsSummary の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'filters' => 'filters_example', // string
17 'search_filters' => 'search_filters_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->getSearchCommentsSummary($tenant_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->getSearchCommentsSummary: ', $e->getMessage(), PHP_EOL;
27}
28
ページ検索取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| value | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: ModerationPageSearchResponse
例
getSearchPages の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchPages($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchPages: ', $e->getMessage(), PHP_EOL;
25}
26
サイト検索取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
レスポンス
返却: ModerationSiteSearchResponse
例
getSearchSites の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'value' => 'value_example', // 文字列
16 'sso' => 'sso_example', // 文字列
17];
18
19
20try {
21 $result = $apiInstance->getSearchSites($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchSites: ', $e->getMessage(), PHP_EOL;
25}
26
検索サジェスト取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| text-search | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例
getSearchSuggest の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchSuggest($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchSuggest: ', $e->getMessage(), PHP_EOL;
25}
26
ユーザー検索取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| value | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: ModerationUserSearchResponse
例
getSearchUsers の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchUsers($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchUsers: ', $e->getMessage(), PHP_EOL;
25}
26
信頼度取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: GetUserTrustFactorResponse
例
getTrustFactor の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // 省略可能です。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'user_id' => 'user_id_example', // 文字列
16 'sso' => 'sso_example', // 文字列
17];
18
19
20try {
21 $result = $apiInstance->getTrustFactor($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getTrustFactor: ', $e->getMessage(), PHP_EOL;
25}
26
ユーザーバン設定取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: APIModerateGetUserBanPreferencesResponse
例
getUserBanPreference の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$sso = 'sso_example'; // 文字列
15
16
17try {
18 $result = $apiInstance->getUserBanPreference($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getUserBanPreference: ', $e->getMessage(), PHP_EOL;
22}
23
ユーザー内部プロファイル取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: GetUserInternalProfileResponse
例
getUserInternalProfile の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これは任意で、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'comment_id' => 'comment_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getUserInternalProfile($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getUserInternalProfile: ', $e->getMessage(), PHP_EOL;
25}
26
コメント投票調整
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| commentId | string | パス | はい | |
| broadcastId | string | クエリ | いいえ | |
| sso | string | クエリ | いいえ |
レスポンス
例
postAdjustCommentVotes の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$adjust_comment_votes_params = new \FastComments\Client\Model\AdjustCommentVotesParams(); // \FastComments\Client\Model\AdjustCommentVotesParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // 文字列
18 'sso' => 'sso_example', // 文字列
19];
20
21
22try {
23 $result = $apiInstance->postAdjustCommentVotes($tenant_id, $comment_id, $adjust_comment_votes_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postAdjustCommentVotes: ', $e->getMessage(), PHP_EOL;
27}
28
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 |
レスポンス
例
postApiExport の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'text_search' => 'text_search_example', // 文字列
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // 文字列
17 'filters' => 'filters_example', // 文字列
18 'search_filters' => 'search_filters_example', // 文字列
19 'sorts' => 'sorts_example', // 文字列
20 'sso' => 'sso_example', // 文字列
21];
22
23
24try {
25 $result = $apiInstance->postApiExport($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling ModerationApi->postApiExport: ', $e->getMessage(), PHP_EOL;
29}
30
コメントからユーザーをバン
パラメーター
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 | いいえ |
応答
例
postBanUserFromComment 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$options = [
16 'ban_email' => True, // ブール
17 'ban_email_domain' => True, // ブール
18 'ban_ip' => True, // ブール
19 'delete_all_users_comments' => True, // ブール
20 'banned_until' => 'banned_until_example', // 文字列
21 'is_shadow_ban' => True, // ブール
22 'update_id' => 'update_id_example', // 文字列
23 'ban_reason' => 'ban_reason_example', // 文字列
24 'sso' => 'sso_example', // 文字列
25];
26
27
28try {
29 $result = $apiInstance->postBanUserFromComment($tenant_id, $comment_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling ModerationApi->postBanUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34
ユーザーバン取り消し
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例
postBanUserUndo の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$ban_user_undo_params = new \FastComments\Client\Model\BanUserUndoParams(); // \FastComments\Client\Model\BanUserUndoParams
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->postBanUserUndo($tenant_id, $ban_user_undo_params, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->postBanUserUndo: ', $e->getMessage(), PHP_EOL;
23}
24
一括事前バン概要
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
レスポンス
返り値: BulkPreBanSummary
例
postBulkPreBanSummary の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$bulk_pre_ban_params = new \FastComments\Client\Model\BulkPreBanParams(); // \FastComments\Client\Model\BulkPreBanParams
15$options = [
16 'include_by_user_id_and_email' => True, // bool
17 'include_by_ip' => True, // bool
18 'include_by_email_domain' => True, // bool
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->postBulkPreBanSummary($tenant_id, $bulk_pre_ban_params, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->postBulkPreBanSummary: ', $e->getMessage(), PHP_EOL;
28}
29
IDでコメント取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| sso | string | クエリ | いいえ |
応答
Returns: ModerationAPIChildCommentsResponse
例
postCommentsByIds 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comments_by_ids_params = new \FastComments\Client\Model\CommentsByIdsParams(); // \FastComments\Client\Model\CommentsByIdsParams
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->postCommentsByIds($tenant_id, $comments_by_ids_params, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->postCommentsByIds: ', $e->getMessage(), PHP_EOL;
23}
24
コメント通報
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
Response
返却: APIEmptyResponse
Example
postFlagComment 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postFlagComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postFlagComment: ', $e->getMessage(), PHP_EOL;
26}
27
コメント削除
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: PostRemoveCommentApiResponse
例
postRemoveComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postRemoveComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postRemoveComment: ', $e->getMessage(), PHP_EOL;
26}
27
削除コメント復元
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
返り値: APIEmptyResponse
例
postRestoreDeletedComment 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // 文字列
17 'sso' => 'sso_example', // 文字列
18];
19
20
21try {
22 $result = $apiInstance->postRestoreDeletedComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postRestoreDeletedComment: ', $e->getMessage(), PHP_EOL;
26}
27
コメント承認ステータス設定
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| approved | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: SetCommentApprovedResponse
例
postSetCommentApprovalStatus の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'approved' => True, // bool
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentApprovalStatus($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentApprovalStatus: ', $e->getMessage(), PHP_EOL;
27}
28
コメントレビュー状態設定
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
返却: APIEmptyResponse
例
postSetCommentReviewStatus の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡します。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$options = [
16 'reviewed' => True, // ブール
17 'broadcast_id' => 'broadcast_id_example', // 文字列
18 'sso' => 'sso_example', // 文字列
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentReviewStatus($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentReviewStatus: ', $e->getMessage(), PHP_EOL;
27}
28
コメントスパム状態設定
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'spam' => True, // bool
17 'perm_not_spam' => True, // bool
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->postSetCommentSpamStatus($tenant_id, $comment_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->postSetCommentSpamStatus: ', $e->getMessage(), PHP_EOL;
28}
29
コメントテキスト設定
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例
postSetCommentText 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$comment_id = 'comment_id_example'; // 文字列
15$set_comment_text_params = new \FastComments\Client\Model\SetCommentTextParams(); // \FastComments\Client\Model\SetCommentTextParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // 文字列
18 'sso' => 'sso_example', // 文字列
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentText($tenant_id, $comment_id, $set_comment_text_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'ModerationApi->postSetCommentText の呼び出し時の例外: ', $e->getMessage(), PHP_EOL;
27}
28
コメント通報解除
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: APIEmptyResponse
Example
postUnFlagComment の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postUnFlagComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postUnFlagComment: ', $e->getMessage(), PHP_EOL;
26}
27
投票実行
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: VoteResponse
例
postVote の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'direction' => 'direction_example', // string
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postVote($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postVote: ', $e->getMessage(), PHP_EOL;
27}
28
バッジ付与
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| badgeId | string | query | はい | |
| userId | string | query | いいえ | |
| commentId | string | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例
putAwardBadge 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$badge_id = 'badge_id_example'; // string
15$options = [
16 'user_id' => 'user_id_example', // string
17 'comment_id' => 'comment_id_example', // string
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->putAwardBadge($tenant_id, $badge_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->putAwardBadge: ', $e->getMessage(), PHP_EOL;
28}
29
スレッド閉鎖
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| sso | string | query | いいえ |
応答
返却: APIEmptyResponse
例
putCloseThread の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$sso = 'sso_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->putCloseThread($tenant_id, $url_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->putCloseThread: ', $e->getMessage(), PHP_EOL;
23}
24
バッジ削除
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例
putRemoveBadge の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$badge_id = 'badge_id_example'; // string
15$options = [
16 'user_id' => 'user_id_example', // string
17 'comment_id' => 'comment_id_example', // string
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->putRemoveBadge($tenant_id, $badge_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->putRemoveBadge: ', $e->getMessage(), PHP_EOL;
28}
29
スレッド再開
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| sso | string | query | いいえ |
応答
返却: APIEmptyResponse
例
putReopenThread の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$sso = 'sso_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->putReopenThread($tenant_id, $url_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->putReopenThread: ', $e->getMessage(), PHP_EOL;
23}
24
信頼度設定
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: SetUserTrustFactorResponse
例
setTrustFactor の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
8// これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
9$apiInstance = new FastComments\Client\Api\ModerationApi(
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'user_id' => 'user_id_example', // string
16 'trust_factor' => 'trust_factor_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->setTrustFactor($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->setTrustFactor: ', $e->getMessage(), PHP_EOL;
26}
27
モデレーター作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例
createModerator の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証の設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
21
22
23try {
24 $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
28}
29
モデレーター削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sendEmail | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例
deleteModerator の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて下のコメントを外し、APIキーのプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$send_email = 'send_email_example'; // 文字列
22
23
24try {
25 $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
29}
30
モデレーター取得
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
Response
戻り値: GetModeratorResponse
Example
getModerator の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->getModerator($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
28}
29
モデレーター一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
レスポンス
例
getModerators の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$skip = 3.4; // 浮動小数点
21
22
23try {
24 $result = $apiInstance->getModerators($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
28}
29
招待送信
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| fromName | string | query | はい |
応答
返却: APIEmptyResponse
例
sendInvite の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$from_name = 'from_name_example'; // string
22
23
24try {
25 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
29}
30
モデレーター更新
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
返却: APIEmptyResponse
例
updateModerator の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// APIキー認証を設定: api_key
6// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
12 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // 文字列
18$id = 'id_example'; // 文字列
19$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
20
21
22try {
23 $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
27}
28
通知カウント削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
応答
返却: APIEmptyResponse
例
deleteNotificationCount の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
28}
29
キャッシュ通知カウント取得
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
返り値: GetCachedNotificationCountResponse
例
getCachedNotificationCount の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、下のコメントアウトを解除して APIキーのプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
28}
29
通知カウント取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認可を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$options = [
21 'user_id' => 'user_id_example', // 文字列
22 'url_id' => 'url_id_example', // 文字列
23 'from_comment_id' => 'from_comment_id_example', // 文字列
24 'viewed' => True, // ブール
25 'type' => 'type_example', // 文字列
26];
27
28
29try {
30 $result = $apiInstance->getNotificationCount($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
34}
35
通知取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ | |
| skip | number | query | いいえ |
応答
例
getNotifications の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認可を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // 文字列
22 'url_id' => 'url_id_example', // 文字列
23 'from_comment_id' => 'from_comment_id_example', // 文字列
24 'viewed' => True, // ブール
25 'type' => 'type_example', // 文字列
26 'skip' => 3.4, // 浮動小数点
27];
28
29
30try {
31 $result = $apiInstance->getNotifications($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
35}
36
通知更新
パラメータ
| 名前 | タイプ | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
レスポンス
返却: APIEmptyResponse
例
updateNotification の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// API キー認証を設定: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// 必要に応じて下の行のコメントを外し、プレフィックス（例: Bearer）を設定します
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // 省略可能です。デフォルトでは `GuzzleHttp\Client` が使用されます。
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // 文字列
23$id = 'id_example'; // 文字列
24$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
25$user_id = 'user_id_example'; // 文字列
26
27
28try {
29 $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
33}
34
V1ページリアクト作成
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| title | string | query | いいえ |
レスポンス
Returns: CreateV1PageReact
例
createV1PageReact 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$title = 'title_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->createV1PageReact($tenant_id, $url_id, $title);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->createV1PageReact: ', $e->getMessage(), PHP_EOL;
23}
24
V2ページリアクト作成
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No |
レスポンス
戻り値: CreateV1PageReact
例
createV2PageReact の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$id = 'id_example'; // 文字列
16$title = 'title_example'; // 文字列
17
18
19try {
20 $result = $apiInstance->createV2PageReact($tenant_id, $url_id, $id, $title);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->createV2PageReact: ', $e->getMessage(), PHP_EOL;
24}
25
V1ページリアクト削除
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい |
レスポンス
例
deleteV1PageReact の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15
16
17try {
18 $result = $apiInstance->deleteV1PageReact($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->deleteV1PageReact: ', $e->getMessage(), PHP_EOL;
22}
23
V2ページリアクト削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
レスポンス
戻り値: CreateV1PageReact
例
deleteV2PageReact 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$id = 'id_example'; // string
16
17
18try {
19 $result = $apiInstance->deleteV2PageReact($tenant_id, $url_id, $id);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->deleteV2PageReact: ', $e->getMessage(), PHP_EOL;
23}
24
V1ページいいね取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
応答
返却: GetV1PageLikes
例
getV1PageLikes の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15
16
17try {
18 $result = $apiInstance->getV1PageLikes($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getV1PageLikes: ', $e->getMessage(), PHP_EOL;
22}
23
V2ページリアクト取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
レスポンス
戻り値: GetV2PageReacts
例
getV2PageReacts 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15
16
17try {
18 $result = $apiInstance->getV2PageReacts($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getV2PageReacts: ', $e->getMessage(), PHP_EOL;
22}
23
V2ページリアクトユーザー取得
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Response
戻り値: GetV2PageReactUsersResponse
Example
getV2PageReactUsers の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id = 'url_id_example'; // 文字列
15$id = 'id_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->getV2PageReactUsers($tenant_id, $url_id, $id);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getV2PageReactUsers: ', $e->getMessage(), PHP_EOL;
23}
24
ページ追加
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
戻り値
戻り値: AddPageAPIResponse
例
addPage の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
21
22
23try {
24 $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
28}
29
ページ削除
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Example
deletePage の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// APIキー認証を設定: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
19 new GuzzleHttp\Client(),
20 $config
21);
22
23$tenant_id = 'tenant_id_example'; // string
24$id = 'id_example'; // string
25
26
27try {
28 $result = $apiInstance->deletePage($tenant_id, $id);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
32}
33
オフラインユーザー取得
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションです。デフォルトで `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | ページ URL 識別子（サーバー側でクリーンアップされたもの）。
15$options = [
16 'after_name' => 'after_name_example', // string | カーソル: 前回のレスポンスから `nextAfterName` を渡します。
17 'after_user_id' => 'after_user_id_example', // string | カーソルのタイブレーカー: 前回のレスポンスから `nextAfterUserId` を渡します。`afterName` が設定されている場合に必要で、名前が同じ場合にエントリが落ちないようにします。
18];
19
20
21try {
22 $result = $apiInstance->getOfflineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getOfflineUsers: ', $e->getMessage(), PHP_EOL;
26}
27
オンラインユーザー取得
現在ページをオンラインで閲覧しているユーザー: 現在、ウェブソケットセッションがそのページに購読されている人々。
返却: anonCount + totalCount（部屋全体の購読者数で、匿名ビューアーも含まれますが、列挙は行いません）。
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | ページ URL 識別子（サーバー側でクリーンアップされたもの）。 |
| afterName | string | query | No | カーソル: 前回のレスポンスから nextAfterName を渡す。 |
| afterUserId | string | query | No | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。 |
Response
Example
getOnlineUsers の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | ページ URL 識別子（サーバー側でクリーンアップされたもの）。
15$options = [
16 'after_name' => 'after_name_example', // string | カーソル: 前回のレスポンスから nextAfterName を渡す。
17 'after_user_id' => 'after_user_id_example', // string | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。
18];
19
20
21try {
22 $result = $apiInstance->getOnlineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getOnlineUsers: ', $e->getMessage(), PHP_EOL;
26}
27
URL IDでページ取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
レスポンス
戻り値: GetPageByURLIdAPIResponse
例
getPageByURLId の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外してプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
28}
29
ページ一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例
getPages 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20
21
22try {
23 $result = $apiInstance->getPages($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
27}
28
ページ一覧取得（公開）
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'cursor' => 'cursor_example', // string | 前回のリクエストで `nextCursor` として返された不透明なページネーションカーソル。同じ `sortBy` に関連付けられます。
16 'limit' => 56, // int | 1..200、デフォルトは 50
17 'q' => 'q_example', // string | オプションの大文字小文字を区別しないタイトルプレフィックスフィルタ。
18 'sort_by' => new \FastComments\Client\Model\\FastComments\Client\Model\PagesSortBy(), // \FastComments\Client\Model\PagesSortBy | ソート順。`updatedAt`（デフォルト、最新が最初）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
19 'has_comments' => True, // bool | true の場合、少なくとも1つのコメントがあるページのみを返します。
20];
21
22
23try {
24 $result = $apiInstance->getPagesPublic($tenant_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->getPagesPublic: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザー情報取得
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$ids = 'ids_example'; // 文字列 | カンマ区切りの userIds.
15
16
17try {
18 $result = $apiInstance->getUsersInfo($tenant_id, $ids);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getUsersInfo: ', $e->getMessage(), PHP_EOL;
22}
23
ページパッチ
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
応答
例
patchPage 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
22
23
24try {
25 $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
29}
30
保留中Webhookイベント削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例
deletePendingWebhookEvent の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを外してプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これは省略可能で、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
28}
29
保留中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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定します: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'comment_id' => 'comment_id_example', // string
22 'external_id' => 'external_id_example', // string
23 'event_type' => 'event_type_example', // string
24 'type' => 'type_example', // string
25 'domain' => 'domain_example', // string
26 'attempt_count_gt' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
35}
36
保留中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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、`GuzzleHttp\Client` がデフォルトで使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'comment_id' => 'comment_id_example', // string
22 'external_id' => 'external_id_example', // string
23 'event_type' => 'event_type_example', // string
24 'type' => 'type_example', // string
25 'domain' => 'domain_example', // string
26 'attempt_count_gt' => 3.4, // float
27 'skip' => 3.4, // float
28];
29
30
31try {
32 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $options);
33 print_r($result);
34} catch (Exception $e) {
35 echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
36}
37
質問設定作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却: CreateQuestionConfigResponse
例
createQuestionConfig 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを解除してプレフィックス (例: Bearer) を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
21
22
23try {
24 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29
質問設定削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
Returns: APIEmptyResponse
例
deleteQuestionConfig の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証の設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定する場合は、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29
質問設定取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetQuestionConfigResponse
例
getQuestionConfig の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getQuestionConfig($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29
質問設定一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
返り値: GetQuestionConfigsResponse
例
getQuestionConfigs の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$skip = 3.4; // 浮動小数点数
21
22
23try {
24 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
28}
29
質問設定更新
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
Returns: APIEmptyResponse
例
updateQuestionConfig 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$update_question_config_body = new \FastComments\Client\Model\UpdateQuestionConfigBody(); // \FastComments\Client\Model\UpdateQuestionConfigBody
22
23
24try {
25 $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
29}
30
質問結果作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
応答
返却: CreateQuestionResultResponse
例
createQuestionResult の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
13 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // 文字列
19$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
20
21
22try {
23 $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
27}
28
質問結果削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例
deleteQuestionResult の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29
質問結果取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
Returns: GetQuestionResultResponse
例
getQuestionResult の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合はコメントアウトを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getQuestionResult($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29
質問結果一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、コメントアウトを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$options = [
21 'url_id' => 'url_id_example', // 文字列
22 'user_id' => 'user_id_example', // 文字列
23 'start_date' => 'start_date_example', // 文字列
24 'question_id' => 'question_id_example', // 文字列
25 'question_ids' => 'question_ids_example', // 文字列
26 'skip' => 3.4, // 浮動小数点数
27];
28
29
30try {
31 $result = $apiInstance->getQuestionResults($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
35}
36
質問結果更新
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
応答
返却: APIEmptyResponse
例
updateQuestionResult の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
22
23
24try {
25 $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
29}
30
質問結果集計
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$options = [
21 'question_id' => 'question_id_example', // 文字列
22 'question_ids' => array('question_ids_example'), // 文字列[]
23 'url_id' => 'url_id_example', // 文字列
24 'time_bucket' => new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(), // \FastComments\Client\Model\AggregateTimeBucket
25 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
26 'force_recalculate' => True, // bool
27];
28
29
30try {
31 $result = $apiInstance->aggregateQuestionResults($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
35}
36
質問結果一括集計
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: BulkAggregateQuestionResultsResponse
例
bulkAggregateQuestionResults の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を構成: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを解除して API キーのプレフィックス（例：Bearer）を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
21$force_recalculate = True; // bool
22
23
24try {
25 $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
29}
30
コメントと質問結果の結合
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// APIキー認可の設定: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
13 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'question_id' => 'question_id_example', // string
21 'question_ids' => array('question_ids_example'), // string[]
22 'url_id' => 'url_id_example', // string
23 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
24 'force_recalculate' => True, // bool
25 'min_value' => 3.4, // float
26 'max_value' => 3.4, // float
27 'limit' => 3.4, // float
28];
29
30
31try {
32 $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $options);
33 print_r($result);
34} catch (Exception $e) {
35 echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
36}
37
SSOユーザー追加
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例
addSSOUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
21
22
23try {
24 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29
SSOユーザー削除
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | boolean | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
Response
Example
deleteSSOUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// API キー認証を設定: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は、以下のコメントを外す
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡します。
13 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$options = [
21 'delete_comments' => True, // bool
22 'comment_delete_mode' => 'comment_delete_mode_example', // string
23];
24
25
26try {
27 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
31}
32
メールでSSOユーザー取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| string | path | はい |
応答
戻り値: GetSSOUserByEmailAPIResponse
例
getSSOUserByEmail 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$email = 'email_example'; // string
21
22
23try {
24 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
28}
29
IDでSSOユーザー取得
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
例
getSSOUserById の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを解除して API キーのプレフィックス (例: Bearer) を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->getSSOUserById($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
28}
29
SSOユーザー一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | integer | query | いいえ |
レスポンス
戻り値: GetSSOUsersResponse
例
getSSOUsers 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 56; // int
21
22
23try {
24 $result = $apiInstance->getSSOUsers($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
28}
29
SSOユーザー更新
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
応答
例
patchSSOUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを解除してAPIキーのプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
22$update_comments = True; // bool
23
24
25try {
26 $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
30}
31
SSOユーザー設定
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
レスポンス
例
putSSOUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
22$update_comments = True; // bool
23
24
25try {
26 $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
30}
31
サブスクリプション作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
応答
返却: CreateSubscriptionAPIResponse
例
createSubscription 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを外してAPIキーのプレフィックス（例: Bearer）を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトで `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
21
22
23try {
24 $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
28}
29
サブスクリプション削除
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
返却: DeleteSubscriptionAPIResponse
例
deleteSubscription の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$user_id = 'user_id_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
29}
30
サブスクリプション取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ |
レスポンス
返却: GetSubscriptionsAPIResponse
例
getSubscriptions の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$user_id = 'user_id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
28}
29
サブスクリプション更新
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
レスポンス
返り値: UpdateSubscriptionAPIResponse
例
updateSubscription の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認可を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには、下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
22$user_id = 'user_id_example'; // string
23
24
25try {
26 $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
30}
31
テナント日次使用量取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
レスポンス
返却: GetTenantDailyUsagesResponse
例
getTenantDailyUsages の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'year_number' => 3.4, // float
22 'month_number' => 3.4, // float
23 'day_number' => 3.4, // float
24 'skip' => 3.4, // float
25];
26
27
28try {
29 $result = $apiInstance->getTenantDailyUsages($tenant_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
33}
34
テナントパッケージ作成
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却: CreateTenantPackageResponse
例
createTenantPackage 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
21
22
23try {
24 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29
テナントパッケージ削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
応答
返却: APIEmptyResponse
例
deleteTenantPackage の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// APIキー認証を設定: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタム HTTP クライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
13 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // 文字列
19$id = 'id_example'; // 文字列
20
21
22try {
23 $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28
テナントパッケージ取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例
getTenantPackage の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getTenantPackage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29
テナントパッケージ一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
例
getTenantPackages の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
13 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // 文字列
19$skip = 3.4; // 浮動小数点数
20
21
22try {
23 $result = $apiInstance->getTenantPackages($tenant_id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
27}
28
テナントパッケージ置換
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
返却: APIEmptyResponse
例
replaceTenantPackage の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
22
23
24try {
25 $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
29}
30
テナントパッケージ更新
パラメータ
| 名前 | 種類 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例
updateTenantPackage の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
22
23
24try {
25 $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
29}
30
テナントユーザー作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例
createTenantUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて以下のコメントを外してプレフィックス (例: Bearer) を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これは任意で、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
21
22
23try {
24 $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
テナントユーザー削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | string | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例
deleteTenantUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'delete_comments' => 'delete_comments_example', // string
23 'comment_delete_mode' => 'comment_delete_mode_example', // string
24];
25
26
27try {
28 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
32}
33
テナントユーザー取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例
getTenantUser 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定します: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス (例: Bearer) を設定するには、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これは任意で、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getTenantUser($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
テナントユーザー一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
レスポンス
例
getTenantUsers の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下の API キーのプレフィックス (例: Bearer) を設定するにはコメントを外します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getTenantUsers($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
28}
29
テナントユーザー置換
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
返り値: APIEmptyResponse
例
replaceTenantUser 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを外してAPIキーのプレフィックス（例: Bearer）を設定
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
22$update_comments = 'update_comments_example'; // string
23
24
25try {
26 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
30}
31
ログインリンク送信
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| redirectURL | string | query | いいえ |
応答
返却: APIEmptyResponse
例
sendLoginLink 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証の設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。`GuzzleHttp\Client` がデフォルトで使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$redirect_url = 'redirect_url_example'; // 文字列
22
23
24try {
25 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
29}
30
テナントユーザー更新
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
応答
返却: APIEmptyResponse
例
updateTenantUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを外して API キーのプレフィックス (例: Bearer) を設定します
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
22$update_comments = 'update_comments_example'; // 文字列
23
24
25try {
26 $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
30}
31
テナント作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
応答
戻り値: CreateTenantResponse
例
createTenant の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
21
22
23try {
24 $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
28}
29
テナント削除
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sure | string | query | いいえ |
応答
返却: APIEmptyResponse
例
deleteTenant の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は下の行のコメントを解除
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$sure = 'sure_example'; // 文字列
22
23
24try {
25 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
29}
30
テナント取得
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
Returns: GetTenantResponse
例
getTenant の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// APIキー認証を設定: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
10$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
19 new GuzzleHttp\Client(),
20 $config
21);
22
23$tenant_id = 'tenant_id_example'; // string
24$id = 'id_example'; // string
25
26
27try {
28 $result = $apiInstance->getTenant($tenant_id, $id);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
32}
33
テナント一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| meta | string | query | いいえ | |
| skip | number | query | いいえ |
応答
Returns: GetTenantsResponse
例
getTenants の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認可の設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$options = [
21 'meta' => 'meta_example', // 文字列
22 'skip' => 3.4, // 浮動小数点数
23];
24
25
26try {
27 $result = $apiInstance->getTenants($tenant_id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
31}
32
テナント更新
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
Response
戻り値: APIEmptyResponse
Example
updateTenant の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
22
23
24try {
25 $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
29}
30
チケット状態変更
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | はい | |
| id | string | path | はい |
レスポンス
例
changeTicketState の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントアウトを外してプレフィックス (例: Bearer) を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21$id = 'id_example'; // string
22$change_ticket_state_body = new \FastComments\Client\Model\ChangeTicketStateBody(); // \FastComments\Client\Model\ChangeTicketStateBody
23
24
25try {
26 $result = $apiInstance->changeTicketState($tenant_id, $user_id, $id, $change_ticket_state_body);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->changeTicketState: ', $e->getMessage(), PHP_EOL;
30}
31
チケット作成
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | はい |
レスポンス
例
createTicket の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー承認を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメント解除
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$user_id = 'user_id_example'; // 文字列
21$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
22
23
24try {
25 $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
29}
30
チケット取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
例
getTicket の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これは任意です。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21$user_id = 'user_id_example'; // 文字列
22
23
24try {
25 $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
29}
30
チケット一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| state | number | query | いいえ | |
| skip | number | query | いいえ | |
| limit | number | query | いいえ |
レスポンス
例
getTickets の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を構成: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下のコメントアウトを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$options = [
21 'user_id' => 'user_id_example', // 文字列
22 'state' => 3.4, // 浮動小数点数
23 'skip' => 3.4, // 浮動小数点数
24 'limit' => 3.4, // 浮動小数点数
25];
26
27
28try {
29 $result = $apiInstance->getTickets($tenant_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
33}
34
翻訳取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| namespace | string | path | はい | |
| component | string | path | はい | |
| locale | string | query | いいえ | |
| useFullTranslationIds | boolean | query | いいえ |
レスポンス
例
getTranslations 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$namespace = 'namespace_example'; // 文字列
14$component = 'component_example'; // 文字列
15$options = [
16 'locale' => 'locale_example', // 文字列
17 'use_full_translation_ids' => True, // ブール
18];
19
20
21try {
22 $result = $apiInstance->getTranslations($namespace, $component, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getTranslations: ', $e->getMessage(), PHP_EOL;
26}
27
画像アップロード
画像のアップロードとリサイズ
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成) |
| urlId | string | query | No | アップロードが行われているページ ID、設定用 |
応答
戻り値: UploadImageResponse
例
uploadImage の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$file = '/path/to/file.txt'; // \SplFileObject
15$options = [
16 'size_preset' => new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(), // \FastComments\Client\Model\SizePreset | サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成)
17 'url_id' => 'url_id_example', // string | アップロードが行われているページ ID、設定用
18];
19
20
21try {
22 $result = $apiInstance->uploadImage($tenant_id, $file, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
26}
27
IDでユーザーバッジ進捗取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却: APIGetUserBadgeProgressResponse
例
getUserBadgeProgressById の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は、以下のコメントを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$id = 'id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザーIDでバッジ進捗取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | path | はい |
レスポンス
返却: APIGetUserBadgeProgressResponse
例
getUserBadgeProgressByUserId の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、以下のコメントを解除して API キーのプレフィックス (例: Bearer) を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$user_id = 'user_id_example'; // 文字列
21
22
23try {
24 $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザーバッジ進捗一覧取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ |
応答
戻り値: APIGetUserBadgeProgressListResponse
例
getUserBadgeProgressList の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'limit' => 3.4, // float
23 'skip' => 3.4, // float
24];
25
26
27try {
28 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
32}
33
ユーザーバッジ作成
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却: APICreateUserBadgeResponse
例
createUserBadge 例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて API キーのプレフィックス (例: Bearer) を設定するには、以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、 `GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // 文字列
20$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
21
22
23try {
24 $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザーバッジ削除
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
Response
例
deleteUserBadge の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// 必要に応じて、以下のコメントを外してAPIキーのプレフィックス（例: Bearer）を設定してください
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
15 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
16 new GuzzleHttp\Client(),
17 $config
18);
19
20$tenant_id = 'tenant_id_example'; // string
21$id = 'id_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteUserBadge($tenant_id, $id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
29}
30
ユーザーバッジ取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例
getUserBadge の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用する場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトで `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getUserBadge($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザーバッジ一覧取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// API キー認証を設定: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// 必要に応じて、API キーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
10$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
19 new GuzzleHttp\Client(),
20 $config
21);
22
23$tenant_id = 'tenant_id_example'; // 文字列
24$options = [
25 'user_id' => 'user_id_example', // 文字列
26 'badge_id' => 'badge_id_example', // 文字列
27 'type' => 3.4, // 浮動小数点数
28 'displayed_on_comments' => True, // 真偽値
29 'limit' => 3.4, // 浮動小数点数
30 'skip' => 3.4, // 浮動小数点数
31];
32
33
34try {
35 $result = $apiInstance->getUserBadges($tenant_id, $options);
36 print_r($result);
37} catch (Exception $e) {
38 echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
39}
40
ユーザーバッジ更新
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例
updateUserBadge の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// APIキー認証を設定: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外す
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
13 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
21
22
23try {
24 $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザー通知カウント取得
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返り値: GetUserNotificationCountResponse
例
getUserNotificationCount の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタムの HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
22}
23
ユーザー通知取得
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'url_id' => 'url_id_example', // string | 現在のページが購読されているかどうかを判断するために使用されます。
16 'page_size' => 56, // int
17 'after_id' => 'after_id_example', // string
18 'include_context' => True, // bool
19 'after_created_at' => 56, // int
20 'unread_only' => True, // bool
21 'dm_only' => True, // bool
22 'no_dm' => True, // bool
23 'include_translations' => True, // bool
24 'include_tenant_notifications' => True, // bool
25 'sso' => 'sso_example', // string
26];
27
28
29try {
30 $result = $apiInstance->getUserNotifications($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
34}
35
ユーザー通知カウントリセット
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
応答
返却: ResetUserNotificationsResponse
例
resetUserNotificationCount の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
22}
23
ユーザー通知リセット
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$options = [
15 'after_id' => 'after_id_example', // 文字列
16 'after_created_at' => 56, // 整数
17 'unread_only' => True, // ブール
18 'dm_only' => True, // ブール
19 'no_dm' => True, // ブール
20 'sso' => 'sso_example', // 文字列
21];
22
23
24try {
25 $result = $apiInstance->resetUserNotifications($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
29}
30
コメント通知購読ステータス更新
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$notification_id = 'notification_id_example'; // string
15$opted_in_or_out = 'opted_in_or_out_example'; // string
16$comment_id = 'comment_id_example'; // string
17$sso = 'sso_example'; // string
18
19
20try {
21 $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
25}
26
ページ通知購読ステータス更新
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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$url = 'url_example'; // string
16$page_title = 'page_title_example'; // string
17$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
18$sso = 'sso_example'; // string
19
20
21try {
22 $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
26}
27
ユーザー通知ステータス更新
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
Response
返却: UpdateUserNotificationStatusResponse
Example
updateUserNotificationStatus の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // これはオプションで、デフォルトとして `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$notification_id = 'notification_id_example'; // string
15$new_status = 'new_status_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
24}
25
ユーザー在席状態取得
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlIdWS | string | query | はい | |
| userIds | string | query | はい |
応答
返り値: GetUserPresenceStatusesResponse
例
getUserPresenceStatuses の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装するクライアントを渡してください。
9 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // 文字列
14$url_id_ws = 'url_id_ws_example'; // 文字列
15$user_ids = 'user_ids_example'; // 文字列
16
17
18try {
19 $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
23}
24
ユーザー検索
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
9 // 省略可能で、デフォルトでは `GuzzleHttp\Client` が使用されます。
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$options = [
16 'username_starts_with' => 'username_starts_with_example', // string
17 'mention_group_ids' => array('mention_group_ids_example'), // string[]
18 'sso' => 'sso_example', // string
19 'search_section' => 'search_section_example', // string
20];
21
22
23try {
24 $result = $apiInstance->searchUsers($tenant_id, $url_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザー取得
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却: GetUserResponse
例
getUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキーの認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントアウトを外してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getUser($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
28}
29
投票作成
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | はい | |
| direction | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
返却: VoteResponse
例
createVote の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 必要に応じて以下の行のコメントを外し、APIキーのプレフィックス（例: Bearer）を設定してください
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$comment_id = 'comment_id_example'; // string
21$direction = 'direction_example'; // string
22$options = [
23 'user_id' => 'user_id_example', // string
24 'anon_user_id' => 'anon_user_id_example', // string
25];
26
27
28try {
29 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
33}
34
投票削除
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
応答
返り値: VoteDeleteResponse
例
deleteVote の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// APIキー認証を設定: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // カスタムHTTPクライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24$edit_key = 'edit_key_example'; // string
25
26
27try {
28 $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
32}
33
投票取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい |
レスポンス
返却: GetVotesResponse
例
getVotes の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API キー認証を構成: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 以下のコメントを外すと、必要に応じて API キーのプレフィックス (例: Bearer) を設定できます
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションで、デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getVotes($tenant_id, $url_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
28}
29
ユーザーの投票取得
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
例
getVotesForUser の例
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// APIキー認証を設定: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// 以下のコメントアウトを外して、APIキーのプレフィックス（例: Bearer）を設定します（必要な場合）
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // カスタム HTTP クライアントを使用したい場合は、`GuzzleHttp\ClientInterface` を実装したクライアントを渡してください。
14 // これはオプションです。デフォルトでは `GuzzleHttp\Client` が使用されます。
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_id_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
32}
33
ヘルプが必要ですか？
PHP SDK に関して問題が発生した場合や質問がある場合は、次のいずれかを行ってください：
貢献
貢献を歓迎します！貢献ガイドラインについては、GitHub リポジトリ をご覧ください。