
Język 🇵🇱 Polski
Pierwsze kroki
Dokumentacja
Agregacja
Logi audytu
Blokowanie z komentarza
Sprawdzanie zablokowanych komentarzy
Komentarze
Konfiguracje domen
Szablony e-mail
Dziennik zdarzeń
Wpisy w kanale
Zgłaszanie komentarza
Hashtagi
Moderatorzy
Liczba powiadomień
Powiadomienia
Strony
Oczekujące zdarzenia webhook
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne użycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Zgłoszenia
Prześlij obraz
Postęp odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
FastComments Python SDK
To jest oficjalne SDK Pythona dla FastComments.
Oficjalne SDK Pythona dla API FastComments
Repozytorium
Instalacja 
PyPI
pip install fastcomments
Library Contents
Ta biblioteka zawiera dwa moduły: wygenerowanego klienta API oraz główną bibliotekę Pythona, która zawiera ręcznie napisane narzędzia ułatwiające pracę z API, w tym obsługę SSO.
Publiczne vs zabezpieczone API
Dla klienta API są dwie klasy, DefaultApi i PublicApi. DefaultApi zawiera metody, które wymagają twojego klucza API, natomiast PublicApi zawiera wywołania API, które można wykonywać bezpośrednio z przeglądarki/urządzenia mobilnego itp. bez uwierzytelniania.
Szybki start 
Korzystanie z uwierzytelnionych API (DefaultApi)
Ważne: Musisz ustawić swój klucz API w Configuration przed wykonywaniem uwierzytelnionych żądań. Jeśli tego nie zrobisz, żądania zakończą się błędem 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Utwórz i skonfiguruj klienta API
config = Configuration()
config.host = "https://fastcomments.com/api"
# WYMAGANE: Ustaw swój klucz API (pobierz go z panelu FastComments)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Utwórz instancję API z skonfigurowanym klientem
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Teraz możesz wykonywać uwierzytelnione wywołania API
try:
# Przykład: Dodaj użytkownika SSO
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Typowe błędy:
# - 401: Brakujący lub nieprawidłowy klucz API
# - 400: Walidacja żądania nie powiodła się
Korzystanie z publicznych API (PublicApi)
Publiczne endpointy nie wymagają uwierzytelnienia:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
Korzystanie z SSO (Single Sign-On)
SDK zawiera narzędzia do generowania bezpiecznych tokenów SSO:
from sso import FastCommentsSSO, SecureSSOUserData
# Utwórz dane użytkownika
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Utwórz instancję SSO z Twoim sekretem API
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Wygeneruj token SSO
sso_token = sso.create_token()
# Użyj tego tokenu w frontendzie lub przekaż do wywołań API
print(f"SSO Token: {sso_token}")
Dla prostego SSO (mniej bezpieczne, do testów):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Częste problemy
- 401 "missing-api-key" error: Upewnij się, że ustawisz
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}przed utworzeniem instancji DefaultApi. - Zła klasa API: Użyj
DefaultApidla uwierzytelnionych żądań po stronie serwera,PublicApidla żądań po stronie klienta/publicznych. - Błędy importu: Upewnij się, że importujesz z poprawnego modułu:
- API client:
from client import ... - SSO utilities:
from sso import ...
- API client:
Notatki 
Identyfikatory Broadcast
Zobaczysz, że w niektórych wywołaniach API powinieneś przekazać broadcast_id. Kiedy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, aby zignorować zdarzenie, jeśli zamierzasz optymistycznie zastosować zmiany po stronie klienta (co prawdopodobnie będziesz chciał zrobić, ponieważ zapewnia to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, żeby nie wystąpił dwukrotnie w sesji przeglądarki.
Wymagania 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
aggregate 
Agreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itp.).
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| parentTenantId | string | query | Nie | |
| includeStats | boolean | query | Nie |
Odpowiedź
Zwraca: AggregationResponse
Przykład

get_audit_logs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| limit | number | query | Nie | |
| skip | number | query | Nie | |
| order | string | query | Nie | |
| after | number | query | Nie | |
| before | number | query | Nie |
Odpowiedź
Zwraca: GetAuditLogs200Response
Przykład

block_from_comment_public 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

