FastComments PHP SDK
Це офіційний PHP SDK для FastComments.
Офіційний PHP SDK для API FastComments
Репозиторій
Встановлення та використання 
Вимоги
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
Щоб встановити bindings за допомогою Composer, додайте наступне до composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}Then run composer install
Manual Installation
Download the files and include autoload.php:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');Початок роботи
Будь ласка, дотримуйтесь процедури встановлення, а потім виконайте наступне:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключем API: api_key
// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// Якщо ви хочете використовувати власний http-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
// Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
new GuzzleHttp\Client(),
$config
);
$tenant_id = 'tenant_id_example'; // рядок
$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
Всі URI відносні до https://fastcomments.com
| Клас | Метод | HTTP-запит | Опис |
|---|---|---|---|
| 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} | |
| 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 | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| 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 | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| 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 | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| 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
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfig200Response
- AddDomainConfig200ResponseAnyOf
- AddDomainConfigParams
- AddHashTag200Response
- AddHashTagsBulk200Response
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResults200Response
- AggregateQuestionResultsResponse
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- BillingInfo
- BlockFromCommentParams
- BlockFromCommentPublic200Response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResults200Response
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- ChangeCommentPinStatusResponse
- ChangeTicketState200Response
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked200Response
- CombineCommentsWithQuestionResults200Response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic200Response
- CreateEmailTemplate200Response
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPost200Response
- CreateFeedPostParams
- CreateFeedPostPublic200Response
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModerator200Response
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfig200Response
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResult200Response
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenant200Response
- CreateTenantBody
- CreateTenantPackage200Response
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUser200Response
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicket200Response
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadge200Response
- CreateUserBadgeParams
- CustomConfigParameters
- CustomEmailTemplate
- DeleteComment200Response
- DeleteCommentAction
- DeleteCommentPublic200Response
- DeleteCommentResult
- DeleteCommentVote200Response
- DeleteDomainConfig200Response
- DeleteFeedPostPublic200Response
- DeleteFeedPostPublic200ResponseAnyOf
- DeleteHashTagRequest
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagComment200Response
- FlagCommentPublic200Response
- FlagCommentResponse
- GetAuditLogs200Response
- GetAuditLogsResponse
- GetCachedNotificationCount200Response
- GetCachedNotificationCountResponse
- GetComment200Response
- GetCommentText200Response
- GetCommentVoteUserNames200Response
- GetCommentVoteUserNamesSuccessResponse
- GetComments200Response
- GetCommentsPublic200Response
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfig200Response
- GetDomainConfigs200Response
- GetDomainConfigs200ResponseAnyOf
- GetDomainConfigs200ResponseAnyOf1
- GetEmailTemplate200Response
- GetEmailTemplateDefinitions200Response
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrors200Response
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplates200Response
- GetEmailTemplatesResponse
- GetEventLog200Response
- GetEventLogResponse
- GetFeedPosts200Response
- GetFeedPostsPublic200Response
- GetFeedPostsResponse
- GetFeedPostsStats200Response
- GetHashTags200Response
- GetHashTagsResponse
- GetModerator200Response
- GetModeratorResponse
- GetModerators200Response
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCount200Response
- GetNotificationCountResponse
- GetNotifications200Response
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCount200Response
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEvents200Response
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetQuestionConfig200Response
- GetQuestionConfigResponse
- GetQuestionConfigs200Response
- GetQuestionConfigsResponse
- GetQuestionResult200Response
- GetQuestionResultResponse
- GetQuestionResults200Response
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsers200Response
- GetSubscriptionsAPIResponse
- GetTenant200Response
- GetTenantDailyUsages200Response
- GetTenantDailyUsagesResponse
- GetTenantPackage200Response
- GetTenantPackageResponse
- GetTenantPackages200Response
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUser200Response
- GetTenantUserResponse
- GetTenantUsers200Response
- GetTenantUsersResponse
- GetTenants200Response
- GetTenantsResponse
- GetTicket200Response
- GetTicketResponse
- GetTickets200Response
- GetTicketsResponse
- GetUser200Response
- GetUserBadge200Response
- GetUserBadgeProgressById200Response
- GetUserBadgeProgressList200Response
- GetUserBadges200Response
- GetUserNotificationCount200Response
- GetUserNotificationCountResponse
- GetUserNotifications200Response
- GetUserPresenceStatuses200Response
- GetUserPresenceStatusesResponse
- GetUserReactsPublic200Response
- GetUserResponse
- GetVotes200Response
- GetVotesForUser200Response
- GetVotesForUserResponse
- GetVotesResponse
- GifRating
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- LockComment200Response
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PatchDomainConfigParams
- PatchHashTag200Response
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PinComment200Response
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicVote
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostPublic200Response
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RecordStringStringOrNumberValue
- RenderEmailTemplate200Response
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotifications200Response
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveComment200Response
- SaveCommentResponse
- SaveCommentResponseOptimized
- SaveCommentsResponseWithPresence
- SearchUsers200Response
- SearchUsersResponse
- SearchUsersSectionedResponse
- SetCommentText200Response
- SetCommentTextResult
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantHashTag
- TenantPackage
- UnBlockCommentPublic200Response
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadge200Response
- UpdateUserBadgeParams
- UpdateUserNotificationStatus200Response
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- VoteBodyParams
- VoteComment200Response
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
Авторизація
Схеми автентифікації, визначені для API:
api_key
- Тип: Ключ API
- Назва параметра ключа API: x-api-key
- Розташування: заголовок HTTP
Автор
aggregate
Агрегує документи, групуючи їх (якщо вказано groupBy) і застосовуючи кілька операцій. Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregationResponse
Приклад
Приклад виклику aggregate
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) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
20$parent_tenant_id = 'parent_tenant_id_example'; // string
21$include_stats = True; // bool
22
23try {
24 $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $parent_tenant_id, $include_stats);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
28}
29
getAuditLogs
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| limit | number | query | Ні | |
| skip | number | query | Ні | |
| order | string | query | Ні | |
| after | number | query | Ні | |
| before | number | query | Ні |
Відповідь
Повертає: GetAuditLogs200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$limit = 3.4; // float
20$skip = 3.4; // float
21$order = new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(); // \FastComments\Client\Model\SORTDIR
22$after = 3.4; // float
23$before = 3.4; // float
24
25try {
26 $result = $apiInstance->getAuditLogs($tenant_id, $limit, $skip, $order, $after, $before);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
30}
31
blockFromCommentPublic
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: BlockFromCommentPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23
unBlockCommentPublic
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UnBlockCommentPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23
checkedCommentsForBlocked
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentIds | string | query | Так | Список id коментарів, розділених комами. |
| sso | string | query | Ні |
Відповідь
Повертає: CheckedCommentsForBlocked200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_ids = 'comment_ids_example'; // string | Список id коментарів, розділених комами.
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
21}
22
blockUserFromComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: BlockFromCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
21$user_id = 'user_id_example'; // рядок
22$anon_user_id = 'anon_user_id_example'; // рядок
23
24try {
25 $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
29}
30
createCommentPublic
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateCommentPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
16$session_id = 'session_id_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $session_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25
deleteComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| contextUserId | string | query | Ні | |
| isLive | boolean | query | Ні |
Відповідь
Повертає: DeleteComment200Response
Приклад
Приклад deleteComment
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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$context_user_id = 'context_user_id_example'; // string
21$is_live = True; // bool
22
23try {
24 $result = $apiInstance->deleteComment($tenant_id, $id, $context_user_id, $is_live);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
28}
29
deleteCommentPublic
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: DeleteCommentPublic200Response
Приклад
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$tenant_id = 'tenant_id_example'; // рядок
13$comment_id = 'comment_id_example'; // рядок
14$broadcast_id = 'broadcast_id_example'; // рядок
15$edit_key = 'edit_key_example'; // рядок
16$sso = 'sso_example'; // рядок
17
18try {
19 $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $edit_key, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
23}
24
deleteCommentVote
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | шлях | Так | |
| commentId | string | шлях | Так | |
| voteId | string | шлях | Так | |
| urlId | string | запит | Так | |
| broadcastId | string | запит | Так | |
| editKey | string | запит | Ні | |
| sso | string | запит | Ні |
Відповідь
Повертає: DeleteCommentVote200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$vote_id = 'vote_id_example'; // string
15$url_id = 'url_id_example'; // string
16$broadcast_id = 'broadcast_id_example'; // string
17$edit_key = 'edit_key_example'; // string
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $edit_key, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
25}
26
flagComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: FlagComment200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->flagComment($tenant_id, $id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
28}
29
getComment
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetComment200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getComment($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
26}
27
getComments
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | integer | query | Ні | |
| limit | integer | query | Ні | |
| skip | integer | query | Ні | |
| asTree | boolean | query | Ні | |
| skipChildren | integer | query | Ні | |
| limitChildren | integer | query | Ні | |
| maxTreeDepth | integer | query | Ні | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні | |
| contextUserId | string | query | Ні | |
| hashTag | string | query | Ні | |
| parentId | string | query | Ні | |
| direction | string | query | Ні |
Відповідь
Повертає: GetComments200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$page = 56; // int
20$limit = 56; // int
21$skip = 56; // int
22$as_tree = True; // bool
23$skip_children = 56; // int
24$limit_children = 56; // int
25$max_tree_depth = 56; // int
26$url_id = 'url_id_example'; // string
27$user_id = 'user_id_example'; // string
28$anon_user_id = 'anon_user_id_example'; // string
29$context_user_id = 'context_user_id_example'; // string
30$hash_tag = 'hash_tag_example'; // string
31$parent_id = 'parent_id_example'; // string
32$direction = new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(); // \FastComments\Client\Model\SortDirections
33
34try {
35 $result = $apiInstance->getComments($tenant_id, $page, $limit, $skip, $as_tree, $skip_children, $limit_children, $max_tree_depth, $url_id, $user_id, $anon_user_id, $context_user_id, $hash_tag, $parent_id, $direction);
36 print_r($result);
37} catch (Exception $e) {
38 echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
39}
40
getCommentsPublic
req tenantId urlId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| page | integer | query | Ні | |
| direction | string | query | Ні | |
| sso | string | query | Ні | |
| skip | integer | query | Ні | |
| skipChildren | integer | query | Ні | |
| limit | integer | query | Ні | |
| limitChildren | integer | query | Ні | |
| countChildren | boolean | query | Ні | |
| fetchPageForCommentId | string | query | Ні | |
| includeConfig | boolean | query | Ні | |
| countAll | boolean | query | Ні | |
| includei10n | boolean | query | Ні | |
| locale | string | query | Ні | |
| modules | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeNotificationCount | boolean | query | Ні | |
| asTree | boolean | query | Ні | |
| maxTreeDepth | integer | query | Ні | |
| useFullTranslationIds | boolean | query | Ні | |
| parentId | string | query | Ні | |
| searchText | string | query | Ні | |
| hashTags | array | query | Ні | |
| userId | string | query | Ні | |
| customConfigStr | string | query | Ні | |
| afterCommentId | string | query | Ні | |
| beforeCommentId | string | query | Ні |
Відповідь
Повертає: GetCommentsPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$page = 56; // int
15$direction = new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(); // \FastComments\Client\Model\SortDirections
16$sso = 'sso_example'; // string
17$skip = 56; // int
18$skip_children = 56; // int
19$limit = 56; // int
20$limit_children = 56; // int
21$count_children = True; // bool
22$fetch_page_for_comment_id = 'fetch_page_for_comment_id_example'; // string
23$include_config = True; // bool
24$count_all = True; // bool
25$includei10n = True; // bool
26$locale = 'locale_example'; // string
27$modules = 'modules_example'; // string
28$is_crawler = True; // bool
29$include_notification_count = True; // bool
30$as_tree = True; // bool
31$max_tree_depth = 56; // int
32$use_full_translation_ids = True; // bool
33$parent_id = 'parent_id_example'; // string
34$search_text = 'search_text_example'; // string
35$hash_tags = array('hash_tags_example'); // string[]
36$user_id = 'user_id_example'; // string
37$custom_config_str = 'custom_config_str_example'; // string
38$after_comment_id = 'after_comment_id_example'; // string
39$before_comment_id = 'before_comment_id_example'; // string
40
41try {
42 $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $page, $direction, $sso, $skip, $skip_children, $limit, $limit_children, $count_children, $fetch_page_for_comment_id, $include_config, $count_all, $includei10n, $locale, $modules, $is_crawler, $include_notification_count, $as_tree, $max_tree_depth, $use_full_translation_ids, $parent_id, $search_text, $hash_tags, $user_id, $custom_config_str, $after_comment_id, $before_comment_id);
43 print_r($result);
44} catch (Exception $e) {
45 echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
46}
47
getCommentText
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetCommentText200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$edit_key = 'edit_key_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->getCommentText($tenant_id, $comment_id, $edit_key, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
22}
23
getCommentVoteUserNames
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| dir | integer | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetCommentVoteUserNames200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$dir = 56; // int
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
22}
23
lockComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: LockComment200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // рядок
13$comment_id = 'comment_id_example'; // рядок
14$broadcast_id = 'broadcast_id_example'; // рядок
15$sso = 'sso_example'; // рядок
16
17try {
18 $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
22}
23
pinComment
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: PinComment200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // рядок
13$comment_id = 'comment_id_example'; // рядок
14$broadcast_id = 'broadcast_id_example'; // рядок
15$sso = 'sso_example'; // рядок
16
17try {
18 $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
22}
23
saveComment
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: SaveComment200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
20$is_live = True; // bool
21$do_spam_check = True; // bool
22$send_emails = True; // bool
23$populate_notifications = True; // bool
24
25try {
26 $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $is_live, $do_spam_check, $send_emails, $populate_notifications);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
30}
31
saveCommentsBulk
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: SaveComment200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
20$is_live = True; // bool
21$do_spam_check = True; // bool
22$send_emails = True; // bool
23$populate_notifications = True; // bool
24
25try {
26 $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $is_live, $do_spam_check, $send_emails, $populate_notifications);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
30}
31
setCommentText
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SetCommentText200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
16$edit_key = 'edit_key_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $edit_key, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
24}
25
unBlockUserFromComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: UnBlockCommentPublic200Response
Приклад
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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
29}
30
unFlagComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: FlagComment200Response
Приклад
Приклад 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// Розкоментуйте наведене нижче, щоб встановити префікс (наприклад Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->unFlagComment($tenant_id, $id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
28}
29
unLockComment
Параметри
| Назва | Type | Location | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: LockComment200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
22}
23
unPinComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: PinComment200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // рядок
13$comment_id = 'comment_id_example'; // рядок
14$broadcast_id = 'broadcast_id_example'; // рядок
15$sso = 'sso_example'; // рядок
16
17try {
18 $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
22}
23
updateComment
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| contextUserId | string | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| isLive | boolean | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад updateComment
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 // Це необов'язково, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$body = new \FastComments\Client\Model\PickAPICommentUpdatableCommentFields(); // \FastComments\Client\Model\PickAPICommentUpdatableCommentFields
21$context_user_id = 'context_user_id_example'; // string
22$do_spam_check = True; // bool
23$is_live = True; // bool
24
25try {
26 $result = $apiInstance->updateComment($tenant_id, $id, $body, $context_user_id, $do_spam_check, $is_live);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
30}
31
voteComment
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: VoteComment200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$url_id = 'url_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
17$session_id = 'session_id_example'; // string
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $session_id, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
25}
26
addDomainConfig
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddDomainConfig200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
20
21try {
22 $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27
deleteDomainConfig
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domain | string | path | Так |
Відповідь
Повертає: DeleteDomainConfig200Response
Приклад
deleteDomainConfig Приклад
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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$domain = 'domain_example'; // string
20
21try {
22 $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27
getDomainConfig
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domain | string | path | Так |
Відповідь
Повертає: GetDomainConfig200Response
Приклад
Приклад getDomainConfig
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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$domain = 'domain_example'; // string
20
21try {
22 $result = $apiInstance->getDomainConfig($tenant_id, $domain);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27
getDomainConfigs
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetDomainConfigs200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19
20try {
21 $result = $apiInstance->getDomainConfigs($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
25}
26
patchDomainConfig
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Відповідь
Повертає: GetDomainConfig200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$domain_to_update = 'domain_to_update_example'; // рядок
20$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
21
22try {
23 $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
27}
28
putDomainConfig
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domainToUpdate | string | path | Так |
Відповідь
Повертає: GetDomainConfig200Response
Приклад
Приклад putDomainConfig
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API-ключа: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
18$domain_to_update = 'domain_to_update_example'; // string
19$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
20
21try {
22 $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27
createEmailTemplate
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateEmailTemplate200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
20
21try {
22 $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27
deleteEmailTemplate
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад deleteEmailTemplate
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API-ключа: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
18$id = 'id_example'; // string
19
20try {
21 $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
25}
26
deleteEmailTemplateRenderError
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| errorId | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад deleteEmailTemplateRenderError
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
18$id = 'id_example'; // string
19$error_id = 'error_id_example'; // string
20
21try {
22 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
26}
27
getEmailTemplate
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetEmailTemplate200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20
21try {
22 $result = $apiInstance->getEmailTemplate($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27
getEmailTemplateDefinitions
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetEmailTemplateDefinitions200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19
20try {
21 $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
25}
26
getEmailTemplateRenderErrors
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplateRenderErrors200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо це необхідно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$skip = 3.4; // float
21
22try {
23 $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
27}
28
getEmailTemplates
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplates200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
26}
27
renderEmailTemplate
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| locale | string | query | Ні |
Відповідь
Повертає: RenderEmailTemplate200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
20$locale = 'locale_example'; // string
21
22try {
23 $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
27}
28
updateEmailTemplate
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | запит | Так | |
| id | string | шлях | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$update_email_template_body = new \FastComments\Client\Model\UpdateEmailTemplateBody(); // \FastComments\Client\Model\UpdateEmailTemplateBody
21
22try {
23 $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
27}
28
getEventLog
req tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Так |
Відповідь
Повертає: GetEventLog200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$user_id_ws = 'user_id_ws_example'; // string
15$start_time = 56; // int
16$end_time = 56; // int
17
18try {
19 $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
23}
24
getGlobalEventLog
req tenantId urlId userIdWS
Параметри
| Назва | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Так |
Відповідь
Повертає: GetEventLog200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // рядок
13$url_id = 'url_id_example'; // рядок
14$user_id_ws = 'user_id_ws_example'; // рядок
15$start_time = 56; // ціле число
16$end_time = 56; // ціле число
17
18try {
19 $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
23}
24
createFeedPost
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| broadcastId | string | query | Ні | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| skipDupCheck | boolean | query | Ні |
Відповідь
Повертає: CreateFeedPost200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
20$broadcast_id = 'broadcast_id_example'; // string
21$is_live = True; // bool
22$do_spam_check = True; // bool
23$skip_dup_check = True; // bool
24
25try {
26 $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $broadcast_id, $is_live, $do_spam_check, $skip_dup_check);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
30}
31
createFeedPostPublic
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: CreateFeedPostPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
22}
23
deleteFeedPostPublic
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: DeleteFeedPostPublic200Response
Приклад
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$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
22}
23
getFeedPosts
запит tenantId afterId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Відповідь
Повертає: GetFeedPosts200Response
Приклад
Приклад getFeedPosts
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) для API-ключа, якщо це потрібно
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$tenant_id = 'tenant_id_example'; // string
19$after_id = 'after_id_example'; // string
20$limit = 56; // int
21$tags = array('tags_example'); // string[]
22
23try {
24 $result = $apiInstance->getFeedPosts($tenant_id, $after_id, $limit, $tags);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
28}
29
getFeedPostsPublic
req tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні | |
| sso | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeUserInfo | boolean | query | Ні |
Відповідь
Повертає: GetFeedPostsPublic200Response
Приклад
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$tenant_id = 'tenant_id_example'; // string
13$after_id = 'after_id_example'; // string
14$limit = 56; // int
15$tags = array('tags_example'); // string[]
16$sso = 'sso_example'; // string
17$is_crawler = True; // bool
18$include_user_info = True; // bool
19
20try {
21 $result = $apiInstance->getFeedPostsPublic($tenant_id, $after_id, $limit, $tags, $sso, $is_crawler, $include_user_info);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
25}
26
getFeedPostsStats
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetFeedPostsStats200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$post_ids = array('post_ids_example'); // string[]
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
21}
22
getUserReactsPublic
Параметри
| Name | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserReactsPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$post_ids = array('post_ids_example'); // string[]
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->getUserReactsPublic($tenant_id, $post_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
21}
22
reactFeedPostPublic
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| isUndo | boolean | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертається: ReactFeedPostPublic200Response
Приклад
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$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
15$is_undo = True; // bool
16$broadcast_id = 'broadcast_id_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $is_undo, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
24}
25
updateFeedPost
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
21
22try {
23 $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
27}
28
updateFeedPostPublic
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateFeedPostPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // рядок
13$post_id = 'post_id_example'; // рядок
14$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
15$broadcast_id = 'broadcast_id_example'; // рядок
16$sso = 'sso_example'; // рядок
17
18try {
19 $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $broadcast_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
23}
24
flagCommentPublic
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| isFlagged | boolean | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$is_flagged = True; // bool
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23
addHashTag
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Ні |
Відповідь
Повертає: AddHashTag200Response
Приклад
Приклад 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// Розкоментуйте наступний рядок, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
20
21try {
22 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
26}
27
addHashTagsBulk
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Ні |
Відповідь
Повертає: AddHashTagsBulk200Response
Приклад
Приклад addHashTagsBulk
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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
20
21try {
22 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
26}
27
deleteHashTag
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tag = 'tag_example'; // string
19$tenant_id = 'tenant_id_example'; // string
20$delete_hash_tag_request = new \FastComments\Client\Model\DeleteHashTagRequest(); // \FastComments\Client\Model\DeleteHashTagRequest
21
22try {
23 $result = $apiInstance->deleteHashTag($tag, $tenant_id, $delete_hash_tag_request);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteHashTag: ', $e->getMessage(), PHP_EOL;
27}
28
getHashTags
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | number | query | Ні |
Відповідь
Повертає: GetHashTags200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$page = 3.4; // float
20
21try {
22 $result = $apiInstance->getHashTags($tenant_id, $page);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
26}
27
patchHashTag
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tag | string | path | Так | |
| tenantId | string | query | Ні |
Відповідь
Повертає: PatchHashTag200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tag = 'tag_example'; // string
19$tenant_id = 'tenant_id_example'; // string
20$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
21
22try {
23 $result = $apiInstance->patchHashTag($tag, $tenant_id, $update_hash_tag_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
27}
28
createModerator
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateModerator200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
20
21try {
22 $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
26}
27
deleteModerator
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| sendEmail | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// 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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$send_email = 'send_email_example'; // string
21
22try {
23 $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
27}
28
getModerator
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetModerator200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getModerator($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Виняток при виклику DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
26}
27
getModerators
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetModerators200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getModerators($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
26}
27
sendInvite
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| fromName | string | query | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$from_name = 'from_name_example'; // string
21
22try {
23 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
27}
28
updateModerator
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад updateModerator
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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
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
deleteNotificationCount
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
26}
27
getCachedNotificationCount
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetCachedNotificationCount200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
26}
27
getNotificationCount
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| urlId | string | query | Ні | |
| fromCommentId | string | query | Ні | |
| viewed | boolean | query | Ні | |
| type | string | query | Ні |
Відповідь
Повертає: GetNotificationCount200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$url_id = 'url_id_example'; // string
21$from_comment_id = 'from_comment_id_example'; // string
22$viewed = True; // bool
23$type = 'type_example'; // string
24
25try {
26 $result = $apiInstance->getNotificationCount($tenant_id, $user_id, $url_id, $from_comment_id, $viewed, $type);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
30}
31
getNotifications
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Відповідь
Повертає: GetNotifications200Response
Приклад
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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для ключа API, якщо це потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$user_id = 'user_id_example'; // рядок
20$url_id = 'url_id_example'; // рядок
21$from_comment_id = 'from_comment_id_example'; // рядок
22$viewed = True; // булеве
23$type = 'type_example'; // рядок
24$skip = 3.4; // число з плаваючою комою
25
26try {
27 $result = $apiInstance->getNotifications($tenant_id, $user_id, $url_id, $from_comment_id, $viewed, $type, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
31}
32
updateNotification
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад updateNotification
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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
21$user_id = 'user_id_example'; // рядок
22
23try {
24 $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
28}
29
addPage
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
20
21try {
22 $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
26}
27
deletePage
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: DeletePageAPIResponse
Приклад
Приклад deletePage
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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deletePage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
26}
27
getPageByURLId
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: 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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20
21try {
22 $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
26}
27
getPages
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetPagesAPIResponse
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19
20try {
21 $result = $apiInstance->getPages($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
25}
26
patchPage
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: PatchPageAPIResponse
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
21
22try {
23 $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
27}
28
deletePendingWebhookEvent
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// 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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
26}
27
getPendingWebhookEventCount
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEventCount200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$external_id = 'external_id_example'; // string
21$event_type = 'event_type_example'; // string
22$type = 'type_example'; // string
23$domain = 'domain_example'; // string
24$attempt_count_gt = 3.4; // float
25
26try {
27 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
31}
32
getPendingWebhookEvents
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEvents200Response
Приклад
Приклад 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// Розкоментуйте рядок нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо це потрібно
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$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$external_id = 'external_id_example'; // string
21$event_type = 'event_type_example'; // string
22$type = 'type_example'; // string
23$domain = 'domain_example'; // string
24$attempt_count_gt = 3.4; // float
25$skip = 3.4; // float
26
27try {
28 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt, $skip);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
32}
33
createQuestionConfig
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateQuestionConfig200Response
Приклад
Приклад 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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
20
21try {
22 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27
deleteQuestionConfig
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27
getQuestionConfig
Параметри
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionConfig200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20
21try {
22 $result = $apiInstance->getQuestionConfig($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27
getQuestionConfigs
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionConfigs200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
26}
27
updateQuestionConfig
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте рядок нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_question_config_body = new \FastComments\Client\Model\UpdateQuestionConfigBody(); // \FastComments\Client\Model\UpdateQuestionConfigBody
21
22try {
23 $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
27}
28
createQuestionResult
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateQuestionResult200Response
Приклад
Приклад createQuestionResult
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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
20
21try {
22 $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27
deleteQuestionResult
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27
getQuestionResult
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionResult200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getQuestionResult($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Виняток при виклику DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27
getQuestionResults
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| startDate | string | query | Ні | |
| questionId | string | query | Ні | |
| questionIds | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionResults200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20$user_id = 'user_id_example'; // string
21$start_date = 'start_date_example'; // string
22$question_id = 'question_id_example'; // string
23$question_ids = 'question_ids_example'; // string
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getQuestionResults($tenant_id, $url_id, $user_id, $start_date, $question_id, $question_ids, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
31}
32
updateQuestionResult
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
21
22try {
23 $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
27}
28
aggregateQuestionResults
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| questionId | string | query | Ні | |
| questionIds | array | query | Ні | |
| urlId | string | query | Ні | |
| timeBucket | string | query | Ні | |
| startDate | string | query | Ні | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: AggregateQuestionResults200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$question_id = 'question_id_example'; // string
20$question_ids = array('question_ids_example'); // string[]
21$url_id = 'url_id_example'; // string
22$time_bucket = new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(); // \FastComments\Client\Model\AggregateTimeBucket
23$start_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
24$force_recalculate = True; // bool
25
26try {
27 $result = $apiInstance->aggregateQuestionResults($tenant_id, $question_id, $question_ids, $url_id, $time_bucket, $start_date, $force_recalculate);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
31}
32
bulkAggregateQuestionResults
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: BulkAggregateQuestionResults200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо це необхідно
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$tenant_id = 'tenant_id_example'; // string
19$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
20$force_recalculate = True; // bool
21
22try {
23 $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
27}
28
combineCommentsWithQuestionResults
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| questionId | string | query | Ні | |
| questionIds | array | query | Ні | |
| urlId | string | query | Ні | |
| startDate | string | query | Ні | |
| forceRecalculate | boolean | query | Ні | |
| minValue | number | query | Ні | |
| maxValue | number | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: CombineCommentsWithQuestionResults200Response
Приклад
Приклад combineCommentsWithQuestionResults
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) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$question_id = 'question_id_example'; // string
20$question_ids = array('question_ids_example'); // string[]
21$url_id = 'url_id_example'; // string
22$start_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
23$force_recalculate = True; // bool
24$min_value = 3.4; // float
25$max_value = 3.4; // float
26$limit = 3.4; // float
27
28try {
29 $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $question_id, $question_ids, $url_id, $start_date, $force_recalculate, $min_value, $max_value, $limit);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
33}
34
addSSOUser
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddSSOUserAPIResponse
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
20
21try {
22 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
26}
27
deleteSSOUser
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | boolean | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: DeleteSSOUserAPIResponse
Приклад
Приклад deleteSSOUser
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$delete_comments = True; // bool
21$comment_delete_mode = 'comment_delete_mode_example'; // string
22
23try {
24 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29
getSSOUserByEmail
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$email = 'email_example'; // string
20
21try {
22 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
26}
27
getSSOUserById
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetSSOUserByIdAPIResponse
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getSSOUserById($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
26}
27
getSSOUsers
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | integer | query | No |
Відповідь
Повертає: GetSSOUsers200Response
Приклад
Приклад getSSOUsers
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
18$skip = 56; // ціле число
19
20try {
21 $result = $apiInstance->getSSOUsers($tenant_id, $skip);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
25}
26
patchSSOUser
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | boolean | query | Ні |
Відповідь
Повертає: PatchSSOUserAPIResponse
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
21$update_comments = True; // bool
22
23try {
24 $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29
putSSOUser
Параметри
| Назва | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | boolean | query | Ні |
Відповідь
Повертає: PutSSOUserAPIResponse
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
21$update_comments = True; // булевий
22
23try {
24 $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29
createSubscription
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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// 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$tenant_id = 'tenant_id_example'; // string
19$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
20
21try {
22 $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
26}
27
deleteSubscription
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21
22try {
23 $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
27}
28
getSubscriptions
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$user_id = 'user_id_example'; // рядок
20
21try {
22 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
26}
27
updateSubscription
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
21$user_id = 'user_id_example'; // рядок
22
23try {
24 $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
28}
29
getTenantDailyUsages
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| yearNumber | number | query | Ні | |
| monthNumber | number | query | Ні | |
| dayNumber | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantDailyUsages200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$year_number = 3.4; // float
20$month_number = 3.4; // float
21$day_number = 3.4; // float
22$skip = 3.4; // float
23
24try {
25 $result = $apiInstance->getTenantDailyUsages($tenant_id, $year_number, $month_number, $day_number, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
29}
30
createTenantPackage
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantPackage200Response
Приклад
Приклад 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// 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$tenant_id = 'tenant_id_example'; // string
19$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
20
21try {
22 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27
deleteTenantPackage
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад deleteTenantPackage
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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27
getTenantPackage
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantPackage200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо це необхідно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20
21try {
22 $result = $apiInstance->getTenantPackage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27
getTenantPackages
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantPackages200Response
Приклад
Приклад getTenantPackages
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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$skip = 3.4; // число з плаваючою точкою
20
21try {
22 $result = $apiInstance->getTenantPackages($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
26}
27
replaceTenantPackage
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб задати префікс (наприклад, Bearer) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
21
22try {
23 $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28
updateTenantPackage
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
21
22try {
23 $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28
createTenantUser
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantUser200Response
Приклад
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) для API ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
20
21try {
22 $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
26}
27
deleteTenantUser
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | string | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
deleteTenantUser Приклад
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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$delete_comments = 'delete_comments_example'; // string
21$comment_delete_mode = 'comment_delete_mode_example'; // string
22
23try {
24 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
getTenantUser
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantUser200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getTenantUser($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
26}
27
getTenantUsers
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantUsers200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$skip = 3.4; // число з плаваючою крапкою
20
21try {
22 $result = $apiInstance->getTenantUsers($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
26}
27
replaceTenantUser
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23try {
24 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
sendLoginLink
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| redirectURL | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$redirect_url = 'redirect_url_example'; // рядок
21
22try {
23 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
27}
28
updateTenantUser
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23try {
24 $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
createTenant
Параметри
| Назва | Тип | Location | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateTenant200Response
Приклад
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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
20
21try {
22 $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
26}
27
deleteTenant
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| sure | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$sure = 'sure_example'; // string
21
22try {
23 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
27}
28
getTenant
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenant200Response
Приклад
Приклад getTenant
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getTenant($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
26}
27
getTenants
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| meta | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenants200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$meta = 'meta_example'; // string
20$skip = 3.4; // float
21
22try {
23 $result = $apiInstance->getTenants($tenant_id, $meta, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
27}
28
updateTenant
Параметри
| Назва | Тип | Location | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад
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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо необхідно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
21
22try {
23 $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
27}
28
changeTicketState
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: ChangeTicketState200Response
Приклад
Приклад 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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$id = 'id_example'; // string
21$change_ticket_state_body = new \FastComments\Client\Model\ChangeTicketStateBody(); // \FastComments\Client\Model\ChangeTicketStateBody
22
23try {
24 $result = $apiInstance->changeTicketState($tenant_id, $user_id, $id, $change_ticket_state_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->changeTicketState: ', $e->getMessage(), PHP_EOL;
28}
29
createTicket
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так |
Відповідь
Повертає: CreateTicket200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
21
22try {
23 $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
27}
28
getTicket
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: GetTicket200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21
22try {
23 $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
27}
28
getTickets
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| state | number | query | Ні | |
| skip | number | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: GetTickets200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$state = 3.4; // float
21$skip = 3.4; // float
22$limit = 3.4; // float
23
24try {
25 $result = $apiInstance->getTickets($tenant_id, $user_id, $state, $skip, $limit);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
29}
30
uploadImage
Завантажити та змінити розмір зображення
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| sizePreset | string | query | Ні | Параметр розміру: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | Ні | 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$tenant_id = 'tenant_id_example'; // string
13$file = '/path/to/file.txt'; // \SplFileObject
14$size_preset = new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(); // \FastComments\Client\Model\SizePreset | Параметр розміру: \"Default\" (1000x1000px) або \"CrossPlatform\" (створює розміри для популярних пристроїв)
15$url_id = 'url_id_example'; // string | ID сторінки, з якої виконується завантаження, для налаштування
16
17try {
18 $result = $apiInstance->uploadImage($tenant_id, $file, $size_preset, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
22}
23
getUserBadgeProgressById
Параметри
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetUserBadgeProgressById200Response
Приклад
Приклад 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// 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 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
26}
27
getUserBadgeProgressByUserId
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | path | Так |
Відповідь
Повертає: GetUserBadgeProgressById200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$user_id = 'user_id_example'; // рядок
20
21try {
22 $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
26}
27
getUserBadgeProgressList
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetUserBadgeProgressList200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$limit = 3.4; // float
21$skip = 3.4; // float
22
23try {
24 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $user_id, $limit, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
28}
29
createUserBadge
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateUserBadge200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
20
21try {
22 $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27
deleteUserBadge
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: UpdateUserBadge200Response
Приклад
Приклад deleteUserBadge
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 // Це необов'язково, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteUserBadge($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27
getUserBadge
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetUserBadge200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20
21try {
22 $result = $apiInstance->getUserBadge($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27
getUserBadges
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| badgeId | string | query | Ні | |
| type | number | query | Ні | |
| displayedOnComments | boolean | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetUserBadges200Response
Приклад
Приклад getUserBadges
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) для ключа API, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$badge_id = 'badge_id_example'; // string
21$type = 3.4; // float
22$displayed_on_comments = True; // bool
23$limit = 3.4; // float
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getUserBadges($tenant_id, $user_id, $badge_id, $type, $displayed_on_comments, $limit, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
31}
32
updateUserBadge
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: UpdateUserBadge200Response
Приклад
Приклад updateUserBadge
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) для API-ключа, якщо потрібно
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$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
22try {
23 $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
27}
28
getUserNotificationCount
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserNotificationCount200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$sso = 'sso_example'; // string
14
15try {
16 $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
20}
21
getUserNotifications
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| pageSize | integer | query | Ні | |
| afterId | string | query | Ні | |
| includeContext | boolean | query | Ні | |
| afterCreatedAt | integer | query | Ні | |
| unreadOnly | boolean | query | Ні | |
| dmOnly | boolean | query | Ні | |
| noDm | boolean | query | Ні | |
| includeTranslations | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserNotifications200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$page_size = 56; // int
14$after_id = 'after_id_example'; // string
15$include_context = True; // bool
16$after_created_at = 56; // int
17$unread_only = True; // bool
18$dm_only = True; // bool
19$no_dm = True; // bool
20$include_translations = True; // bool
21$sso = 'sso_example'; // string
22
23try {
24 $result = $apiInstance->getUserNotifications($tenant_id, $page_size, $after_id, $include_context, $after_created_at, $unread_only, $dm_only, $no_dm, $include_translations, $sso);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
28}
29
resetUserNotificationCount
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ResetUserNotifications200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$sso = 'sso_example'; // string
14
15try {
16 $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
20}
21
resetUserNotifications
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| afterCreatedAt | integer | query | Ні | |
| unreadOnly | boolean | query | Ні | |
| dmOnly | boolean | query | Ні | |
| noDm | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ResetUserNotifications200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$after_id = 'after_id_example'; // string
14$after_created_at = 56; // int
15$unread_only = True; // bool
16$dm_only = True; // bool
17$no_dm = True; // bool
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->resetUserNotifications($tenant_id, $after_id, $after_created_at, $unread_only, $dm_only, $no_dm, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
25}
26
updateUserNotificationCommentSubscriptionStatus
Увімкнути або вимкнути сповіщення для конкретного коментаря.
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UpdateUserNotificationStatus200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$notification_id = 'notification_id_example'; // string
14$opted_in_or_out = 'opted_in_or_out_example'; // string
15$comment_id = 'comment_id_example'; // string
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
23}
24
updateUserNotificationPageSubscriptionStatus
Увімкнути або вимкнути сповіщення для сторінки. Коли користувачі підписані на сторінку, створюються сповіщення для нових кореневих коментарів, а також
Параметри
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| url | string | query | Так | |
| pageTitle | string | query | Так | |
| subscribedOrUnsubscribed | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationStatus200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$url = 'url_example'; // string
15$page_title = 'page_title_example'; // string
16$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
24}
25
updateUserNotificationStatus
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| notificationId | string | path | Так | |
| newStatus | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationStatus200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$notification_id = 'notification_id_example'; // string
14$new_status = 'new_status_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
22}
23
getUserPresenceStatuses
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlIdWS | string | query | Так | |
| userIds | string | query | Так |
Відповідь
Повертає: GetUserPresenceStatuses200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // рядок
13$url_id_ws = 'url_id_ws_example'; // рядок
14$user_ids = 'user_ids_example'; // рядок
15
16try {
17 $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
21}
22
searchUsers
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| usernameStartsWith | string | query | Ні | |
| mentionGroupIds | array | query | Ні | |
| sso | string | query | Ні | |
| searchSection | string | query | Ні |
Відповідь
Повертає: SearchUsers200Response
Приклад
Приклад 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$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$username_starts_with = 'username_starts_with_example'; // string
15$mention_group_ids = array('mention_group_ids_example'); // string[]
16$sso = 'sso_example'; // string
17$search_section = 'search_section_example'; // string
18
19try {
20 $result = $apiInstance->searchUsers($tenant_id, $url_id, $username_starts_with, $mention_group_ids, $sso, $search_section);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
24}
25
getUser
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetUser200Response
Приклад
Приклад 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// 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` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getUser($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
26}
27
createVote
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Так | |
| direction | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: VoteComment200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$direction = 'direction_example'; // string
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
29}
30
deleteVote
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| editKey | string | query | Ні |
Відповідь
Повертає: DeleteCommentVote200Response
Приклад
Приклад deleteVote
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) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$edit_key = 'edit_key_example'; // рядок
21
22try {
23 $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
27}
28
getVotes
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetVotes200Response
Приклад
Приклад 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// Розкоментуйте наведений нижче рядок, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
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$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20
21try {
22 $result = $apiInstance->getVotes($tenant_id, $url_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
26}
27
getVotesForUser
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: GetVotesForUser200Response
Приклад
Приклад 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// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для ключа API, якщо потрібно
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 // Це необов'язково, `GuzzleHttp\Client` буде використано як замовчування.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
28}
29
Потрібна допомога?
Якщо ви зіткнулися з будь-якими проблемами або маєте питання щодо PHP SDK, будь ласка:
Внесок
Внески вітаються! Будь ласка, відвідайте репозиторій на GitHub для інструкцій щодо внесків.