un_block_comment_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

checked_comments_for_blocked 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentIds | string | query | Tak | Lista identyfikatorów komentarzy oddzielonych przecinkami. |
| sso | string | query | Nie |
Response
Zwraca: CheckedCommentsForBlocked200Response
Przykład

block_user_from_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

create_comment_public 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateCommentPublic200Response
Przykład

delete_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| contextUserId | string | query | Nie | |
| isLive | boolean | query | Nie |
Odpowiedź
Zwraca: DeleteComment200Response
Przykład

delete_comment_public 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentPublic200Response
Przykład

delete_comment_vote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

flag_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

get_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetComment200Response
Przykład

get_comment_text 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| commentId | string | ścieżka | Tak | |
| editKey | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetCommentText200Response
Przykład

get_comment_vote_user_names 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| dir | integer | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNames200Response
Przykład

get_comments 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | integer | query | Nie | |
| limit | integer | query | Nie | |
| skip | integer | query | Nie | |
| asTree | boolean | query | Nie | |
| skipChildren | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie | |
| contextUserId | string | query | Nie | |
| hashTag | string | query | Nie | |
| parentId | string | query | Nie | |
| direction | string | query | Nie |
Odpowiedź
Zwraca: GetComments200Response
Przykład

get_comments_public 
żądanie tenantId urlId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak | |
| page | integer | zapytanie | Nie | |
| direction | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie | |
| skip | integer | zapytanie | Nie | |
| skipChildren | integer | zapytanie | Nie | |
| limit | integer | zapytanie | Nie | |
| limitChildren | integer | zapytanie | Nie | |
| countChildren | boolean | zapytanie | Nie | |
| fetchPageForCommentId | string | zapytanie | Nie | |
| includeConfig | boolean | zapytanie | Nie | |
| countAll | boolean | zapytanie | Nie | |
| includei10n | boolean | zapytanie | Nie | |
| locale | string | zapytanie | Nie | |
| modules | string | zapytanie | Nie | |
| isCrawler | boolean | zapytanie | Nie | |
| includeNotificationCount | boolean | zapytanie | Nie | |
| asTree | boolean | zapytanie | Nie | |
| maxTreeDepth | integer | zapytanie | Nie | |
| useFullTranslationIds | boolean | zapytanie | Nie | |
| parentId | string | zapytanie | Nie | |
| searchText | string | zapytanie | Nie | |
| hashTags | array | zapytanie | Nie | |
| userId | string | zapytanie | Nie | |
| customConfigStr | string | zapytanie | Nie | |
| afterCommentId | string | zapytanie | Nie | |
| beforeCommentId | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetCommentsPublic200Response
Przykład

lock_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

pin_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| commentId | string | ścieżka | Tak | |
| broadcastId | string | zapytanie | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

save_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string |
Lokalizacja | Tak | |
| isLive | boolean |
Lokalizacja | Nie | |
| doSpamCheck | boolean |
Lokalizacja | Nie | |
| sendEmails | boolean |
Lokalizacja | Nie | |
| populateNotifications | boolean |
Lokalizacja | Nie |
Odpowiedź
Zwraca: SaveComment200Response
Przykład

save_comments_bulk 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Zwraca: SaveComment200Response
Przykład

set_comment_text 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetCommentText200Response
Przykład

un_block_user_from_comment 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak | |
| userId | string | zapytanie | Nie | |
| anonUserId | string | zapytanie | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

un_flag_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

un_lock_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

un_pin_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

update_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| contextUserId | string | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| isLive | boolean | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

vote_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

add_domain_config 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: AddDomainConfig200Response
Przykład

delete_domain_config 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Odpowiedź
Zwraca: DeleteDomainConfig200Response
Przykład

get_domain_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domain | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

get_domain_configs 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetDomainConfigs200Response
Przykład

patch_domain_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

put_domain_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

create_email_template 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateEmailTemplate200Response
Przykład

delete_email_template 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

delete_email_template_render_error 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| errorId | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_email_template 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetEmailTemplate200Response
Przykład

get_email_template_definitions 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetEmailTemplateDefinitions200Response
Przykład

get_email_template_render_errors 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetEmailTemplateRenderErrors200Response
Przykład

get_email_templates 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplates200Response
Przykład

render_email_template 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| locale | string | query | Nie |
Odpowiedź
Zwraca: RenderEmailTemplate200Response
Przykład

update_email_template 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_event_log 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak | |
| userIdWS | string | zapytanie | Tak | |
| startTime | integer | zapytanie | Tak | |
| endTime | integer | zapytanie | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

get_global_event_log 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

create_feed_post 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| broadcastId | string | query | Nie | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| skipDupCheck | boolean | query | Nie |
Odpowiedź
Zwraca: CreateFeedPost200Response
Przykład

create_feed_post_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

delete_feed_post_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteFeedPostPublic200Response
Przykład

get_feed_posts 
req tenantId afterId
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie |
Odpowiedź
Zwraca: GetFeedPosts200Response
Przykład

get_feed_posts_public 
req tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie | |
| sso | string | query | Nie | |
| isCrawler | boolean | query | Nie | |
| includeUserInfo | boolean | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsPublic200Response
Przykład

get_feed_posts_stats 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsStats200Response
Przykład

get_user_reacts_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserReactsPublic200Response
Przykład

react_feed_post_public 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| isUndo | boolean | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ReactFeedPostPublic200Response
Przykład

update_feed_post 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

update_feed_post_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

flag_comment_public 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| isFlagged | boolean | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

add_hash_tag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: AddHashTag200Response
Przykład

add_hash_tags_bulk 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: AddHashTagsBulk200Response
Przykład

delete_hash_tag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | ścieżka | Yes | |
| tenantId | string | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_hash_tags 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetHashTags200Response
Przykład

patch_hash_tag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Tak | |
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: PatchHashTag200Response
Przykład

create_moderator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateModerator200Response
Przykład

delete_moderator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sendEmail | string | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_moderator 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetModerator200Response
Przykład

get_moderators 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetModerators200Response
Przykład

send_invite 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| fromName | string | query | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

update_moderator 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

delete_notification_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_cached_notification_count 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetCachedNotificationCount200Response
Przykład

get_notification_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| urlId | string | query | Nie | |
| fromCommentId | string | query | Nie | |
| viewed | boolean | query | Nie | |
| type | string | query | Nie |
Odpowiedź
Zwraca: GetNotificationCount200Response
Przykład

get_notifications 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetNotifications200Response
Przykład

update_notification 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

add_page 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: AddPageAPIResponse
Przykład

delete_page 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePageAPIResponse
Przykład

get_page_by_urlid 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetPageByURLIdAPIResponse
Przykład

get_pages 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetPagesAPIResponse
Przykład

patch_page 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: PatchPageAPIResponse
Przykład

delete_pending_webhook_event 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_pending_webhook_event_count 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEventCount200Response
Przykład

get_pending_webhook_events 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEvents200Response
Przykład

create_question_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionConfig200Response
Przykład

delete_question_config 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_question_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionConfig200Response
Przykład

get_question_configs 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionConfigs200Response
Przykład

update_question_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

create_question_result 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: CreateQuestionResult200Response
Przykład

delete_question_result 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_question_result 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionResult200Response
Przykład

get_question_results 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| startDate | string | query | Nie | |
| questionId | string | query | Nie | |
| questionIds | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionResults200Response
Przykład

update_question_result 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

aggregate_question_results 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| timeBucket | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: AggregateQuestionResults200Response
Przykład

bulk_aggregate_question_results 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: BulkAggregateQuestionResults200Response
Przykład

combine_comments_with_question_results 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie | |
| minValue | number | query | Nie | |
| maxValue | number | query | Nie | |
| limit | number | query | Nie |
Odpowiedź
Zwraca: CombineCommentsWithQuestionResults200Response
Przykład

add_sso_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: AddSSOUserAPIResponse
Przykład

delete_sso_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | boolean | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: DeleteSSOUserAPIResponse
Przykład

get_sso_user_by_email 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByEmailAPIResponse
Przykład

get_sso_user_by_id 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: GetSSOUserByIdAPIResponse
Przykład

get_sso_users 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsers200Response
Przykład

patch_sso_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PatchSSOUserAPIResponse
Przykład

put_sso_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PutSSOUserAPIResponse
Przykład

create_subscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateSubscriptionAPIResponse
Przykład

delete_subscription 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

get_subscriptions 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: GetSubscriptionsAPIResponse
Przykład

update_subscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: UpdateSubscriptionAPIResponse
Przykład

get_tenant_daily_usages 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| yearNumber | number | query | Nie | |
| monthNumber | number | query | Nie | |
| dayNumber | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantDailyUsages200Response
Przykład

create_tenant_package 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantPackage200Response
Przykład

delete_tenant_package 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_tenant_package 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantPackage200Response
Przykład

get_tenant_packages 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetTenantPackages200Response
Przykład

replace_tenant_package 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

update_tenant_package 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

create_tenant_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateTenantUser200Response
Przykład

delete_tenant_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_tenant_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantUser200Response
Przykład

get_tenant_users 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantUsers200Response
Przykład

replace_tenant_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

send_login_link 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| redirectURL | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

update_tenant_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak | |
| updateComments | string | zapytanie | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

create_tenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenant200Response
Przykład

delete_tenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sure | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

get_tenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenant200Response
Przykład

get_tenants 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| meta | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenants200Response
Przykład

update_tenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

change_ticket_state 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| userId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: ChangeTicketState200Response
Przykład

create_ticket 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Tak |
Odpowiedź
Zwraca: CreateTicket200Response
Przykład

get_ticket 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: GetTicket200Response
Przykład

get_tickets 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| state | number | query | Nie | |
| skip | number | query | Nie | |
| limit | number | query | Nie |
Odpowiedź
Zwraca: GetTickets200Response
Przykład

upload_image 
Prześlij i zmień rozmiar obrazu
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| sizePreset | string | query | Nie | Predefiniowany rozmiar: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | Nie | Id strony, z której odbywa się przesyłanie, do konfiguracji |
Odpowiedź
Zwraca: UploadImageResponse
Przykład

get_user_badge_progress_by_id 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

get_user_badge_progress_by_user_id 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

get_user_badge_progress_list 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadgeProgressList200Response
Przykład

create_user_badge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateUserBadge200Response
Przykład

delete_user_badge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: UpdateUserBadge200Response
Przykład

get_user_badge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadge200Response
Przykład

get_user_badges 
Parametry
| Name | Type | Location | Wymagane | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| badgeId | string | query | Nie | |
| type | number | query | Nie | |
| displayedOnComments | boolean | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadges200Response
Przykład

update_user_badge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: UpdateUserBadge200Response
Przykład

get_user_notification_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetUserNotificationCount200Response
Przykład

get_user_notifications 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| pageSize | integer | query | Nie | |
| afterId | string | query | Nie | |
| includeContext | boolean | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| includeTranslations | boolean | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: GetUserNotifications200Response
Przykład

reset_user_notification_count 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: ResetUserNotifications200Response
Przykład

reset_user_notifications 
Parametry
| Nazwa | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ResetUserNotifications200Response
Przykład

update_user_notification_comment_subscription_status 
Włącz lub wyłącz powiadomienia dla konkretnego komentarza.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

update_user_notification_page_subscription_status 
Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy subskrybują stronę, tworzone są powiadomienia dla nowych komentarzy głównych, a także
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

update_user_notification_status 
Parametry
| Nazwa | Typ | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| newStatus | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

get_user_presence_statuses 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Odpowiedź
Zwraca: GetUserPresenceStatuses200Response
Przykład

search_users 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| usernameStartsWith | string | query | Nie | |
| mentionGroupIds | array | query | Nie | |
| sso | string | query | Nie | |
| searchSection | string | query | Nie |
Odpowiedź
Zwraca: SearchUsers200Response
Przykład

get_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUser200Response
Przykład

create_vote 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Tak | |
| direction | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

delete_vote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| editKey | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

get_votes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetVotes200Response
Przykład

get_votes_for_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: GetVotesForUser200Response
Przykład

Potrzebujesz pomocy?
Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące SDK Pythona, prosimy:
Contributing
Wkład jest mile widziany! Proszę odwiedzić repozytorium GitHub w celu zapoznania się z wytycznymi dotyczącymi kontrybucji.