FastComments SDK для Python

Це офіційний Python SDK для FastComments.

Офіційний Python SDK для API FastComments

Репозиторій

Встановлення

Встановити з GitHub

Встановіть безпосередньо з тегу випуску (рекомендовано, повністю відтворювано):

pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0

Закріпіть тег замість гілки, щоб збірки були детермінованими. Така ж форма працює у requirements.txt:

fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0

Кожен тегований GitHub Release також має прикріплене зібране wheel, якщо ви віддаєте перевагу встановленню бінарного артефакту безпосередньо.

Вміст бібліотеки

Ця бібліотека містить два модулі: згенерований клієнт API та основну бібліотеку Python, яка містить написані вручну утиліти, що спрощують роботу з API, включаючи підтримку SSO.

Публічні та захищені API

Для клієнта API існує три класи: DefaultApi, PublicApi та ModerationApi. DefaultApi містить методи, які вимагають ваш API‑ключ, а PublicApi містить методи, які можна викликати безпосередньо з браузера/мобільного пристрою тощо без автентифікації. ModerationApi надає широкий набір живих та швидких API модерації. Кожен метод ModerationApi приймає параметр sso і може автентифікуватися через SSO або cookie сесії FastComments.com.

Швидкий старт

Використання автентифікованих API (DefaultApi)

Important: Ви повинні встановити ваш API‑ключ у Configuration перед виконанням автентифікованих запитів. Якщо ви цього не зробите, запити завершаться помилкою 401.

from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData

# Створити та налаштувати API‑клієнт
config = Configuration()
config.host = "https://fastcomments.com"

# ОБОВ'ЯЗКОВО: Встановіть ваш API‑ключ (отримайте його у вашій панелі FastComments)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}

# Створити екземпляр API з налаштованим клієнтом
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)

# Тепер ви можете виконувати автентифіковані API‑виклики
try:
    # Приклад: Додати SSO‑користувача
    user_data = CreateAPISSOUserData(
        id="user-123",
        email="user@example.com",
        display_name="John Doe"
    )

    response = api.add_sso_user("YOUR_TENANT_ID", user_data)
    print(f"User created: {response}")

except Exception as e:
    print(f"Error: {e}")
    # Поширені помилки:
    # - 401: API‑ключ відсутній або недійсний
    # - 400: Не вдалося перевірити запит

Використання публічних API (PublicApi)

Публічні кінцеві точки не вимагають автентифікації:

from client import ApiClient, Configuration, PublicApi

config = Configuration()
config.host = "https://fastcomments.com"

api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)

try:
    response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
    print(response)
except Exception as e:
    print(f"Error: {e}")

Використання панелі модерації (ModerationApi)

ModerationApi забезпечує роботу панелі модератора. Методи викликаються від імені модератора шляхом передачі токену sso:

from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions

config = Configuration()
config.host = "https://fastcomments.com"

api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)

try:
    # Count the comments awaiting moderation
    response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
    print(response)
except Exception as e:
    print(f"Error: {e}")

Використання SSO (Single Sign-On)

SDK включає утиліти для генерації безпечних SSO‑токенів:

from sso import FastCommentsSSO, SecureSSOUserData

# Create user data (id, email, and username are required)
user_data = SecureSSOUserData(
    id="user-123",
    email="user@example.com",
    username="johndoe",
    avatar="https://example.com/avatar.jpg"
)

# Sign it with your API secret (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)

# Generate the SSO token to pass to the widget or an API call
sso_token = sso.create_token()

# Use this token in your frontend or pass to API calls
print(f"SSO Token: {sso_token}")

Для простого SSO (менш безпечного, для тестування):

from sso import FastCommentsSSO, SimpleSSOUserData

user_data = SimpleSSOUserData(
    username="johndoe",
    email="user@example.com"
)

sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()

Живі підписки (PubSub)

Модуль pubsub дозволяє підписатися на події коментарів у реальному часі (нові коментарі, голоси, редагування, сповіщення тощо) через WebSocket, повторюючи LiveEventSubscriber Java SDK FastComments. Для цього потрібен додатковий пакет pubsub, який додає WebSocket‑клієнт до згенерованого API‑клієнта:

pip install "fastcomments[pubsub] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"

from pubsub import LiveEventSubscriber

subscriber = LiveEventSubscriber()

def handle_live_event(event):
    print(f"Live event: {event.type}")
    if event.comment:
        print(f"  comment: {event.comment.comment}")

result = subscriber.subscribe_to_changes(
    tenant_id_ws="YOUR_TENANT_ID",
    url_id="page-url-id",
    url_id_ws="page-url-id",
    user_id_ws="a-unique-presence-id",  # напр., UUID для цієї сесії
    handle_live_event=handle_live_event,
    on_connection_status_change=lambda connected, last_event_time: print(
        f"connected={connected}"
    ),
    region=None,  # встановити "eu" для регіону EU
)

# ...пізніше, коли ви більше не хочете оновлень:
result.close()

Підписник запускає з’єднання у фоновому демон‑потоку, прозоро перепідключається з джиттером і отримує будь‑які події, пропущені під час відключення, з кінцевої точки event‑log при перепідключенні. Передайте необов’язковий зворотний виклик can_see_comments (List[str] -> Dict[str, str], що повертає ідентифікатори, які користувач НЕ може бачити), щоб фільтрувати події для коментарів, які користувач не має права переглядати. Встановіть disable_live_commenting=True, щоб subscribe_to_changes не виконувало нічого і повертало None.

Поширені проблеми

401 "missing-api-key" error: Переконайтеся, що ви встановили config.api_key = {"api_key": "YOUR_KEY"} перед створенням екземпляра DefaultApi.
Wrong API class: Використовуйте DefaultApi для серверних автентифікованих запитів, PublicApi для клієнтських/публічних запитів, та ModerationApi для запитів панелі модератора.
Import errors: Переконайтеся, що ви імпортуєте з правильного модуляля:
- API‑клієнт: from client import ...
- Утиліти SSO: from sso import ...
- Живі підписки: from pubsub import ... (потрібен додаток pubsub)

Примітки

Ідентифікатори трансляцій

Ви побачите, що в деяких викликах API потрібно передавати broadcast_id. Коли ви отримуватимете події, ви отримаєте цей ідентифікатор назад, тож знатимете, що слід ігнорувати подію, якщо ви плануєте оптимістично застосовувати зміни на клієнті (а ймовірно саме так ви й захочете зробити, оскільки це забезпечує найкращий досвід). Передавайте сюди UUID. Ідентифікатор має бути достатньо унікальним, щоб не з'явитися двічі в одній сесії браузера.

Вимоги

Python >= 3.8

Базова установка є чистою стандартною бібліотекою і надає утиліти SSO. Згенерований API‑клієнт (DefaultApi/PublicApi/ModerationApi) потребує додаткового client, який підтягує urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0, та typing-extensions >= 4.0.0:

pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"

aggregate

Агрегує документи шляхом їх групування (якщо вказано groupBy) та застосування кількох операцій.
Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
parentTenantId	string	query	Ні
includeStats	boolean	query	Ні

Відповідь

Повертає: AggregateResponse

Приклад

Приклад агрегування

Copy

import client
from client.api.default_api import AggregateOptions
from client.models.aggregate_response import AggregateResponse
from client.models.aggregation_request import AggregationRequest
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням має значення https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштування авторизації за API ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    aggregation_request = client.AggregationRequest() # AggregationRequest | 
    parent_tenant_id = 'parent_tenant_id_example' # str |  (optional)
    include_stats = True # bool |  (optional)
    try:
        api_response = api_instance.aggregate(tenant_id, aggregation_request, AggregateOptions(parent_tenant_id=parent_tenant_id, include_stats=include_stats))
        print("The response of DefaultApi->aggregate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->aggregate: %s\n" % e)

get_audit_logs

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
limit	number	query	No
skip	number	query	No
order	string	query	No
after	number	query	No
before	number	query	No

Відповідь

Returns: GetAuditLogsResponse

Приклад

Приклад get_audit_logs

Copy

import client
from client.api.default_api import GetAuditLogsOptions
from client.models.get_audit_logs_response import GetAuditLogsResponse
from client.models.sortdir import SORTDIR
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Перегляньте configuration.py, щоб отримати список усіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче; використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо це потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    limit = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    order = client.SORTDIR() # SORTDIR |  (optional)
    after = 3.4 # float |  (optional)
    before = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_audit_logs(tenant_id, GetAuditLogsOptions(limit=limit, skip=skip, order=order, after=after, before=before))
        print("The response of DefaultApi->get_audit_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_audit_logs: %s\n" % e)

logout_public

Response

Повертає: APIEmptyResponse

Example

Приклад logout_public

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням встановлено на https://fastcomments.com
# Перегляньте configuration.py, щоб побачити список усіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    try:
        api_response = api_instance.logout_public()
        print("The response of PublicApi->logout_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->logout_public: %s\n" % e)

block_from_comment_public

Параметри

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

Відповідь

Повертає: BlockSuccess

Приклад

Приклад block_from_comment_public

Copy

import client
from client.models.block_success import BlockSuccess
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Входимо в контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створюємо екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)
        print("The response of PublicApi->block_from_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->block_from_comment_public: %s\n" % e)

un_block_comment_public

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: UnblockSuccess

Приклад

un_block_comment_public Приклад

Copy

import client
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.models.unblock_success import UnblockSuccess
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове і за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)
        print("The response of PublicApi->un_block_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_block_comment_public: %s\n" % e)

checked_comments_for_blocked

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
commentIds	string	query	Так	Список ідентифікаторів коментарів, розділених комами.
sso	string	query	Ні

Відповідь

Повертає: CheckBlockedCommentsResponse

Приклад

checked_comments_for_blocked Приклад

Copy

import client
from client.models.check_blocked_comments_response import CheckBlockedCommentsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове та за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкриваємо контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створюємо екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_ids = 'comment_ids_example' # str | Список ідентифікаторів коментарів, розділених комами.
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, sso=sso)
        print("The response of PublicApi->checked_comments_for_blocked:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->checked_comments_for_blocked: %s\n" % e)

block_user_from_comment

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Відповідь

Повертає: BlockSuccess

Приклад

block_user_from_comment Приклад

Copy

import client
from client.api.default_api import BlockUserFromCommentOptions
from client.models.block_from_comment_params import BlockFromCommentParams
from client.models.block_success import BlockSuccess
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов’язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# згідно з політикою безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    block_from_comment_params = client.BlockFromCommentParams() # BlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (необов’язковий)
    anon_user_id = 'anon_user_id_example' # str |  (необов’язковий)
    try:
        api_response = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, BlockUserFromCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->block_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->block_user_from_comment: %s\n" % e)

create_comment_public

Parameters

Назва	Тип	Розташування	Обов’язково
tenantId	string	path	Так
urlId	string	query	Так
broadcastId	string	query	Так
sessionId	string	query	Ні
sso	string	query	Ні

Response

Повертає: SaveCommentsResponseWithPresence

Example

create_comment_public Приклад

Copy

import client
from client.api.public_api import CreateCommentPublicOptions
from client.models.comment_data import CommentData
from client.models.save_comments_response_with_presence import SaveCommentsResponseWithPresence
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням = https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Введіть контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_data = client.CommentData() # CommentData | 
    session_id = 'session_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, CreateCommentPublicOptions(session_id=session_id, sso=sso))
        print("The response of PublicApi->create_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_comment_public: %s\n" % e)

delete_comment

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
isLive	boolean	query	No

Відповідь

Повертає: DeleteCommentResult

Приклад

delete_comment Приклад

Copy

import client
from client.api.default_api import DeleteCommentOptions
from client.models.delete_comment_result import DeleteCommentResult
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за ключем API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    context_user_id = 'context_user_id_example' # str |  (optional)
    is_live = True # bool |  (optional)
    try:
        api_response = api_instance.delete_comment(tenant_id, id, DeleteCommentOptions(context_user_id=context_user_id, is_live=is_live))
        print("The response of DefaultApi->delete_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_comment: %s\n" % e)

delete_comment_public

Параметри

Ім'я	Тип	Розташування	Обов'язково
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

Відповідь

Повертає: PublicAPIDeleteCommentResponse

Приклад

delete_comment_public Приклад

Copy

import client
from client.api.public_api import DeleteCommentPublicOptions
from client.models.public_api_delete_comment_response import PublicAPIDeleteCommentResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, DeleteCommentPublicOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->delete_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_comment_public: %s\n" % e)

delete_comment_vote

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
voteId	string	path	Так
urlId	string	query	Так
broadcastId	string	query	Так
editKey	string	query	Ні
sso	string	query	Ні

Відповідь

Returns: VoteDeleteResponse

Приклад

delete_comment_vote Приклад

Copy

import client
from client.api.public_api import DeleteCommentVoteOptions
from client.models.vote_delete_response import VoteDeleteResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту не є обов'язковим і за замовчуванням встановлено https://fastcomments.com
# Див. configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    vote_id = 'vote_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, DeleteCommentVoteOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->delete_comment_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_comment_vote: %s\n" % e)

flag_comment

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Відповідь

Returns: FlagCommentResponse

Приклад

flag_comment Приклад

Copy

import client
from client.api.default_api import FlagCommentOptions
from client.models.flag_comment_response import FlagCommentResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (необов'язковий)
    anon_user_id = 'anon_user_id_example' # str |  (необов'язковий)
    try:
        api_response = api_instance.flag_comment(tenant_id, id, FlagCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->flag_comment: %s\n" % e)

get_comment

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIGetCommentResponse

Приклад

get_comment Приклад

Copy

import client
from client.models.api_get_comment_response import APIGetCommentResponse
from client.rest import ApiException
from pprint import pprint
# Вказувати host необов'язково і за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри аутентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведені приклади для кожного методу автентифікації, використайте той,
# який відповідає вашому способу автентифікації.
# Налаштуйте авторизацію за API ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_comment(tenant_id, id)
        print("The response of DefaultApi->get_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_comment: %s\n" % e)

get_comment_text

Параметри

Назва	Тип	Розташування	Обов’язкове
tenantId	string	path	Так
commentId	string	path	Так
editKey	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: PublicAPIGetCommentTextResponse

Приклад

get_comment_text Приклад

Copy

import client
from client.api.public_api import GetCommentTextOptions
from client.models.public_api_get_comment_text_response import PublicAPIGetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_comment_text(tenant_id, comment_id, GetCommentTextOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->get_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comment_text: %s\n" % e)

get_comment_vote_user_names

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
commentId	string	path	Так
dir	integer	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetCommentVoteUserNamesSuccessResponse

Приклад

Приклад get_comment_vote_user_names

Copy

import client
from client.models.get_comment_vote_user_names_success_response import GetCommentVoteUserNamesSuccessResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    dir = 56 # int | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, sso=sso)
        print("The response of PublicApi->get_comment_vote_user_names:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comment_vote_user_names: %s\n" % e)

get_comments

Parameters

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
page	integer	query	No
limit	integer	query	No
skip	integer	query	No
asTree	boolean	query	No
skipChildren	integer	query	No
limitChildren	integer	query	No
maxTreeDepth	integer	query	No
urlId	string	query	No
userId	string	query	No
anonUserId	string	query	No
contextUserId	string	query	No
hashTag	string	query	No
parentId	string	query	No
direction	string	query	No
fromDate	integer	query	No
toDate	integer	query	No

Відповідь

Повертає: APIGetCommentsResponse

Приклад

get_comments Приклад

Copy

import client
from client.api.default_api import GetCommentsOptions
from client.models.api_get_comments_response import APIGetCommentsResponse
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлено https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# в відповідності до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр API класу
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 56 # int |  (optional)
    limit = 56 # int |  (optional)
    skip = 56 # int |  (optional)
    as_tree = True # bool |  (optional)
    skip_children = 56 # int |  (optional)
    limit_children = 56 # int |  (optional)
    max_tree_depth = 56 # int |  (optional)
    url_id = 'url_id_example' # str |  (optional)
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    context_user_id = 'context_user_id_example' # str |  (optional)
    hash_tag = 'hash_tag_example' # str |  (optional)
    parent_id = 'parent_id_example' # str |  (optional)
    direction = client.SortDirections() # SortDirections |  (optional)
    from_date = 56 # int |  (optional)
    to_date = 56 # int |  (optional)
    try:
        api_response = api_instance.get_comments(tenant_id, GetCommentsOptions(page=page, limit=limit, skip=skip, as_tree=as_tree, skip_children=skip_children, limit_children=limit_children, max_tree_depth=max_tree_depth, url_id=url_id, user_id=user_id, anon_user_id=anon_user_id, context_user_id=context_user_id, hash_tag=hash_tag, parent_id=parent_id, direction=direction, from_date=from_date, to_date=to_date))
        print("The response of DefaultApi->get_comments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_comments: %s\n" % e)

get_comments_public

req tenantId urlId

Параметри

Назва	Тип	Розташування	Обов’язковий
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	Ні

Відповідь

Повертає: GetCommentsResponseWithPresencePublicComment

Приклад

get_comments_public Приклад

Copy

import client
from client.api.public_api import GetCommentsPublicOptions
from client.models.get_comments_response_with_presence_public_comment import GetCommentsResponseWithPresencePublicComment
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    page = 56 # int |  (необов’язково)
    direction = client.SortDirections() # SortDirections |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    skip = 56 # int |  (необов’язково)
    skip_children = 56 # int |  (необов’язково)
    limit = 56 # int |  (необов’язково)
    limit_children = 56 # int |  (необов’язково)
    count_children = True # bool |  (необов’язково)
    fetch_page_for_comment_id = 'fetch_page_for_comment_id_example' # str |  (необов’язково)
    include_config = True # bool |  (необов’язково)
    count_all = True # bool |  (необов’язково)
    includei10n = True # bool |  (необов’язково)
    locale = 'locale_example' # str |  (необов’язково)
    modules = 'modules_example' # str |  (необов’язково)
    is_crawler = True # bool |  (необов’язково)
    include_notification_count = True # bool |  (необов’язково)
    as_tree = True # bool |  (необов’язково)
    max_tree_depth = 56 # int |  (необов’язково)
    use_full_translation_ids = True # bool |  (необов’язково)
    parent_id = 'parent_id_example' # str |  (необов’язково)
    search_text = 'search_text_example' # str |  (необов’язково)
    hash_tags = ['hash_tags_example'] # List[str] |  (необов’язково)
    user_id = 'user_id_example' # str |  (необов’язково)
    custom_config_str = 'custom_config_str_example' # str |  (необов’язково)
    after_comment_id = 'after_comment_id_example' # str |  (необов’язково)
    before_comment_id = 'before_comment_id_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_comments_public(tenant_id, url_id, GetCommentsPublicOptions(page=page, direction=direction, sso=sso, skip=skip, skip_children=skip_children, limit=limit, limit_children=limit_children, count_children=count_children, fetch_page_for_comment_id=fetch_page_for_comment_id, include_config=include_config, count_all=count_all, includei10n=includei10n, locale=locale, modules=modules, is_crawler=is_crawler, include_notification_count=include_notification_count, as_tree=as_tree, max_tree_depth=max_tree_depth, use_full_translation_ids=use_full_translation_ids, parent_id=parent_id, search_text=search_text, hash_tags=hash_tags, user_id=user_id, custom_config_str=custom_config_str, after_comment_id=after_comment_id, before_comment_id=before_comment_id))
        print("The response of PublicApi->get_comments_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comments_public: %s\n" % e)

lock_comment

Параметри

Назва	Type	Location	Обов'язкове
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

lock_comment Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за замовчуванням встановлено на https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->lock_comment: %s\n" % e)

pin_comment

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ChangeCommentPinStatusResponse

Приклад

Приклад pin_comment

Copy

import client
from client.models.change_comment_pin_status_response import ChangeCommentPinStatusResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням встановлено https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->pin_comment: %s\n" % e)

save_comment

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Відповідь

Повертає: APISaveCommentResponse

Приклад

save_comment Приклад

Copy

import client
from client.api.default_api import SaveCommentOptions
from client.models.api_save_comment_response import APISaveCommentResponse
from client.models.create_comment_params import CreateCommentParams
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Перегляньте configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_comment_params = client.CreateCommentParams() # CreateCommentParams | 
    is_live = True # bool |  (optional)
    do_spam_check = True # bool |  (optional)
    send_emails = True # bool |  (optional)
    populate_notifications = True # bool |  (optional)
    try:
        api_response = api_instance.save_comment(tenant_id, create_comment_params, SaveCommentOptions(is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications))
        print("The response of DefaultApi->save_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->save_comment: %s\n" % e)

save_comments_bulk

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Відповідь

Повертає: SaveCommentsBulkResponse

Приклад

save_comments_bulk Приклад

Copy

import client
from client.api.default_api import SaveCommentsBulkOptions
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comments_bulk_response import SaveCommentsBulkResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_comment_params = [client.CreateCommentParams()] # List[CreateCommentParams] | 
    is_live = True # bool |  (optional)
    do_spam_check = True # bool |  (optional)
    send_emails = True # bool |  (optional)
    populate_notifications = True # bool |  (optional)
    try:
        api_response = api_instance.save_comments_bulk(tenant_id, create_comment_params, SaveCommentsBulkOptions(is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications))
        print("The response of DefaultApi->save_comments_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->save_comments_bulk: %s\n" % e)

set_comment_text

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

Відповідь

Повертає: PublicAPISetCommentTextResponse

Приклад

Приклад set_comment_text

Copy

import client
from client.api.public_api import SetCommentTextOptions
from client.models.comment_text_update_request import CommentTextUpdateRequest
from client.models.public_api_set_comment_text_response import PublicAPISetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_text_update_request = client.CommentTextUpdateRequest() # CommentTextUpdateRequest | 
    edit_key = 'edit_key_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, SetCommentTextOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->set_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->set_comment_text: %s\n" % e)

un_block_user_from_comment

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Відповідь

Повертає: UnblockSuccess

Приклад

un_block_user_from_comment Приклад

Copy

import client
from client.api.default_api import UnBlockUserFromCommentOptions
from client.models.un_block_from_comment_params import UnBlockFromCommentParams
from client.models.unblock_success import UnblockSuccess
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, UnBlockUserFromCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->un_block_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->un_block_user_from_comment: %s\n" % e)

un_flag_comment

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Повертає: FlagCommentResponse

Приклад

un_flag_comment Приклад

Copy

import client
from client.api.default_api import UnFlagCommentOptions
from client.models.flag_comment_response import FlagCommentResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад,
# який відповідає вашому випадку використання.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.un_flag_comment(tenant_id, id, UnFlagCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->un_flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->un_flag_comment: %s\n" % e)

un_lock_comment

Параметри

Назва	Тип	Location	Required
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад un_lock_comment

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Використайте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_lock_comment: %s\n" % e)

un_pin_comment

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ChangeCommentPinStatusResponse

Приклад

Приклад un_pin_comment

Copy

import client
from client.models.change_comment_pin_status_response import ChangeCommentPinStatusResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_pin_comment: %s\n" % e)

update_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
contextUserId	string	query	Ні
doSpamCheck	boolean	query	Ні
isLive	boolean	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_comment

Copy

import client
from client.api.default_api import UpdateCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.models.updatable_comment_params import UpdatableCommentParams
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації згідно з політикою безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    updatable_comment_params = client.UpdatableCommentParams() # UpdatableCommentParams | 
    context_user_id = 'context_user_id_example' # str |  (необов'язково)
    do_spam_check = True # bool |  (необов'язково)
    is_live = True # bool |  (необов'язково)
    try:
        api_response = api_instance.update_comment(tenant_id, id, updatable_comment_params, UpdateCommentOptions(context_user_id=context_user_id, do_spam_check=do_spam_check, is_live=is_live))
        print("The response of DefaultApi->update_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_comment: %s\n" % e)

vote_comment

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

Відповідь

Returns: VoteResponse

Приклад

vote_comment Приклад

Copy

import client
from client.api.public_api import VoteCommentOptions
from client.models.vote_body_params import VoteBodyParams
from client.models.vote_response import VoteResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Перегляньте configuration.py, щоб отримати список усіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    vote_body_params = client.VoteBodyParams() # VoteBodyParams | 
    session_id = 'session_id_example' # str |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, VoteCommentOptions(session_id=session_id, sso=sso))
        print("The response of PublicApi->vote_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->vote_comment: %s\n" % e)

get_comments_for_user

Параметри

Назва	Тип	Розташування	Обов'язково
userId	string	query	Ні
direction	string	query	Ні
repliesToUserId	string	query	Ні
page	number	query	Ні
includei10n	boolean	query	Ні
locale	string	query	Ні
isCrawler	boolean	query	Ні

Відповідь

Повертає: GetCommentsForUserResponse

Приклад

get_comments_for_user Приклад

Copy

import client
from client.api.public_api import GetCommentsForUserOptions
from client.models.get_comments_for_user_response import GetCommentsForUserResponse
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    user_id = 'user_id_example' # str |  (необов'язково)
    direction = client.SortDirections() # SortDirections |  (необов'язково)
    replies_to_user_id = 'replies_to_user_id_example' # str |  (необов'язково)
    page = 3.4 # float |  (необов'язково)
    includei10n = True # bool |  (необов'язково)
    locale = 'locale_example' # str |  (необов'язково)
    is_crawler = True # bool |  (необов'язково)
    try:
        api_response = api_instance.get_comments_for_user(GetCommentsForUserOptions(user_id=user_id, direction=direction, replies_to_user_id=replies_to_user_id, page=page, includei10n=includei10n, locale=locale, is_crawler=is_crawler))
        print("The response of PublicApi->get_comments_for_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comments_for_user: %s\n" % e)

add_domain_config

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes

Відповідь

Повертає: AddDomainConfigResponse

Приклад

Приклад add_domain_config

Copy

import client
from client.models.add_domain_config_params import AddDomainConfigParams
from client.models.add_domain_config_response import AddDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# Визначення параметра host не обов'язкове і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте той, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API key: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API key, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    add_domain_config_params = client.AddDomainConfigParams() # AddDomainConfigParams | 
    try:
        api_response = api_instance.add_domain_config(tenant_id, add_domain_config_params)
        print("The response of DefaultApi->add_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_domain_config: %s\n" % e)

delete_domain_config

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
domain	string	path	Так

Відповідь

Повертає: DeleteDomainConfigResponse

Приклад

Приклад delete_domain_config

Copy

import client
from client.models.delete_domain_config_response import DeleteDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# Визначення параметра host необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведені приклади для кожного методу автентифікації, використайте
# приклад, який підходить для вашого випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром ApiClient
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain = 'domain_example' # str | 
    try:
        api_response = api_instance.delete_domain_config(tenant_id, domain)
        print("The response of DefaultApi->delete_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_domain_config: %s\n" % e)

get_domain_config

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
domain	string	path	Так

Відповідь

Повертає: GetDomainConfigResponse

Приклад

Приклад get_domain_config

Copy

import client
from client.models.get_domain_config_response import GetDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, що
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain = 'domain_example' # str | 
    try:
        api_response = api_instance.get_domain_config(tenant_id, domain)
        print("The response of DefaultApi->get_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_domain_config: %s\n" % e)

get_domain_configs

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: GetDomainConfigsResponse

Приклад

Приклад get_domain_configs

Copy

import client
from client.models.get_domain_configs_response import GetDomainConfigsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням: https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте той
# приклад, який задовольняє ваш випадок використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_domain_configs(tenant_id)
        print("The response of DefaultApi->get_domain_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_domain_configs: %s\n" % e)

patch_domain_config

Параметри

Name	Type	Розташування	Обов'язково	Опис
tenantId	string	query	Так
domainToUpdate	string	path	Так

Відповідь

Повертає: PatchDomainConfigResponse

Приклад

Приклад patch_domain_config

Copy

import client
from client.models.patch_domain_config_params import PatchDomainConfigParams
from client.models.patch_domain_config_response import PatchDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте
# приклад, який відповідає вашому випадку використання.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_to_update = 'domain_to_update_example' # str | 
    patch_domain_config_params = client.PatchDomainConfigParams() # PatchDomainConfigParams | 
    try:
        api_response = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
        print("The response of DefaultApi->patch_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_domain_config: %s\n" % e)

put_domain_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
domainToUpdate	string	path	Так

Відповідь

Повертає: PutDomainConfigResponse

Приклад

Приклад put_domain_config

Copy

import client
from client.models.put_domain_config_response import PutDomainConfigResponse
from client.models.update_domain_config_params import UpdateDomainConfigParams
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст, використовуючи екземпляр API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_to_update = 'domain_to_update_example' # str | 
    update_domain_config_params = client.UpdateDomainConfigParams() # UpdateDomainConfigParams | 
    try:
        api_response = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
        print("The response of DefaultApi->put_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->put_domain_config: %s\n" % e)

create_email_template

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateEmailTemplateResponse

Приклад

Приклад create_email_template

Copy

import client
from client.models.create_email_template_body import CreateEmailTemplateBody
from client.models.create_email_template_response import CreateEmailTemplateResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням встановлюється в https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Для кожного методу автентифікації наведено приклади нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштуйте авторизацію API ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_email_template_body = client.CreateEmailTemplateBody() # CreateEmailTemplateBody | 
    try:
        api_response = api_instance.create_email_template(tenant_id, create_email_template_body)
        print("The response of DefaultApi->create_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_email_template: %s\n" % e)

delete_email_template

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_email_template

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста опціональне і за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте той
# який відповідає вашому сценарію автентифікації.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_email_template(tenant_id, id)
        print("The response of DefaultApi->delete_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_email_template: %s\n" % e)

delete_email_template_render_error

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
errorId	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_email_template_render_error

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Вказувати host необов'язково, за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу аутентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання аутентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    error_id = 'error_id_example' # str | 
    try:
        api_response = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
        print("The response of DefaultApi->delete_email_template_render_error:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_email_template_render_error: %s\n" % e)

get_email_template

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetEmailTemplateResponse

Приклад

Приклад get_email_template

Copy

import client
from client.models.get_email_template_response import GetEmailTemplateResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_email_template(tenant_id, id)
        print("The response of DefaultApi->get_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template: %s\n" % e)

get_email_template_definitions

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes

Відповідь

Повертає: GetEmailTemplateDefinitionsResponse

Приклад

Приклад get_email_template_definitions

Copy

import client
from client.models.get_email_template_definitions_response import GetEmailTemplateDefinitionsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_email_template_definitions(tenant_id)
        print("The response of DefaultApi->get_email_template_definitions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template_definitions: %s\n" % e)

get_email_template_render_errors

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
id	string	path	Так
skip	number	query	Ні

Відповідь

Повертає: GetEmailTemplateRenderErrorsResponse

Приклад

Приклад get_email_template_render_errors

Copy

import client
from client.models.get_email_template_render_errors_response import GetEmailTemplateRenderErrorsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста опціональне і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче; використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    skip = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_email_template_render_errors(tenant_id, id, skip=skip)
        print("The response of DefaultApi->get_email_template_render_errors:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template_render_errors: %s\n" % e)

get_email_templates

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetEmailTemplatesResponse

Приклад

get_email_templates Приклад

Copy

import client
from client.models.get_email_templates_response import GetEmailTemplatesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації — використайте той
# який відповідає вашому сценарію використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_email_templates(tenant_id, skip=skip)
        print("The response of DefaultApi->get_email_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_templates: %s\n" % e)

render_email_template

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
locale	string	query	Ні

Відповідь

Повертає: RenderEmailTemplateResponse

Приклад

Приклад render_email_template

Copy

import client
from client.models.render_email_template_body import RenderEmailTemplateBody
from client.models.render_email_template_response import RenderEmailTemplateResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове й за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче — використайте той, який
# підходить для вашого сценарію автентифікації.
# Налаштування авторизації за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст, використовуючи екземпляр клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    render_email_template_body = client.RenderEmailTemplateBody() # RenderEmailTemplateBody | 
    locale = 'locale_example' # str |  (необов'язково)
    try:
        api_response = api_instance.render_email_template(tenant_id, render_email_template_body, locale=locale)
        print("The response of DefaultApi->render_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->render_email_template: %s\n" % e)

update_email_template

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_email_template

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_email_template_body import UpdateEmailTemplateBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте той
# приклад, який відповідає вашому випадку використання.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_email_template_body = client.UpdateEmailTemplateBody() # UpdateEmailTemplateBody | 
    try:
        api_response = api_instance.update_email_template(tenant_id, id, update_email_template_body)
        print("The response of DefaultApi->update_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_email_template: %s\n" % e)

get_event_log

req tenantId urlId userIdWS

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
urlId	string	query	Так
userIdWS	string	query	Так
startTime	integer	query	Так
endTime	integer	query	Ні

Відповідь

Повертає: GetEventLogResponse

Приклад

Приклад get_event_log

Copy

import client
from client.models.get_event_log_response import GetEventLogResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове; за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int |  (необов'язково)
    try:
        api_response = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time=end_time)
        print("The response of PublicApi->get_event_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_event_log: %s\n" % e)

get_global_event_log

req tenantId urlId userIdWS

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
urlId	string	query	Так
userIdWS	string	query	Так
startTime	integer	query	Так
endTime	integer	query	Ні

Відповідь

Повертає: GetEventLogResponse

Приклад

get_global_event_log Приклад

Copy

import client
from client.models.get_event_log_response import GetEventLogResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int |  (необов'язково)
    try:
        api_response = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time=end_time)
        print("The response of PublicApi->get_global_event_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_global_event_log: %s\n" % e)

create_feed_post

Parameters

Ім'я	Тип	Розташування	Обов'язково
tenantId	string	запит	Так
broadcastId	string	запит	Ні
isLive	boolean	запит	Ні
doSpamCheck	boolean	запит	Ні
skipDupCheck	boolean	запит	Ні

Відповідь

Повертає: CreateFeedPostsResponse

Приклад

Приклад create_feed_post

Copy

import client
from client.api.default_api import CreateFeedPostOptions
from client.models.create_feed_post_params import CreateFeedPostParams
from client.models.create_feed_posts_response import CreateFeedPostsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації у відповідності до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який відповідає вашому випадку використання.
# Налаштування авторизації за API ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    is_live = True # bool |  (optional)
    do_spam_check = True # bool |  (optional)
    skip_dup_check = True # bool |  (optional)
    try:
        api_response = api_instance.create_feed_post(tenant_id, create_feed_post_params, CreateFeedPostOptions(broadcast_id=broadcast_id, is_live=is_live, do_spam_check=do_spam_check, skip_dup_check=skip_dup_check))
        print("The response of DefaultApi->create_feed_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_feed_post: %s\n" % e)

create_feed_post_public

Параметри

Ім'я	Тип	Розташування	Обов'язково
tenantId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: CreateFeedPostResponse

Приклад

create_feed_post_public Приклад

Copy

import client
from client.api.public_api import CreateFeedPostPublicOptions
from client.models.create_feed_post_params import CreateFeedPostParams
from client.models.create_feed_post_response import CreateFeedPostResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, CreateFeedPostPublicOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of PublicApi->create_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_feed_post_public: %s\n" % e)

delete_feed_post_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: DeleteFeedPostPublicResponse

Приклад

delete_feed_post_public Приклад

Copy

import client
from client.api.public_api import DeleteFeedPostPublicOptions
from client.models.delete_feed_post_public_response import DeleteFeedPostPublicResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.delete_feed_post_public(tenant_id, post_id, DeleteFeedPostPublicOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of PublicApi->delete_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_feed_post_public: %s\n" % e)

get_feed_posts

req tenantId afterId

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
afterId	string	query	Ні
limit	integer	query	Ні
tags	array	query	Ні

Відповідь

Повертає: GetFeedPostsResponse

Приклад

Приклад get_feed_posts

Copy

import client
from client.api.default_api import GetFeedPostsOptions
from client.models.get_feed_posts_response import GetFeedPostsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштувати авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрити контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр API класу
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (необов’язково)
    limit = 56 # int |  (необов’язково)
    tags = ['tags_example'] # List[str] |  (необов’язково)
    try:
        api_response = api_instance.get_feed_posts(tenant_id, GetFeedPostsOptions(after_id=after_id, limit=limit, tags=tags))
        print("The response of DefaultApi->get_feed_posts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_feed_posts: %s\n" % e)

get_feed_posts_public

req tenantId afterId

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	path	Yes
afterId	string	query	No
limit	integer	query	No
tags	array	query	No
sso	string	query	No
isCrawler	boolean	query	No
includeUserInfo	boolean	query	No

Відповідь

Повертає: PublicFeedPostsResponse

Приклад

Приклад get_feed_posts_public

Copy

import client
from client.api.public_api import GetFeedPostsPublicOptions
from client.models.public_feed_posts_response import PublicFeedPostsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str |
    after_id = 'after_id_example' # str |  (необов’язково)
    limit = 56 # int |  (необов’язково)
    tags = ['tags_example'] # List[str] |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    is_crawler = True # bool |  (необов’язково)
    include_user_info = True # bool |  (необов’язково)
    try:
        api_response = api_instance.get_feed_posts_public(tenant_id, GetFeedPostsPublicOptions(after_id=after_id, limit=limit, tags=tags, sso=sso, is_crawler=is_crawler, include_user_info=include_user_info))
        print("The response of PublicApi->get_feed_posts_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_public: %s\n" % e)

get_feed_posts_stats

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
postIds	array	query	Так
sso	string	query	Ні

Відповідь

Повертає: FeedPostsStatsResponse

Приклад

Приклад get_feed_posts_stats

Copy

import client
from client.models.feed_posts_stats_response import FeedPostsStatsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_feed_posts_stats(tenant_id, post_ids, sso=sso)
        print("The response of PublicApi->get_feed_posts_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_stats: %s\n" % e)

get_user_reacts_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
postIds	array	query	Ні
sso	string	query	Ні

Відповідь

Повертає: UserReactsResponse

Приклад

Приклад get_user_reacts_public

Copy

import client
from client.api.public_api import GetUserReactsPublicOptions
from client.models.user_reacts_response import UserReactsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлюється https://fastcomments.com
# Перегляньте configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_user_reacts_public(tenant_id, GetUserReactsPublicOptions(post_ids=post_ids, sso=sso))
        print("The response of PublicApi->get_user_reacts_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_reacts_public: %s\n" % e)

react_feed_post_public

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	path	Так
postId	string	path	Так
isUndo	boolean	query	Ні
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ReactFeedPostResponse

Приклад

react_feed_post_public Приклад

Copy

import client
from client.api.public_api import ReactFeedPostPublicOptions
from client.models.react_body_params import ReactBodyParams
from client.models.react_feed_post_response import ReactFeedPostResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    react_body_params = client.ReactBodyParams() # ReactBodyParams | 
    is_undo = True # bool |  (необов’язково)
    broadcast_id = 'broadcast_id_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, ReactFeedPostPublicOptions(is_undo=is_undo, broadcast_id=broadcast_id, sso=sso))
        print("The response of PublicApi->react_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->react_feed_post_public: %s\n" % e)

update_feed_post

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

update_feed_post Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.feed_post import FeedPost
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за умовчанням використовує https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# підходить для вашого випадку використання.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    feed_post = client.FeedPost() # FeedPost | 
    try:
        api_response = api_instance.update_feed_post(tenant_id, id, feed_post)
        print("The response of DefaultApi->update_feed_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_feed_post: %s\n" % e)

update_feed_post_public

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	path	Так
postId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: CreateFeedPostResponse

Приклад

Приклад update_feed_post_public

Copy

import client
from client.api.public_api import UpdateFeedPostPublicOptions
from client.models.create_feed_post_response import CreateFeedPostResponse
from client.models.update_feed_post_params import UpdateFeedPostParams
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов'язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    update_feed_post_params = client.UpdateFeedPostParams() # UpdateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, UpdateFeedPostPublicOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of PublicApi->update_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_feed_post_public: %s\n" % e)

flag_comment_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
isFlagged	boolean	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

flag_comment_public Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове і за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Використовуйте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    is_flagged = True # bool | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, sso=sso)
        print("The response of PublicApi->flag_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->flag_comment_public: %s\n" % e)

get_gif_large

Параметри

Name	Type	Location	Required	Description
tenantId	string	path	Так
largeInternalURLSanitized	string	query	Так

Відповідь

Повертає: GifGetLargeResponse

Приклад

get_gif_large Приклад

Copy

import client
from client.models.gif_get_large_response import GifGetLargeResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням встановлено на https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Використайте контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр API-класу
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    large_internal_url_sanitized = 'large_internal_url_sanitized_example' # str | 
    try:
        api_response = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
        print("The response of PublicApi->get_gif_large:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_gif_large: %s\n" % e)

get_gifs_search

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	path	Так
search	string	query	Так
locale	string	query	Ні
rating	string	query	Ні
page	number	query	Ні

Відповідь

Повертає: GetGifsSearchResponse

Приклад

Приклад get_gifs_search

Copy

import client
from client.api.public_api import GetGifsSearchOptions
from client.models.get_gifs_search_response import GetGifsSearchResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлюється https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    search = 'search_example' # str | 
    locale = 'locale_example' # str |  (необов’язково)
    rating = 'rating_example' # str |  (необов’язково)
    page = 3.4 # float |  (необов’язково)
    try:
        api_response = api_instance.get_gifs_search(tenant_id, search, GetGifsSearchOptions(locale=locale, rating=rating, page=page))
        print("The response of PublicApi->get_gifs_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_gifs_search: %s\n" % e)

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	path	Так
locale	string	query	Ні
rating	string	query	Ні
page	number	query	Ні

Відповідь

Повертає: GetGifsTrendingResponse

Приклад

get_gifs_trending Приклад

Copy

import client
from client.api.public_api import GetGifsTrendingOptions
from client.models.get_gifs_trending_response import GetGifsTrendingResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    locale = 'locale_example' # str |  (необов’язково)
    rating = 'rating_example' # str |  (необов’язково)
    page = 3.4 # float |  (необов’язково)
    try:
        api_response = api_instance.get_gifs_trending(tenant_id, GetGifsTrendingOptions(locale=locale, rating=rating, page=page))
        print("The response of PublicApi->get_gifs_trending:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_gifs_trending: %s\n" % e)

add_hash_tag

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateHashTagResponse

Приклад

Приклад add_hash_tag

Copy

import client
from client.models.create_hash_tag_body import CreateHashTagBody
from client.models.create_hash_tag_response import CreateHashTagResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Див. файл configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації надаються нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# Введіть контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_hash_tag_body = client.CreateHashTagBody() # CreateHashTagBody |  (optional)
    try:
        api_response = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
        print("The response of DefaultApi->add_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_hash_tag: %s\n" % e)

add_hash_tags_bulk

Параметри

Ім'я	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes

Відповідь

Повертає: BulkCreateHashTagsResponse

Приклад

Приклад add_hash_tags_bulk

Copy

import client
from client.models.bulk_create_hash_tags_body import BulkCreateHashTagsBody
from client.models.bulk_create_hash_tags_response import BulkCreateHashTagsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо необхідно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_create_hash_tags_body = client.BulkCreateHashTagsBody() # BulkCreateHashTagsBody |  (optional)
    try:
        api_response = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
        print("The response of DefaultApi->add_hash_tags_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_hash_tags_bulk: %s\n" % e)

delete_hash_tag

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
tag	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_hash_tag

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.delete_hash_tag_request_body import DeleteHashTagRequestBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлено https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації надані нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Ввід контексту з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    tag = 'tag_example' # str | 
    delete_hash_tag_request_body = client.DeleteHashTagRequestBody() # DeleteHashTagRequestBody |  (необов'язковий)
    try:
        api_response = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
        print("The response of DefaultApi->delete_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_hash_tag: %s\n" % e)

get_hash_tags

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
page	number	query	Ні

Відповідь

Повертає: GetHashTagsResponse

Приклад

Приклад get_hash_tags

Copy

import client
from client.models.get_hash_tags_response import GetHashTagsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_hash_tags(tenant_id, page=page)
        print("The response of DefaultApi->get_hash_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_hash_tags: %s\n" % e)

patch_hash_tag

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Yes
tag	string	path	Yes

Відповідь

Повертає: UpdateHashTagResponse

Приклад

patch_hash_tag Приклад

Copy

import client
from client.models.update_hash_tag_body import UpdateHashTagBody
from client.models.update_hash_tag_response import UpdateHashTagResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації надаються нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    tag = 'tag_example' # str | 
    update_hash_tag_body = client.UpdateHashTagBody() # UpdateHashTagBody |  (optional)
    try:
        api_response = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
        print("The response of DefaultApi->patch_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_hash_tag: %s\n" % e)

delete_moderation_vote

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Returns: VoteDeleteResponse

Приклад

delete_moderation_vote Приклад

Copy

import client
from client.api.moderation_api import DeleteModerationVoteOptions
from client.models.vote_delete_response import VoteDeleteResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлено https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Ввести контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    vote_id = 'vote_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, DeleteModerationVoteOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->delete_moderation_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->delete_moderation_vote: %s\n" % e)

get_api_comments

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
page	number	query	Ні
count	number	query	Ні
text-search	string	query	Ні
byIPFromComment	string	query	Ні
filters	string	query	Ні
searchFilters	string	query	Ні
sorts	string	query	Ні
demo	boolean	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationAPIGetCommentsResponse

Приклад

Приклад get_api_comments

Copy

import client
from client.api.moderation_api import GetApiCommentsOptions
from client.models.moderation_api_get_comments_response import ModerationAPIGetCommentsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 3.4 # float |  (optional)
    count = 3.4 # float |  (optional)
    text_search = 'text_search_example' # str |  (optional)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (optional)
    filters = 'filters_example' # str |  (optional)
    search_filters = 'search_filters_example' # str |  (optional)
    sorts = 'sorts_example' # str |  (optional)
    demo = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_api_comments(tenant_id, GetApiCommentsOptions(page=page, count=count, text_search=text_search, by_ip_from_comment=by_ip_from_comment, filters=filters, search_filters=search_filters, sorts=sorts, demo=demo, sso=sso))
        print("The response of ModerationApi->get_api_comments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_api_comments: %s\n" % e)

get_api_export_status

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
batchJobId	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationExportStatusResponse

Приклад

get_api_export_status Приклад

Copy

import client
from client.api.moderation_api import GetApiExportStatusOptions
from client.models.moderation_export_status_response import ModerationExportStatusResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Введіть контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str |
    batch_job_id = 'batch_job_id_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_api_export_status(tenant_id, GetApiExportStatusOptions(batch_job_id=batch_job_id, sso=sso))
        print("The response of ModerationApi->get_api_export_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_api_export_status: %s\n" % e)

get_api_ids

Parameters

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
text-search	string	query	Ні
byIPFromComment	string	query	Ні
filters	string	query	Ні
searchFilters	string	query	Ні
afterId	string	query	Ні
demo	boolean	query	Ні
sso	string	query	Ні

Response

Повертає: ModerationAPIGetCommentIdsResponse

Приклад

Приклад get_api_ids

Copy

import client
from client.api.moderation_api import GetApiIdsOptions
from client.models.moderation_api_get_comment_ids_response import ModerationAPIGetCommentIdsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлено https://fastcomments.com
# Перегляньте configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (необов’язково)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (необов’язково)
    filters = 'filters_example' # str |  (необов’язково)
    search_filters = 'search_filters_example' # str |  (необов’язково)
    after_id = 'after_id_example' # str |  (необов’язково)
    demo = True # bool |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_api_ids(tenant_id, GetApiIdsOptions(text_search=text_search, by_ip_from_comment=by_ip_from_comment, filters=filters, search_filters=search_filters, after_id=after_id, demo=demo, sso=sso))
        print("Відповідь ModerationApi->get_api_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Виключення при виклику ModerationApi->get_api_ids: %s\n" % e)

get_ban_users_from_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetBannedUsersFromCommentResponse

Приклад

get_ban_users_from_comment Приклад

Copy

import client
from client.models.get_banned_users_from_comment_response import GetBannedUsersFromCommentResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язковий)
    try:
        api_response = api_instance.get_ban_users_from_comment(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_ban_users_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_ban_users_from_comment: %s\n" % e)

get_comment_ban_status

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetCommentBanStatusResponse

Приклад

get_comment_ban_status Приклад

Copy

import client
from client.models.get_comment_ban_status_response import GetCommentBanStatusResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_comment_ban_status(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_comment_ban_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_comment_ban_status: %s\n" % e)

get_comment_children

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Відповідь

Повертає: ModerationAPIChildCommentsResponse

Приклад

Приклад get_comment_children

Copy

import client
from client.models.moderation_api_child_comments_response import ModerationAPIChildCommentsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту необов'язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_comment_children(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_comment_children:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_comment_children: %s\n" % e)

get_count

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filter	string	query	No
searchFilters	string	query	No
demo	boolean	query	No
sso	string	query	No

Відповідь

Повертає: ModerationAPICountCommentsResponse

Приклад

get_count Приклад

Copy

import client
from client.api.moderation_api import GetCountOptions
from client.models.moderation_api_count_comments_response import ModerationAPICountCommentsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійти у контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (optional)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (optional)
    filter = 'filter_example' # str |  (optional)
    search_filters = 'search_filters_example' # str |  (optional)
    demo = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_count(tenant_id, GetCountOptions(text_search=text_search, by_ip_from_comment=by_ip_from_comment, filter=filter, search_filters=search_filters, demo=demo, sso=sso))
        print("The response of ModerationApi->get_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_count: %s\n" % e)

get_counts

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetBannedUsersCountResponse

Приклад

Приклад get_counts

Copy

import client
from client.models.get_banned_users_count_response import GetBannedUsersCountResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Перегляньте configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (необов’язковий)
    try:
        api_response = api_instance.get_counts(tenant_id, sso=sso)
        print("The response of ModerationApi->get_counts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_counts: %s\n" % e)

get_logs

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Відповідь

Повертає: ModerationAPIGetLogsResponse

Приклад

Приклад get_logs

Copy

import client
from client.models.moderation_api_get_logs_response import ModerationAPIGetLogsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_logs(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_logs: %s\n" % e)

get_manual_badges

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetTenantManualBadgesResponse

Приклад

Приклад get_manual_badges

Copy

import client
from client.models.get_tenant_manual_badges_response import GetTenantManualBadgesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту необов'язкове і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_manual_badges(tenant_id, sso=sso)
        print("The response of ModerationApi->get_manual_badges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_manual_badges: %s\n" % e)

get_manual_badges_for_user

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
badgesUserId	string	query	Ні
commentId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: GetUserManualBadgesResponse

Приклад

Приклад get_manual_badges_for_user

Copy

import client
from client.api.moderation_api import GetManualBadgesForUserOptions
from client.models.get_user_manual_badges_response import GetUserManualBadgesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста не є обов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    badges_user_id = 'badges_user_id_example' # str |  (optional)
    comment_id = 'comment_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_manual_badges_for_user(tenant_id, GetManualBadgesForUserOptions(badges_user_id=badges_user_id, comment_id=comment_id, sso=sso))
        print("The response of ModerationApi->get_manual_badges_for_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_manual_badges_for_user: %s\n" % e)

get_moderation_comment

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

Відповідь

Повертає: ModerationAPICommentResponse

Приклад

Приклад get_moderation_comment

Copy

import client
from client.api.moderation_api import GetModerationCommentOptions
from client.models.moderation_api_comment_response import ModerationAPICommentResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста — необов’язково, за замовчуванням https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    include_email = True # bool |  (необов’язково)
    include_ip = True # bool |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_moderation_comment(tenant_id, comment_id, GetModerationCommentOptions(include_email=include_email, include_ip=include_ip, sso=sso))
        print("The response of ModerationApi->get_moderation_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_moderation_comment: %s\n" % e)

get_moderation_comment_text

Параметри

Ім'я	Тип	Розташування	Обов’язково
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetCommentTextResponse

Приклад

get_moderation_comment_text Приклад

Copy

import client
from client.models.get_comment_text_response import GetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням вказує https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр API класу
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (опціонально)
    try:
        api_response = api_instance.get_moderation_comment_text(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_moderation_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_moderation_comment_text: %s\n" % e)

get_pre_ban_summary

Parameters

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	path	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

Відповідь

Повертає: PreBanSummary

Приклад

get_pre_ban_summary Приклад

Copy

import client
from client.api.moderation_api import GetPreBanSummaryOptions
from client.models.pre_ban_summary import PreBanSummary
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    include_by_user_id_and_email = True # bool |  (необов'язково)
    include_by_ip = True # bool |  (необов'язково)
    include_by_email_domain = True # bool |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_pre_ban_summary(tenant_id, comment_id, GetPreBanSummaryOptions(include_by_user_id_and_email=include_by_user_id_and_email, include_by_ip=include_by_ip, include_by_email_domain=include_by_email_domain, sso=sso))
        print("Відповідь ModerationApi->get_pre_ban_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Виняток під час виклику ModerationApi->get_pre_ban_summary: %s\n" % e)

get_search_comments_summary

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
value	string	query	No
filters	string	query	No
searchFilters	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationCommentSearchResponse

Приклад

Приклад get_search_comments_summary

Copy

import client
from client.api.moderation_api import GetSearchCommentsSummaryOptions
from client.models.moderation_comment_search_response import ModerationCommentSearchResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста не є обов’язковим і за замовчуванням встановлює https://fastcomments.com
# Див. файл configuration.py для списку всіх підтримуваних параметрів налаштування.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (опціонально)
    filters = 'filters_example' # str |  (опціонально)
    search_filters = 'search_filters_example' # str |  (опціонально)
    sso = 'sso_example' # str |  (опціонально)
    try:
        api_response = api_instance.get_search_comments_summary(tenant_id, GetSearchCommentsSummaryOptions(value=value, filters=filters, search_filters=search_filters, sso=sso))
        print("Відповідь ModerationApi->get_search_comments_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Виняток під час виклику ModerationApi->get_search_comments_summary: %s\n" % e)

get_search_pages

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
value	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationPageSearchResponse

Приклад

get_search_pages Приклад

Copy

import client
from client.api.moderation_api import GetSearchPagesOptions
from client.models.moderation_page_search_response import ModerationPageSearchResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_search_pages(tenant_id, GetSearchPagesOptions(value=value, sso=sso))
        print("The response of ModerationApi->get_search_pages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_pages: %s\n" % e)

get_search_sites

Параметри

Ім'я	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
value	string	query	Ні
sso	string	query	Ні

Відповідь

Returns: ModerationSiteSearchResponse

Приклад

get_search_sites Приклад

Copy

import client
from client.api.moderation_api import GetSearchSitesOptions
from client.models.moderation_site_search_response import ModerationSiteSearchResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим та за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (опціонально)
    sso = 'sso_example' # str |  (опціонально)
    try:
        api_response = api_instance.get_search_sites(tenant_id, GetSearchSitesOptions(value=value, sso=sso))
        print("The response of ModerationApi->get_search_sites:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_sites: %s\n" % e)

get_search_suggest

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
text-search	string	query	Ні
sgo	string	query	Ні

Відповідь

Повертає: ModerationSuggestResponse

Приклад

Приклад get_search_suggest

Copy

import client
from client.api.moderation_api import GetSearchSuggestOptions
from client.models.moderation_suggest_response import ModerationSuggestResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста не є обов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_search_suggest(tenant_id, GetSearchSuggestOptions(text_search=text_search, sso=sso))
        print("The response of ModerationApi->get_search_suggest:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_suggest: %s\n" % e)

get_search_users

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
value	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationUserSearchResponse

Приклад

get_search_users Приклад

Copy

import client
from client.api.moderation_api import GetSearchUsersOptions
from client.models.moderation_user_search_response import ModerationUserSearchResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться файл configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.get_search_users(tenant_id, GetSearchUsersOptions(value=value, sso=sso))
        print("The response of ModerationApi->get_search_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_users: %s\n" % e)

get_trust_factor

Параметри

Ім'я	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
userId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: GetUserTrustFactorResponse

Приклад

get_trust_factor Приклад

Copy

import client
from client.api.moderation_api import GetTrustFactorOptions
from client.models.get_user_trust_factor_response import GetUserTrustFactorResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_trust_factor(tenant_id, GetTrustFactorOptions(user_id=user_id, sso=sso))
        print("The response of ModerationApi->get_trust_factor:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_trust_factor: %s\n" % e)

get_user_ban_preference

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes
sso	string	query	No

Відповідь

Повертає: APIModerateGetUserBanPreferencesResponse

Приклад

Приклад get_user_ban_preference

Copy

import client
from client.models.api_moderate_get_user_ban_preferences_response import APIModerateGetUserBanPreferencesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_user_ban_preference(tenant_id, sso=sso)
        print("The response of ModerationApi->get_user_ban_preference:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_user_ban_preference: %s\n" % e)

get_user_internal_profile

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	query	No
sso	string	query	No

Відповідь

Повертає: GetUserInternalProfileResponse

Приклад

get_user_internal_profile Приклад

Copy

import client
from client.api.moderation_api import GetUserInternalProfileOptions
from client.models.get_user_internal_profile_response import GetUserInternalProfileResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Введіть контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_user_internal_profile(tenant_id, GetUserInternalProfileOptions(comment_id=comment_id, sso=sso))
        print("The response of ModerationApi->get_user_internal_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_user_internal_profile: %s\n" % e)

post_adjust_comment_votes

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: AdjustVotesResponse

Приклад

post_adjust_comment_votes Приклад

Copy

import client
from client.api.moderation_api import PostAdjustCommentVotesOptions
from client.models.adjust_comment_votes_params import AdjustCommentVotesParams
from client.models.adjust_votes_response import AdjustVotesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    adjust_comment_votes_params = client.AdjustCommentVotesParams() # AdjustCommentVotesParams | 
    broadcast_id = 'broadcast_id_example' # str |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, PostAdjustCommentVotesOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_adjust_comment_votes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_adjust_comment_votes: %s\n" % e)

post_api_export

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationExportResponse

Приклад

post_api_export Приклад

Copy

import client
from client.api.moderation_api import PostApiExportOptions
from client.models.moderation_export_response import ModerationExportResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (optional)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (optional)
    filters = 'filters_example' # str |  (optional)
    search_filters = 'search_filters_example' # str |  (optional)
    sorts = 'sorts_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_api_export(tenant_id, PostApiExportOptions(text_search=text_search, by_ip_from_comment=by_ip_from_comment, filters=filters, search_filters=search_filters, sorts=sorts, sso=sso))
        print("The response of ModerationApi->post_api_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_api_export: %s\n" % e)

post_ban_user_from_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

Відповідь

Повертає: BanUserFromCommentResult

Приклад

post_ban_user_from_comment Приклад

Copy

import client
from client.api.moderation_api import PostBanUserFromCommentOptions
from client.models.ban_user_from_comment_result import BanUserFromCommentResult
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    ban_email = True # bool |  (optional)
    ban_email_domain = True # bool |  (optional)
    ban_ip = True # bool |  (optional)
    delete_all_users_comments = True # bool |  (optional)
    banned_until = 'banned_until_example' # str |  (optional)
    is_shadow_ban = True # bool |  (optional)
    update_id = 'update_id_example' # str |  (optional)
    ban_reason = 'ban_reason_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_ban_user_from_comment(tenant_id, comment_id, PostBanUserFromCommentOptions(ban_email=ban_email, ban_email_domain=ban_email_domain, ban_ip=ban_ip, delete_all_users_comments=delete_all_users_comments, banned_until=banned_until, is_shadow_ban=is_shadow_ban, update_id=update_id, ban_reason=ban_reason, sso=sso))
        print("The response of ModerationApi->post_ban_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_ban_user_from_comment: %s\n" % e)

post_ban_user_undo

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

post_ban_user_undo Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.ban_user_undo_params import BanUserUndoParams
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    ban_user_undo_params = client.BanUserUndoParams() # BanUserUndoParams | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, sso=sso)
        print("The response of ModerationApi->post_ban_user_undo:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_ban_user_undo: %s\n" % e)

post_bulk_pre_ban_summary

Параметри

Назва	Тип	Локація	Обов’язковий
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

Відповідь

Повертає: BulkPreBanSummary

Приклад

post_bulk_pre_ban_summary Приклад

Copy

import client
from client.api.moderation_api import PostBulkPreBanSummaryOptions
from client.models.bulk_pre_ban_params import BulkPreBanParams
from client.models.bulk_pre_ban_summary import BulkPreBanSummary
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_pre_ban_params = client.BulkPreBanParams() # BulkPreBanParams | 
    include_by_user_id_and_email = True # bool |  (optional)
    include_by_ip = True # bool |  (optional)
    include_by_email_domain = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, PostBulkPreBanSummaryOptions(include_by_user_id_and_email=include_by_user_id_and_email, include_by_ip=include_by_ip, include_by_email_domain=include_by_email_domain, sso=sso))
        print("The response of ModerationApi->post_bulk_pre_ban_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_bulk_pre_ban_summary: %s\n" % e)

post_comments_by_ids

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ModerationAPIChildCommentsResponse

Приклад

post_comments_by_ids Приклад

Copy

import client
from client.models.comments_by_ids_params import CommentsByIdsParams
from client.models.moderation_api_child_comments_response import ModerationAPIChildCommentsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comments_by_ids_params = client.CommentsByIdsParams() # CommentsByIdsParams | 
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, sso=sso)
        print("The response of ModerationApi->post_comments_by_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_comments_by_ids: %s\n" % e)

post_flag_comment

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

post_flag_comment Приклад

Copy

import client
from client.api.moderation_api import PostFlagCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.post_flag_comment(tenant_id, comment_id, PostFlagCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_flag_comment: %s\n" % e)

post_remove_comment

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: PostRemoveCommentApiResponse

Приклад

post_remove_comment Приклад

Copy

import client
from client.api.moderation_api import PostRemoveCommentOptions
from client.models.post_remove_comment_api_response import PostRemoveCommentApiResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_remove_comment(tenant_id, comment_id, PostRemoveCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_remove_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_remove_comment: %s\n" % e)

post_restore_deleted_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

post_restore_deleted_comment Приклад

Copy

import client
from client.api.moderation_api import PostRestoreDeletedCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлено https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.post_restore_deleted_comment(tenant_id, comment_id, PostRestoreDeletedCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_restore_deleted_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_restore_deleted_comment: %s\n" % e)

post_set_comment_approval_status

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
commentId	string	path	Так
approved	boolean	query	Ні
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: SetCommentApprovedResponse

Приклад

Приклад post_set_comment_approval_status

Copy

import client
from client.api.moderation_api import PostSetCommentApprovalStatusOptions
from client.models.set_comment_approved_response import SetCommentApprovedResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    approved = True # bool |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_set_comment_approval_status(tenant_id, comment_id, PostSetCommentApprovalStatusOptions(approved=approved, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_set_comment_approval_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_approval_status: %s\n" % e)

post_set_comment_review_status

Parameters

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

Response

Returns: APIEmptyResponse

Example

Приклад post_set_comment_review_status

Copy

import client
from client.api.moderation_api import PostSetCommentReviewStatusOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов'язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    reviewed = True # bool |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_set_comment_review_status(tenant_id, comment_id, PostSetCommentReviewStatusOptions(reviewed=reviewed, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_set_comment_review_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_review_status: %s\n" % e)

post_set_comment_spam_status

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

post_set_comment_spam_status Приклад

Copy

import client
from client.api.moderation_api import PostSetCommentSpamStatusOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    spam = True # bool |  (optional)
    perm_not_spam = True # bool |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_set_comment_spam_status(tenant_id, comment_id, PostSetCommentSpamStatusOptions(spam=spam, perm_not_spam=perm_not_spam, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_set_comment_spam_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_spam_status: %s\n" % e)

post_set_comment_text

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Returns: SetCommentTextResponse

Приклад

post_set_comment_text Приклад

Copy

import client
from client.api.moderation_api import PostSetCommentTextOptions
from client.models.set_comment_text_params import SetCommentTextParams
from client.models.set_comment_text_response import SetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    set_comment_text_params = client.SetCommentTextParams() # SetCommentTextParams | 
    broadcast_id = 'broadcast_id_example' # str |  (необов'язково)
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, PostSetCommentTextOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_set_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_text: %s\n" % e)

post_un_flag_comment

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Returns: APIEmptyResponse

Приклад

post_un_flag_comment Приклад

Copy

import client
from client.api.moderation_api import PostUnFlagCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Ввести контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (необов'язковий)
    sso = 'sso_example' # str |  (необов'язковий)
    try:
        api_response = api_instance.post_un_flag_comment(tenant_id, comment_id, PostUnFlagCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_un_flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_un_flag_comment: %s\n" % e)

post_vote

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	path	Yes
direction	string	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: VoteResponse

Приклад

post_vote Приклад

Copy

import client
from client.api.moderation_api import PostVoteOptions
from client.models.vote_response import VoteResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    direction = 'direction_example' # str |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_vote(tenant_id, comment_id, PostVoteOptions(direction=direction, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_vote: %s\n" % e)

put_award_badge

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
badgeId	string	query	Так
userId	string	query	Ні
commentId	string	query	Ні
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: AwardUserBadgeResponse

Приклад

put_award_badge Приклад

Copy

import client
from client.api.moderation_api import PutAwardBadgeOptions
from client.models.award_user_badge_response import AwardUserBadgeResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлено https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    badge_id = 'badge_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    comment_id = 'comment_id_example' # str |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.put_award_badge(tenant_id, badge_id, PutAwardBadgeOptions(user_id=user_id, comment_id=comment_id, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->put_award_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_award_badge: %s\n" % e)

put_close_thread

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
urlId	string	query	Yes
sso	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад put_close_thread

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    sso = 'sso_example' # str |  (опціонально)
    try:
        api_response = api_instance.put_close_thread(tenant_id, url_id, sso=sso)
        print("The response of ModerationApi->put_close_thread:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_close_thread: %s\n" % e)

put_remove_badge

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: RemoveUserBadgeResponse

Приклад

Приклад put_remove_badge

Copy

import client
from client.api.moderation_api import PutRemoveBadgeOptions
from client.models.remove_user_badge_response import RemoveUserBadgeResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    badge_id = 'badge_id_example' # str | 
    user_id = 'user_id_example' # str |  (необов’язково)
    comment_id = 'comment_id_example' # str |  (необов’язково)
    broadcast_id = 'broadcast_id_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.put_remove_badge(tenant_id, badge_id, PutRemoveBadgeOptions(user_id=user_id, comment_id=comment_id, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->put_remove_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_remove_badge: %s\n" % e)

put_reopen_thread

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
urlId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

put_reopen_thread Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов’язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Створити контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.put_reopen_thread(tenant_id, url_id, sso=sso)
        print("The response of ModerationApi->put_reopen_thread:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_reopen_thread: %s\n" % e)

set_trust_factor

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
userId	string	query	Ні
trustFactor	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: SetUserTrustFactorResponse

Приклад

set_trust_factor Приклад

Copy

import client
from client.api.moderation_api import SetTrustFactorOptions
from client.models.set_user_trust_factor_response import SetUserTrustFactorResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням дорівнює https://fastcomments.com
# Перегляньте configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (необов’язково)
    trust_factor = 'trust_factor_example' # str |  (необов’язково)
    sso = 'sso_example' # str |  (необов’язково)
    try:
        api_response = api_instance.set_trust_factor(tenant_id, SetTrustFactorOptions(user_id=user_id, trust_factor=trust_factor, sso=sso))
        print("The response of ModerationApi->set_trust_factor:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->set_trust_factor: %s\n" % e)

create_moderator

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так

Відповідь

Повертає: CreateModeratorResponse

Приклад

Приклад create_moderator

Copy

import client
from client.models.create_moderator_body import CreateModeratorBody
from client.models.create_moderator_response import CreateModeratorResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведені приклади для кожного методу автентифікації, використовуйте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_moderator_body = client.CreateModeratorBody() # CreateModeratorBody | 
    try:
        api_response = api_instance.create_moderator(tenant_id, create_moderator_body)
        print("The response of DefaultApi->create_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_moderator: %s\n" % e)

delete_moderator

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
sendEmail	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_moderator

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове; за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче; використайте той
# що відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    send_email = 'send_email_example' # str |  (необов'язково)
    try:
        api_response = api_instance.delete_moderator(tenant_id, id, send_email=send_email)
        print("The response of DefaultApi->delete_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_moderator: %s\n" % e)

get_moderator

Параметри

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

Відповідь

Повертає: GetModeratorResponse

Приклад

Приклад get_moderator

Copy

import client
from client.models.get_moderator_response import GetModeratorResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_moderator(tenant_id, id)
        print("The response of DefaultApi->get_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_moderator: %s\n" % e)

get_moderators

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetModeratorsResponse

Приклад

Приклад get_moderators

Copy

import client
from client.models.get_moderators_response import GetModeratorsResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_moderators(tenant_id, skip=skip)
        print("The response of DefaultApi->get_moderators:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_moderators: %s\n" % e)

send_invite

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
fromName	string	query	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад send_invite

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (e.g. Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    from_name = 'from_name_example' # str | 
    try:
        api_response = api_instance.send_invite(tenant_id, id, from_name)
        print("The response of DefaultApi->send_invite:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_invite: %s\n" % e)

update_moderator

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_moderator

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_moderator_body import UpdateModeratorBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням використовує https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри аутентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання.
#
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_moderator_body = client.UpdateModeratorBody() # UpdateModeratorBody | 
    try:
        api_response = api_instance.update_moderator(tenant_id, id, update_moderator_body)
        print("The response of DefaultApi->update_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_moderator: %s\n" % e)

delete_notification_count

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_notification_count

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому випадку автентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_notification_count(tenant_id, id)
        print("The response of DefaultApi->delete_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_notification_count: %s\n" % e)

get_cached_notification_count

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetCachedNotificationCountResponse

Приклад

Приклад get_cached_notification_count

Copy

import client
from client.models.get_cached_notification_count_response import GetCachedNotificationCountResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведено нижче; використайте той приклад, який
# відповідає вашому сценарію автентифікації.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійти в контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_cached_notification_count(tenant_id, id)
        print("The response of DefaultApi->get_cached_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_cached_notification_count: %s\n" % e)

get_notification_count

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
userId	string	query	Ні
urlId	string	query	Ні
fromCommentId	string	query	Ні
viewed	boolean	query	Ні
type	string	query	Ні

Відповідь

Повертає: GetNotificationCountResponse

Приклад

get_notification_count Приклад

Copy

import client
from client.api.default_api import GetNotificationCountOptions
from client.models.get_notification_count_response import GetNotificationCountResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте той приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API‑ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб задати префікс (наприклад, Bearer) для API‑ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    url_id = 'url_id_example' # str |  (optional)
    from_comment_id = 'from_comment_id_example' # str |  (optional)
    viewed = True # bool |  (optional)
    type = 'type_example' # str |  (optional)
    try:
        api_response = api_instance.get_notification_count(tenant_id, GetNotificationCountOptions(user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type))
        print("Відповідь DefaultApi->get_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Виняток при виклику DefaultApi->get_notification_count: %s\n" % e)

get_notifications

Parameters

Назва	Тип	Розташування	Обов’язково
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

Відповідь

Повертає: GetNotificationsResponse

Приклад

Приклад get_notifications

Copy

import client
from client.api.default_api import GetNotificationsOptions
from client.models.get_notifications_response import GetNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад,
# який відповідає вашому випадку використання.
 
# Налаштування авторизації за допомогою API‑ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API‑ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з інстансом API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створити інстанс класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (необов’язковий)
    url_id = 'url_id_example' # str |  (необов’язковий)
    from_comment_id = 'from_comment_id_example' # str |  (необов’язковий)
    viewed = True # bool |  (необов’язковий)
    type = 'type_example' # str |  (необов’язковий)
    skip = 3.4 # float |  (необов’язковий)
    try:
        api_response = api_instance.get_notifications(tenant_id, GetNotificationsOptions(user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type, skip=skip))
        print("The response of DefaultApi->get_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_notifications: %s\n" % e)

update_notification

Parameters

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

Response

Повертає: APIEmptyResponse

Example

Приклад update_notification

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_notification_body import UpdateNotificationBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки серверу API.
# Нижче наведені приклади для кожного методу автентифікації, використайте той,
# який відповідає вашому випадку використання.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_notification_body = client.UpdateNotificationBody() # UpdateNotificationBody | 
    user_id = 'user_id_example' # str |  (optional)
    try:
        api_response = api_instance.update_notification(tenant_id, id, update_notification_body, user_id=user_id)
        print("The response of DefaultApi->update_notification:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_notification: %s\n" % e)

create_v1_page_react

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
urlId	string	query	Так
title	string	query	Ні

Відповідь

Повертає: CreateV1PageReact

Приклад

Приклад create_v1_page_react

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# Вказування хоста необов'язкове — за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    title = 'title_example' # str |  (необов'язково)
    try:
        api_response = api_instance.create_v1_page_react(tenant_id, url_id, title=title)
        print("The response of PublicApi->create_v1_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_v1_page_react: %s\n" % e)

create_v2_page_react

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
urlId	string	query	Так
id	string	query	Так
title	string	query	Ні

Відповідь

Повертає: CreateV1PageReact

Приклад

Приклад create_v2_page_react

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    id = 'id_example' # str | 
    title = 'title_example' # str |  (необов'язково)
    try:
        api_response = api_instance.create_v2_page_react(tenant_id, url_id, id, title=title)
        print("The response of PublicApi->create_v2_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_v2_page_react: %s\n" % e)

delete_v1_page_react

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	path	Так
urlId	string	query	Так

Відповідь

Повертає: CreateV1PageReact

Приклад

Приклад delete_v1_page_react

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове й за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.delete_v1_page_react(tenant_id, url_id)
        print("The response of PublicApi->delete_v1_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_v1_page_react: %s\n" % e)

delete_v2_page_react

Параметри

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

Response

Повертає: CreateV1PageReact

Example

Приклад delete_v2_page_react

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# Визначення host є необов'язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_v2_page_react(tenant_id, url_id, id)
        print("The response of PublicApi->delete_v2_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_v2_page_react: %s\n" % e)

get_v1_page_likes

Параметри

Name	Type	Location	Required	Description
tenantId	string	path	Так
urlId	string	query	Так

Відповідь

Повертає: GetV1PageLikes

Приклад

Приклад get_v1_page_likes

Copy

import client
from client.models.get_v1_page_likes import GetV1PageLikes
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_v1_page_likes(tenant_id, url_id)
        print("The response of PublicApi->get_v1_page_likes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_v1_page_likes: %s\n" % e)

get_v2_page_react_users

Параметри

Назва	Тип	Location	Обов'язково
tenantId	string	path	Так
urlId	string	query	Так
id	string	query	Так

Відповідь

Повертає: GetV2PageReactUsersResponse

Приклад

Приклад get_v2_page_react_users

Copy

import client
from client.models.get_v2_page_react_users_response import GetV2PageReactUsersResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
        print("The response of PublicApi->get_v2_page_react_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_v2_page_react_users: %s\n" % e)

get_v2_page_reacts

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	path	Так
urlId	string	query	Так

Відповідь

Повертає: GetV2PageReacts

Приклад

Приклад get_v2_page_reacts

Copy

import client
from client.models.get_v2_page_reacts import GetV2PageReacts
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкриваємо контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створюємо екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_v2_page_reacts(tenant_id, url_id)
        print("The response of PublicApi->get_v2_page_reacts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_v2_page_reacts: %s\n" % e)

add_page

Параметри

Ім'я	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: AddPageAPIResponse

Приклад

Приклад add_page

Copy

import client
from client.models.add_page_api_response import AddPageAPIResponse
from client.models.create_api_page_data import CreateAPIPageData
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (e.g. Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст із екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_api_page_data = client.CreateAPIPageData() # CreateAPIPageData | 
    try:
        api_response = api_instance.add_page(tenant_id, create_api_page_data)
        print("The response of DefaultApi->add_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_page: %s\n" % e)

delete_page

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: DeletePageAPIResponse

Приклад

Приклад delete_page

Copy

import client
from client.models.delete_page_api_response import DeletePageAPIResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_page(tenant_id, id)
        print("The response of DefaultApi->delete_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_page: %s\n" % e)

get_offline_users

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	path	Так
urlId	string	query	Так	Ідентифікатор URL сторінки (очищений на сервері).
afterName	string	query	Ні	Курсор: передайте nextAfterName з попередньої відповіді.
afterUserId	string	query	Ні	Тай-брейкер курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли встановлено afterName, щоб уникнути пропуску записів через однакові імена.

Відповідь

Returns: PageUsersOfflineResponse

Приклад

get_offline_users Приклад

Copy

import client
from client.api.public_api import GetOfflineUsersOptions
from client.models.page_users_offline_response import PageUsersOfflineResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | Ідентифікатор URL сторінки (очищений на сервері).
    after_name = 'after_name_example' # str | Курсор: передайте nextAfterName з попередньої відповіді. (необов’язково)
    after_user_id = 'after_user_id_example' # str | Тай-брейкер курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли afterName встановлений, щоб уникнути пропуску записів через однакові імена. (необов’язково)
    try:
        api_response = api_instance.get_offline_users(tenant_id, url_id, GetOfflineUsersOptions(after_name=after_name, after_user_id=after_user_id))
        print("The response of PublicApi->get_offline_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_offline_users: %s\n" % e)

get_online_users

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Parameters

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	path	Yes
urlId	string	query	Yes	Ідентифікатор URL сторінки (очищений на боці сервера).
afterName	string	query	No	Курсор: передайте nextAfterName з попередньої відповіді.
afterUserId	string	query	No	Тай-брейкер курсору: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли встановлено afterName, щоб уникнути втрати записів через однакові імена.

Response

Повертає: PageUsersOnlineResponse

Example

Приклад get_online_users

Copy

import client
from client.api.public_api import GetOnlineUsersOptions
from client.models.page_users_online_response import PageUsersOnlineResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням = https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з інстанцією клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть інстанцію класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | Ідентифікатор URL сторінки (очищений на боці сервера).
    after_name = 'after_name_example' # str | Курсор: передайте nextAfterName з попередньої відповіді. (необов’язково)
    after_user_id = 'after_user_id_example' # str | Тай-брейкер курсору: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли afterName встановлено, щоб уникнути втрати записів через однакові імена. (необов’язково)
    try:
        api_response = api_instance.get_online_users(tenant_id, url_id, GetOnlineUsersOptions(after_name=after_name, after_user_id=after_user_id))
        print("The response of PublicApi->get_online_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_online_users: %s\n" % e)

get_page_by_urlid

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
urlId	string	query	Так

Відповідь

Повертає: GetPageByURLIdAPIResponse

Приклад

Приклад get_page_by_urlid

Copy

import client
from client.models.get_page_by_urlid_api_response import GetPageByURLIdAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому випадку автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_page_by_urlid(tenant_id, url_id)
        print("The response of DefaultApi->get_page_by_urlid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_page_by_urlid: %s\n" % e)

get_pages

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так

Відповідь

Повертає: GetPagesAPIResponse

Приклад

Приклад get_pages

Copy

import client
from client.models.get_pages_api_response import GetPagesAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте той, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_pages(tenant_id)
        print("The response of DefaultApi->get_pages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pages: %s\n" % e)

get_pages_public

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

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	path	Так
cursor	string	query	Ні	Непрозорий курсор пагінації, повернутий як `nextCursor` у попередньому запиті. Прив'язаний до того ж `sortBy`.
limit	integer	query	Ні	1..200, за замовчуванням 50
q	string	query	Ні	Необов'язковий нечутливий до регістру фільтр префіксу назви.
sortBy	string	query	Ні	Порядок сортування. `updatedAt` (за замовчуванням, новіші першими), `commentCount` (найбільше коментарів спочатку), або `title` (за алфавітом).
hasComments	boolean	query	Ні	Якщо true, повертаються лише сторінки з принаймні одним коментарем.

Відповідь

Повертає: GetPublicPagesResponse

Приклад

get_pages_public Приклад

Copy

import client
from client.api.public_api import GetPagesPublicOptions
from client.models.get_public_pages_response import GetPublicPagesResponse
from client.models.pages_sort_by import PagesSortBy
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    cursor = 'cursor_example' # str | Непрозорий курсор пагінації, повернутий як `nextCursor` у попередньому запиті. Прив'язаний до того ж `sortBy`. (optional)
    limit = 56 # int | 1..200, за замовчуванням 50 (optional)
    q = 'q_example' # str | Необов'язковий нечутливий до регістру фільтр префіксу назви. (optional)
    sort_by = client.PagesSortBy() # PagesSortBy | Порядок сортування. `updatedAt` (за замовчуванням, новіші першими), `commentCount` (найбільше коментарів спочатку), або `title` (за алфавітом). (optional)
    has_comments = True # bool | Якщо true, повертаються лише сторінки з принаймні одним коментарем. (optional)
    try:
        api_response = api_instance.get_pages_public(tenant_id, GetPagesPublicOptions(cursor=cursor, limit=limit, q=q, sort_by=sort_by, has_comments=has_comments))
        print("The response of PublicApi->get_pages_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_pages_public: %s\n" % e)

get_users_info

Масова інформація про користувачів для тенанта. За заданими userIds повертає відображувану інформацію з User / SSOUser. Використовується віджетом коментарів для доповнення інформації про користувачів, які щойно з’явилися через подію присутності. Без контексту сторінки: конфіденційність застосовується однаково (приватні профілі маскуються).

Параметри

Name	Type	Location	Required	Description
tenantId	string	path	Yes
ids	string	query	Yes	userIds, розділені комами.

Відповідь

Повертає: PageUsersInfoResponse

Приклад

Приклад get_users_info

Copy

import client
from client.models.page_users_info_response import PageUsersInfoResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове й за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкриваємо контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створюємо екземпляр API-класу
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    ids = 'ids_example' # str | userIds, розділені комами.
    try:
        api_response = api_instance.get_users_info(tenant_id, ids)
        print("The response of PublicApi->get_users_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_users_info: %s\n" % e)

patch_page

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: PatchPageAPIResponse

Приклад

patch_page Приклад

Copy

import client
from client.models.patch_page_api_response import PatchPageAPIResponse
from client.models.update_api_page_data import UpdateAPIPageData
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведені приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому сценарію автентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_api_page_data = client.UpdateAPIPageData() # UpdateAPIPageData | 
    try:
        api_response = api_instance.patch_page(tenant_id, id, update_api_page_data)
        print("The response of DefaultApi->patch_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_page: %s\n" % e)

delete_pending_webhook_event

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_pending_webhook_event

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації; використайте той, що
# відповідає вашому випадку використання.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_pending_webhook_event(tenant_id, id)
        print("The response of DefaultApi->delete_pending_webhook_event:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_pending_webhook_event: %s\n" % e)

get_pending_webhook_event_count

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

Відповідь

Повертає: GetPendingWebhookEventCountResponse

Приклад

get_pending_webhook_event_count Приклад

Copy

import client
from client.api.default_api import GetPendingWebhookEventCountOptions
from client.models.get_pending_webhook_event_count_response import GetPendingWebhookEventCountResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлено https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації надано нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з інстансом API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть інстанс класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (необов'язково)
    external_id = 'external_id_example' # str |  (необов'язково)
    event_type = 'event_type_example' # str |  (необов'язково)
    type = 'type_example' # str |  (необов'язково)
    domain = 'domain_example' # str |  (необов'язково)
    attempt_count_gt = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_pending_webhook_event_count(tenant_id, GetPendingWebhookEventCountOptions(comment_id=comment_id, external_id=external_id, event_type=event_type, type=type, domain=domain, attempt_count_gt=attempt_count_gt))
        print("The response of DefaultApi->get_pending_webhook_event_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pending_webhook_event_count: %s\n" % e)

get_pending_webhook_events

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	query	Ні
externalId	string	query	Ні
eventType	string	query	Ні
type	string	query	Ні
domain	string	query	Ні
attemptCountGT	number	query	Ні
skip	number	query	Ні

Відповідь

Повертає: GetPendingWebhookEventsResponse

Приклад

Приклад get_pending_webhook_events

Copy

import client
from client.api.default_api import GetPendingWebhookEventsOptions
from client.models.get_pending_webhook_events_response import GetPendingWebhookEventsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлено https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# згідно з політикою безпеки API сервера.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (optional)
    external_id = 'external_id_example' # str |  (optional)
    event_type = 'event_type_example' # str |  (optional)
    type = 'type_example' # str |  (optional)
    domain = 'domain_example' # str |  (optional)
    attempt_count_gt = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_pending_webhook_events(tenant_id, GetPendingWebhookEventsOptions(comment_id=comment_id, external_id=external_id, event_type=event_type, type=type, domain=domain, attempt_count_gt=attempt_count_gt, skip=skip))
        print("The response of DefaultApi->get_pending_webhook_events:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pending_webhook_events: %s\n" % e)

create_question_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так

Відповідь

Повертає: CreateQuestionConfigResponse

Приклад

Приклад create_question_config

Copy

import client
from client.models.create_question_config_body import CreateQuestionConfigBody
from client.models.create_question_config_response import CreateQuestionConfigResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста опційне і за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте той,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_question_config_body = client.CreateQuestionConfigBody() # CreateQuestionConfigBody | 
    try:
        api_response = api_instance.create_question_config(tenant_id, create_question_config_body)
        print("The response of DefaultApi->create_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_question_config: %s\n" % e)

delete_question_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_question_config

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для переліку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Нижче наведено приклади для кожного методу автентифікації; використайте той
# який відповідає вашому сценарію автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр API-класу
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_config(tenant_id, id)
        print("The response of DefaultApi->delete_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_question_config: %s\n" % e)

get_question_config

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetQuestionConfigResponse

Приклад

Приклад get_question_config

Copy

import client
from client.models.get_question_config_response import GetQuestionConfigResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове й за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для переліку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# задовольняє ваш сценарій автентифікації.
# Налаштувати авторизацію через API-ключ: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійти в контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_question_config(tenant_id, id)
        print("The response of DefaultApi->get_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_config: %s\n" % e)

get_question_configs

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetQuestionConfigsResponse

Приклад

Приклад get_question_configs

Copy

import client
from client.models.get_question_configs_response import GetQuestionConfigsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host-адреси необов'язкове й за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використовуйте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_question_configs(tenant_id, skip=skip)
        print("The response of DefaultApi->get_question_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_configs: %s\n" % e)

update_question_config

Параметри

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

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_question_config

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_question_config_body import UpdateQuestionConfigBody
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_config_body = client.UpdateQuestionConfigBody() # UpdateQuestionConfigBody | 
    try:
        api_response = api_instance.update_question_config(tenant_id, id, update_question_config_body)
        print("The response of DefaultApi->update_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_config: %s\n" % e)

create_question_result

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateQuestionResultResponse

Приклад

Приклад create_question_result

Copy

import client
from client.models.create_question_result_body import CreateQuestionResultBody
from client.models.create_question_result_response import CreateQuestionResultResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте той,
# який відповідає вашому сценарію використання.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_question_result_body = client.CreateQuestionResultBody() # CreateQuestionResultBody | 
    try:
        api_response = api_instance.create_question_result(tenant_id, create_question_result_body)
        print("The response of DefaultApi->create_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_question_result: %s\n" % e)

delete_question_result

Параметри

Ім'я	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

delete_question_result Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням — https://fastcomments.com
# Дивіться configuration.py для переліку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації; використайте приклад,
# що відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою ключа API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_result(tenant_id, id)
        print("The response of DefaultApi->delete_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_question_result: %s\n" % e)

get_question_result

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetQuestionResultResponse

Приклад

Приклад get_question_result

Copy

import client
from client.models.get_question_result_response import GetQuestionResultResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу аутентифікації — використайте той,
# який відповідає вашому випадку.
 
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_question_result(tenant_id, id)
        print("The response of DefaultApi->get_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_result: %s\n" % e)

get_question_results

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
urlId	string	query	No
userId	string	query	No
startDate	string	query	No
questionId	string	query	No
questionIds	string	query	No
skip	number	query	No

Відповідь

Повертає: GetQuestionResultsResponse

Приклад

Приклад get_question_results

Copy

import client
from client.api.default_api import GetQuestionResultsOptions
from client.models.get_question_results_response import GetQuestionResultsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлено https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який підходить для вашого випадку.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str |  (необов’язковий)
    user_id = 'user_id_example' # str |  (необов’язковий)
    start_date = 'start_date_example' # str |  (необов’язковий)
    question_id = 'question_id_example' # str |  (необов’язковий)
    question_ids = 'question_ids_example' # str |  (необов’язковий)
    skip = 3.4 # float |  (необов’язковий)
    try:
        api_response = api_instance.get_question_results(tenant_id, GetQuestionResultsOptions(url_id=url_id, user_id=user_id, start_date=start_date, question_id=question_id, question_ids=question_ids, skip=skip))
        print("The response of DefaultApi->get_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_results: %s\n" % e)

update_question_result

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_question_result

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_question_result_body import UpdateQuestionResultBody
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове та за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштуйте авторизацію API ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_result_body = client.UpdateQuestionResultBody() # UpdateQuestionResultBody | 
    try:
        api_response = api_instance.update_question_result(tenant_id, id, update_question_result_body)
        print("The response of DefaultApi->update_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_result: %s\n" % e)

aggregate_question_results

Parameters

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
questionId	string	query	Ні
questionIds	array	query	Ні
urlId	string	query	Ні
timeBucket	string	query	Ні
startDate	string	query	Ні
forceRecalculate	boolean	query	Ні

Відповідь

Повертає: AggregateQuestionResultsResponse

Приклад

aggregate_question_results Приклад

Copy

import client
from client.api.default_api import AggregateQuestionResultsOptions
from client.models.aggregate_question_results_response import AggregateQuestionResultsResponse
from client.models.aggregate_time_bucket import AggregateTimeBucket
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлюється https://fastcomments.com
# Дивіться configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації надані нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    question_id = 'question_id_example' # str |  (optional)
    question_ids = ['question_ids_example'] # List[str] |  (optional)
    url_id = 'url_id_example' # str |  (optional)
    time_bucket = client.AggregateTimeBucket() # AggregateTimeBucket |  (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    force_recalculate = True # bool |  (optional)
    try:
        api_response = api_instance.aggregate_question_results(tenant_id, AggregateQuestionResultsOptions(question_id=question_id, question_ids=question_ids, url_id=url_id, time_bucket=time_bucket, start_date=start_date, force_recalculate=force_recalculate))
        print("The response of DefaultApi->aggregate_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->aggregate_question_results: %s\n" % e)

bulk_aggregate_question_results

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
forceRecalculate	boolean	query	Ні

Відповідь

Повертає: BulkAggregateQuestionResultsResponse

Приклад

Приклад bulk_aggregate_question_results

Copy

import client
from client.models.bulk_aggregate_question_results_request import BulkAggregateQuestionResultsRequest
from client.models.bulk_aggregate_question_results_response import BulkAggregateQuestionResultsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використовуйте приклад, який
# відповідає вашому сценарію автентифікації.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_aggregate_question_results_request = client.BulkAggregateQuestionResultsRequest() # BulkAggregateQuestionResultsRequest | 
    force_recalculate = True # bool |  (необов'язково)
    try:
        api_response = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, force_recalculate=force_recalculate)
        print("The response of DefaultApi->bulk_aggregate_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->bulk_aggregate_question_results: %s\n" % e)

combine_comments_with_question_results

Параметри

Ім'я	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No
minValue	number	query	No
maxValue	number	query	No
limit	number	query	No

Відповідь

Повертає: CombineQuestionResultsWithCommentsResponse

Приклад

combine_comments_with_question_results Приклад

Copy

import client
from client.api.default_api import CombineCommentsWithQuestionResultsOptions
from client.models.combine_question_results_with_comments_response import CombineQuestionResultsWithCommentsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад, який
# задовольняє ваш випадок використання автентифікації.
# Налаштування авторизації API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, при потребі
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    question_id = 'question_id_example' # str |  (optional)
    question_ids = ['question_ids_example'] # List[str] |  (optional)
    url_id = 'url_id_example' # str |  (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    force_recalculate = True # bool |  (optional)
    min_value = 3.4 # float |  (optional)
    max_value = 3.4 # float |  (optional)
    limit = 3.4 # float |  (optional)
    try:
        api_response = api_instance.combine_comments_with_question_results(tenant_id, CombineCommentsWithQuestionResultsOptions(question_id=question_id, question_ids=question_ids, url_id=url_id, start_date=start_date, force_recalculate=force_recalculate, min_value=min_value, max_value=max_value, limit=limit))
        print("The response of DefaultApi->combine_comments_with_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->combine_comments_with_question_results: %s\n" % e)

add_sso_user

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	параметр запиту	Так

Відповідь

Повертає: AddSSOUserAPIResponse

Приклад

Приклад add_sso_user

Copy

import client
from client.models.add_sso_user_api_response import AddSSOUserAPIResponse
from client.models.create_apisso_user_data import CreateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте той,
# який відповідає вашому випадку використання.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_apisso_user_data = client.CreateAPISSOUserData() # CreateAPISSOUserData | 
    try:
        api_response = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
        print("The response of DefaultApi->add_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_sso_user: %s\n" % e)

delete_sso_user

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	boolean	query	No
commentDeleteMode	string	query	No

Відповідь

Повертає: DeleteSSOUserAPIResponse

Приклад

delete_sso_user Приклад

Copy

import client
from client.api.default_api import DeleteSsoUserOptions
from client.models.delete_sso_user_api_response import DeleteSSOUserAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри аутентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації надано нижче, використайте приклад який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за ключем API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    delete_comments = True # bool |  (optional)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (optional)
    try:
        api_response = api_instance.delete_sso_user(tenant_id, id, DeleteSsoUserOptions(delete_comments=delete_comments, comment_delete_mode=comment_delete_mode))
        print("The response of DefaultApi->delete_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_sso_user: %s\n" % e)

get_sso_user_by_email

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
email	string	path	Так

Відповідь

Повертає: GetSSOUserByEmailAPIResponse

Приклад

Приклад get_sso_user_by_email

Copy

import client
from client.models.get_sso_user_by_email_api_response import GetSSOUserByEmailAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри аутентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації; використайте приклад,
# який відповідає вашому випадку використання.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    email = 'email_example' # str | 
    try:
        api_response = api_instance.get_sso_user_by_email(tenant_id, email)
        print("The response of DefaultApi->get_sso_user_by_email:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_user_by_email: %s\n" % e)

get_sso_user_by_id

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetSSOUserByIdAPIResponse

Приклад

Приклад get_sso_user_by_id

Copy

import client
from client.models.get_sso_user_by_id_api_response import GetSSOUserByIdAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host не обов'язкове і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_sso_user_by_id(tenant_id, id)
        print("The response of DefaultApi->get_sso_user_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_user_by_id: %s\n" % e)

get_sso_users

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	integer	query	Ні

Відповідь

Повертає: GetSSOUsersResponse

Приклад

Приклад get_sso_users

Copy

import client
from client.models.get_sso_users_response import GetSSOUsersResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням дорівнює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 56 # int |  (необов'язково)
    try:
        api_response = api_instance.get_sso_users(tenant_id, skip=skip)
        print("The response of DefaultApi->get_sso_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_users: %s\n" % e)

patch_sso_user

Параметри

Ім'я	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
updateComments	boolean	query	Ні

Відповідь

Повертає: PatchSSOUserAPIResponse

Приклад

patch_sso_user Приклад

Copy

import client
from client.models.patch_sso_user_api_response import PatchSSOUserAPIResponse
from client.models.update_apisso_user_data import UpdateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням — https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використовуйте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації через API-ключ: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  (optional)
    try:
        api_response = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, update_comments=update_comments)
        print("The response of DefaultApi->patch_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_sso_user: %s\n" % e)

put_sso_user

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
id	string	path	Так
updateComments	boolean	query	Ні

Відповідь

Повертає: PutSSOUserAPIResponse

Приклад

Приклад put_sso_user

Copy

import client
from client.models.put_sso_user_api_response import PutSSOUserAPIResponse
from client.models.update_apisso_user_data import UpdateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведені приклади для кожного методу автентифікації — використайте той,
# який відповідає вашому випадку використання.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо це необхідно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст, використовуючи екземпляр клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  (необов'язково)
    try:
        api_response = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, update_comments=update_comments)
        print("The response of DefaultApi->put_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->put_sso_user: %s\n" % e)

create_subscription

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

Приклад create_subscription

Copy

import client
from client.models.create_api_user_subscription_data import CreateAPIUserSubscriptionData
from client.models.create_subscription_api_response import CreateSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням використовує https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу аутентифікації — використайте той,
# який відповідає вашому випадку використання.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_api_user_subscription_data = client.CreateAPIUserSubscriptionData() # CreateAPIUserSubscriptionData | 
    try:
        api_response = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
        print("The response of DefaultApi->create_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_subscription: %s\n" % e)

delete_subscription

Параметри

Назва	Тип	Location	Обов'язково
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні

Відповідь

Повертає: DeleteSubscriptionAPIResponse

Приклад

Приклад delete_subscription

Copy

import client
from client.models.delete_subscription_api_response import DeleteSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведено нижче, використайте той приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (необов'язково)
    try:
        api_response = api_instance.delete_subscription(tenant_id, id, user_id=user_id)
        print("The response of DefaultApi->delete_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_subscription: %s\n" % e)

get_subscriptions

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
userId	string	query	Ні

Відповідь

Повертає: GetSubscriptionsAPIResponse

Приклад

Приклад get_subscriptions

Copy

import client
from client.models.get_subscriptions_api_response import GetSubscriptionsAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використайте той приклад, який
# відповідає вашому сценарію автентифікації.
# Налаштування авторизації за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_subscriptions(tenant_id, user_id=user_id)
        print("The response of DefaultApi->get_subscriptions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_subscriptions: %s\n" % e)

update_subscription

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні

Відповідь

Повертає: UpdateSubscriptionAPIResponse

Приклад

Приклад update_subscription

Copy

import client
from client.models.update_api_user_subscription_data import UpdateAPIUserSubscriptionData
from client.models.update_subscription_api_response import UpdateSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому сценарію використання.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_api_user_subscription_data = client.UpdateAPIUserSubscriptionData() # UpdateAPIUserSubscriptionData | 
    user_id = 'user_id_example' # str |  (необов'язково)
    try:
        api_response = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, user_id=user_id)
        print("The response of DefaultApi->update_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_subscription: %s\n" % e)

get_tenant_daily_usages

Параметри

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

Відповідь

Returns: GetTenantDailyUsagesResponse

Приклад

Приклад get_tenant_daily_usages

Copy

import client
from client.api.default_api import GetTenantDailyUsagesOptions
from client.models.get_tenant_daily_usages_response import GetTenantDailyUsagesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за API‑ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API‑ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API‑клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    year_number = 3.4 # float |  (необов’язковий)
    month_number = 3.4 # float |  (необов’язковий)
    day_number = 3.4 # float |  (необов’язковий)
    skip = 3.4 # float |  (необов’язковий)
    try:
        api_response = api_instance.get_tenant_daily_usages(tenant_id, GetTenantDailyUsagesOptions(year_number=year_number, month_number=month_number, day_number=day_number, skip=skip))
        print("The response of DefaultApi->get_tenant_daily_usages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_daily_usages: %s\n" % e)

create_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateTenantPackageResponse

Приклад

Приклад create_tenant_package

Copy

import client
from client.models.create_tenant_package_body import CreateTenantPackageBody
from client.models.create_tenant_package_response import CreateTenantPackageResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_package_body = client.CreateTenantPackageBody() # CreateTenantPackageBody | 
    try:
        api_response = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
        print("The response of DefaultApi->create_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant_package: %s\n" % e)

delete_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_tenant_package

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# підходить для вашого сценарію автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_tenant_package(tenant_id, id)
        print("The response of DefaultApi->delete_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant_package: %s\n" % e)

get_tenant_package

Parameters

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Response

Повертає: GetTenantPackageResponse

Приклад

Приклад get_tenant_package

Copy

import client
from client.models.get_tenant_package_response import GetTenantPackageResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу авторизації, використовуйте приклад, який
# відповідає вашому випадку використання авторизації.
# Налаштуйте авторизацію за API-ключем: api_key
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_package(tenant_id, id)
        print("The response of DefaultApi->get_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_package: %s\n" % e)

get_tenant_packages

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetTenantPackagesResponse

Приклад

Приклад get_tenant_packages

Copy

import client
from client.models.get_tenant_packages_response import GetTenantPackagesResponse
from client.rest import ApiException
from pprint import pprint
# Встановлення host необов'язкове й за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки серверу API.
# Приклади для кожного методу автентифікації наведено нижче; використайте той, що
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_tenant_packages(tenant_id, skip=skip)
        print("The response of DefaultApi->get_tenant_packages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_packages: %s\n" % e)

replace_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

replace_tenant_package Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.replace_tenant_package_body import ReplaceTenantPackageBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведені приклади для кожного методу автентифікації — використовуйте приклад,
# який відповідає вашому випадку використання.
# Налаштуйте авторизацію API ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    replace_tenant_package_body = client.ReplaceTenantPackageBody() # ReplaceTenantPackageBody | 
    try:
        api_response = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
        print("The response of DefaultApi->replace_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_tenant_package: %s\n" % e)

update_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_tenant_package

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_tenant_package_body import UpdateTenantPackageBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використовуйте той,
# що відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_package_body = client.UpdateTenantPackageBody() # UpdateTenantPackageBody | 
    try:
        api_response = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
        print("The response of DefaultApi->update_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_package: %s\n" % e)

create_tenant_user

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так

Відповідь

Повертає: CreateTenantUserResponse

Приклад

create_tenant_user Приклад

Copy

import client
from client.models.create_tenant_user_body import CreateTenantUserBody
from client.models.create_tenant_user_response import CreateTenantUserResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове і за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки серверу API.
# Приклади для кожного методу автентифікації наведені нижче — використайте той,
# який відповідає вашому випадку використання.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб задати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_user_body = client.CreateTenantUserBody() # CreateTenantUserBody | 
    try:
        api_response = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
        print("The response of DefaultApi->create_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant_user: %s\n" % e)

delete_tenant_user

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_tenant_user

Copy

import client
from client.api.default_api import DeleteTenantUserOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# згідно з політикою безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    delete_comments = 'delete_comments_example' # str |  (optional)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (optional)
    try:
        api_response = api_instance.delete_tenant_user(tenant_id, id, DeleteTenantUserOptions(delete_comments=delete_comments, comment_delete_mode=comment_delete_mode))
        print("The response of DefaultApi->delete_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant_user: %s\n" % e)

get_tenant_user

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetTenantUserResponse

Приклад

Приклад get_tenant_user

Copy

import client
from client.models.get_tenant_user_response import GetTenantUserResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведені приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому сценарію автентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_user(tenant_id, id)
        print("The response of DefaultApi->get_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_user: %s\n" % e)

get_tenant_users

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetTenantUsersResponse

Приклад

Приклад get_tenant_users

Copy

import client
from client.models.get_tenant_users_response import GetTenantUsersResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче — використовуйте приклад, який
# відповідає вашому випадку використання автентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (необов'язково)
    try:
        api_response = api_instance.get_tenant_users(tenant_id, skip=skip)
        print("The response of DefaultApi->get_tenant_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_users: %s\n" % e)

replace_tenant_user

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
updateComments	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

replace_tenant_user Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.replace_tenant_user_body import ReplaceTenantUserBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад,
# який відповідає вашому випадку використання.
#
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    replace_tenant_user_body = client.ReplaceTenantUserBody() # ReplaceTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (необов'язково)
    try:
        api_response = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->replace_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_tenant_user: %s\n" % e)

Параметри

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

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад send_login_link

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове, за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації; використайте приклад, який
# відповідає вашому випадку використання.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    redirect_url = 'redirect_url_example' # str |  (необов'язково)
    try:
        api_response = api_instance.send_login_link(tenant_id, id, redirect_url=redirect_url)
        print("The response of DefaultApi->send_login_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_login_link: %s\n" % e)

update_tenant_user

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
updateComments	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

update_tenant_user Приклад

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_tenant_user_body import UpdateTenantUserBody
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_user_body = client.UpdateTenantUserBody() # UpdateTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (optional)
    try:
        api_response = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->update_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_user: %s\n" % e)

create_tenant

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateTenantResponse

Приклад

Приклад create_tenant

Copy

import client
from client.models.create_tenant_body import CreateTenantBody
from client.models.create_tenant_response import CreateTenantResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки серверу API.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад, який
# відповідає вашому сценарію автентифікації.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_body = client.CreateTenantBody() # CreateTenantBody | 
    try:
        api_response = api_instance.create_tenant(tenant_id, create_tenant_body)
        print("The response of DefaultApi->create_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant: %s\n" % e)

delete_tenant

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
sure	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_tenant

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням = https://fastcomments.com
# Перегляньте configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використайте той,
# який відповідає вашому випадку використання.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    sure = 'sure_example' # str |  (необов'язковий)
    try:
        api_response = api_instance.delete_tenant(tenant_id, id, sure=sure)
        print("The response of DefaultApi->delete_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant: %s\n" % e)

get_tenant

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetTenantResponse

Приклад

get_tenant Приклад

Copy

import client
from client.models.get_tenant_response import GetTenantResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant(tenant_id, id)
        print("The response of DefaultApi->get_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant: %s\n" % e)

get_tenants

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
meta	string	query	No
skip	number	query	No

Відповідь

Returns: GetTenantsResponse

Приклад

Приклад get_tenants

Copy

import client
from client.api.default_api import GetTenantsOptions
from client.models.get_tenants_response import GetTenantsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host є необов'язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштувати авторизацію API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    meta = 'meta_example' # str |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_tenants(tenant_id, GetTenantsOptions(meta=meta, skip=skip))
        print("The response of DefaultApi->get_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenants: %s\n" % e)

update_tenant

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_tenant

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_tenant_body import UpdateTenantBody
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове — за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації; використайте приклад, який
# відповідає вашому випадку використання.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_body = client.UpdateTenantBody() # UpdateTenantBody | 
    try:
        api_response = api_instance.update_tenant(tenant_id, id, update_tenant_body)
        print("The response of DefaultApi->update_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant: %s\n" % e)

change_ticket_state

Параметри

Назва	Тип	Location	Обов'язково
tenantId	string	query	Так
userId	string	query	Так
id	string	path	Так

Відповідь

Повертає: ChangeTicketStateResponse

Приклад

Приклад change_ticket_state

Copy

import client
from client.models.change_ticket_state_body import ChangeTicketStateBody
from client.models.change_ticket_state_response import ChangeTicketStateResponse
from client.rest import ApiException
from pprint import pprint
# Вказувати host необов'язково; за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації й авторизації
# відповідно до політики безпеки серверу API.
# Нижче наведено приклади для кожного методу автентифікації; використайте той,
# що відповідає вашому випадку використання.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    id = 'id_example' # str | 
    change_ticket_state_body = client.ChangeTicketStateBody() # ChangeTicketStateBody | 
    try:
        api_response = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
        print("The response of DefaultApi->change_ticket_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->change_ticket_state: %s\n" % e)

create_ticket

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
userId	string	query	Так

Відповідь

Повертає: CreateTicketResponse

Приклад

Приклад create_ticket

Copy

import client
from client.models.create_ticket_body import CreateTicketBody
from client.models.create_ticket_response import CreateTicketResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host є необов'язковим і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри аутентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу аутентифікації наведені нижче, використайте той,
# який відповідає вашому випадку використання.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст, використовуючи екземпляр клієнта API
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    create_ticket_body = client.CreateTicketBody() # CreateTicketBody | 
    try:
        api_response = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
        print("The response of DefaultApi->create_ticket:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_ticket: %s\n" % e)

get_ticket

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

Відповідь

Повертає: GetTicketResponse

Приклад

Приклад get_ticket

Copy

import client
from client.models.get_ticket_response import GetTicketResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки серверу API.
# Нижче наведено приклади для кожного методу автентифікації, використайте той,
# що відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    try:
        api_response = api_instance.get_ticket(tenant_id, id, user_id=user_id)
        print("The response of DefaultApi->get_ticket:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ticket: %s\n" % e)

get_tickets

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
userId	string	query	Ні
state	number	query	Ні
skip	number	query	Ні
limit	number	query	Ні

Відповідь

Повертає: GetTicketsResponse

Приклад

Приклад get_tickets

Copy

import client
from client.api.default_api import GetTicketsOptions
from client.models.get_tickets_response import GetTicketsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# у відповідності до політики безпеки API сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (необов’язково)
    state = 3.4 # float |  (необов’язково)
    skip = 3.4 # float |  (необов’язково)
    limit = 3.4 # float |  (необов’язково)
    try:
        api_response = api_instance.get_tickets(tenant_id, GetTicketsOptions(user_id=user_id, state=state, skip=skip, limit=limit))
        print("The response of DefaultApi->get_tickets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tickets: %s\n" % e)

get_translations

Параметри

Ім'я	Тип	Розташування	Обов'язковий
namespace	string	path	Yes
component	string	path	Yes
locale	string	query	No
useFullTranslationIds	boolean	query	No

Відповідь

Повертає: GetTranslationsResponse

Приклад

get_translations Приклад

Copy

import client
from client.api.public_api import GetTranslationsOptions
from client.models.get_translations_response import GetTranslationsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з інстансом API клієнта
with client.ApiClient(configuration) as api_client:
    # Створити інстанс класу API
    api_instance = client.PublicApi(api_client)
    namespace = 'namespace_example' # str | 
    component = 'component_example' # str | 
    locale = 'locale_example' # str |  (необов’язково)
    use_full_translation_ids = True # bool |  (необов’язково)
    try:
        api_response = api_instance.get_translations(namespace, component, GetTranslationsOptions(locale=locale, use_full_translation_ids=use_full_translation_ids))
        print("The response of PublicApi->get_translations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_translations: %s\n" % e)

upload_image

Завантаження та зміна розміру зображення

Параметри

Назва	Тип	Розташування	Обов’язковий	Опис
tenantId	string	path	Так
sizePreset	string	query	Ні	Попередньо визначений розмір: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв)
urlId	string	query	Ні	Ідентифікатор сторінки, з якої відбувається завантаження, для налаштування

Відповідь

Повертає: UploadImageResponse

Приклад

upload_image Приклад

Copy

import client
from client.api.public_api import UploadImageOptions
from client.models.size_preset import SizePreset
from client.models.upload_image_response import UploadImageResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    file = None # bytes | 
    size_preset = client.SizePreset() # SizePreset | Попередньо визначений розмір: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) (необов'язково)
    url_id = 'url_id_example' # str | Ідентифікатор сторінки, з якої відбувається завантаження, для налаштування (необов'язково)
    try:
        api_response = api_instance.upload_image(tenant_id, file, UploadImageOptions(size_preset=size_preset, url_id=url_id))
        print("The response of PublicApi->upload_image:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->upload_image: %s\n" % e)

get_user_badge_progress_by_id

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIGetUserBadgeProgressResponse

Приклад

get_user_badge_progress_by_id Приклад

Copy

import client
from client.models.api_get_user_badge_progress_response import APIGetUserBadgeProgressResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове й за замовчуванням використовує https://fastcomments.com
# Див. configuration.py для переліку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації — використайте той,
# який відповідає вашому сценарію автентифікації.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_progress_by_id(tenant_id, id)
        print("The response of DefaultApi->get_user_badge_progress_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_by_id: %s\n" % e)

get_user_badge_progress_by_user_id

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
userId	string	path	Так

Відповідь

Повертає: APIGetUserBadgeProgressResponse

Приклад

Приклад get_user_badge_progress_by_user_id

Copy

import client
from client.models.api_get_user_badge_progress_response import APIGetUserBadgeProgressResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведені приклади для кожного методу аутентифікації, використайте той приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою ключа API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
        print("The response of DefaultApi->get_user_badge_progress_by_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_by_user_id: %s\n" % e)

get_user_badge_progress_list

Parameters

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
userId	string	query	Ні
limit	number	query	Ні
skip	number	query	Ні

Response

Повертає: APIGetUserBadgeProgressListResponse

Приклад

get_user_badge_progress_list Приклад

Copy

import client
from client.api.default_api import GetUserBadgeProgressListOptions
from client.models.api_get_user_badge_progress_list_response import APIGetUserBadgeProgressListResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов’язкове і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації надані нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    limit = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_user_badge_progress_list(tenant_id, GetUserBadgeProgressListOptions(user_id=user_id, limit=limit, skip=skip))
        print("The response of DefaultApi->get_user_badge_progress_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_list: %s\n" % e)

create_user_badge

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так

Відповідь

Повертає: APICreateUserBadgeResponse

Приклад

Приклад create_user_badge

Copy

import client
from client.models.api_create_user_badge_response import APICreateUserBadgeResponse
from client.models.create_user_badge_params import CreateUserBadgeParams
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведені приклади для кожного методу автентифікації, використовуйте приклад, який
# найкраще відповідає вашому випадку застосування.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст із екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_user_badge_params = client.CreateUserBadgeParams() # CreateUserBadgeParams | 
    try:
        api_response = api_instance.create_user_badge(tenant_id, create_user_badge_params)
        print("The response of DefaultApi->create_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_user_badge: %s\n" % e)

delete_user_badge

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptySuccessResponse

Приклад

Приклад delete_user_badge

Copy

import client
from client.models.api_empty_success_response import APIEmptySuccessResponse
from client.rest import ApiException
from pprint import pprint
# Вказівка хоста необов'язкова і за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки серверу API.
# Нижче наведені приклади для кожного методу автентифікації, використовуйте приклад, який
# відповідає вашому варіанту використання.
# Налаштувати авторизацію за API ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_user_badge(tenant_id, id)
        print("The response of DefaultApi->delete_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_user_badge: %s\n" % e)

get_user_badge

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Response

Повертає: APIGetUserBadgeResponse

Example

Приклад get_user_badge

Copy

import client
from client.models.api_get_user_badge_response import APIGetUserBadgeResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове та за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Нижче наведено приклади для кожного методу автентифікації, використайте приклад, який
# відповідає вашому сценарію автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Використайте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр API-класу
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge(tenant_id, id)
        print("The response of DefaultApi->get_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge: %s\n" % e)

get_user_badges

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
userId	string	query	No
badgeId	string	query	No
type	number	query	No
displayedOnComments	boolean	query	No
limit	number	query	No
skip	number	query	No

Відповідь

Повертає: APIGetUserBadgesResponse

Приклад

Приклад get_user_badges

Copy

import client
from client.api.default_api import GetUserBadgesOptions
from client.models.api_get_user_badges_response import APIGetUserBadgesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Приклади для кожного методу автентифікації наведено нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (необов’язково)
    badge_id = 'badge_id_example' # str |  (необов’язково)
    type = 3.4 # float |  (необов’язково)
    displayed_on_comments = True # bool |  (необов’язково)
    limit = 3.4 # float |  (необов’язково)
    skip = 3.4 # float |  (необов’язково)
    try:
        api_response = api_instance.get_user_badges(tenant_id, GetUserBadgesOptions(user_id=user_id, badge_id=badge_id, type=type, displayed_on_comments=displayed_on_comments, limit=limit, skip=skip))
        print("The response of DefaultApi->get_user_badges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badges: %s\n" % e)

update_user_badge

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptySuccessResponse

Приклад

Приклад update_user_badge

Copy

import client
from client.models.api_empty_success_response import APIEmptySuccessResponse
from client.models.update_user_badge_params import UpdateUserBadgeParams
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове й за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки сервера API.
# Нижче наведено приклади для кожного методу автентифікації; використайте той,
# який відповідає вашому випадку використання.
# Налаштуйте авторизацію за допомогою API ключа: api_key
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_user_badge_params = client.UpdateUserBadgeParams() # UpdateUserBadgeParams | 
    try:
        api_response = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
        print("The response of DefaultApi->update_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_user_badge: %s\n" % e)

get_user_notification_count

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetUserNotificationCountResponse

Приклад

Приклад get_user_notification_count

Copy

import client
from client.models.get_user_notification_count_response import GetUserNotificationCountResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове та за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійти в контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.get_user_notification_count(tenant_id, sso=sso)
        print("The response of PublicApi->get_user_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_notification_count: %s\n" % e)

get_user_notifications

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Yes
urlId	string	query	No	Використовується для визначення, чи підписана поточна сторінка.
pageSize	integer	query	No
afterId	string	query	No
includeContext	boolean	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
includeTranslations	boolean	query	No
includeTenantNotifications	boolean	query	No
sso	string	query	No

Відповідь

Повертає: GetMyNotificationsResponse

Приклад

Приклад get_user_notifications

Copy

import client
from client.api.public_api import GetUserNotificationsOptions
from client.models.get_my_notifications_response import GetMyNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для отримання списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Введіть контекст із екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | Використовується для визначення, чи підписана поточна сторінка. (необов’язковий)
    page_size = 56 # int |  (необов’язковий)
    after_id = 'after_id_example' # str |  (необов’язковий)
    include_context = True # bool |  (необов’язковий)
    after_created_at = 56 # int |  (необов’язковий)
    unread_only = True # bool |  (необов’язковий)
    dm_only = True # bool |  (необов’язковий)
    no_dm = True # bool |  (необов’язковий)
    include_translations = True # bool |  (необов’язковий)
    include_tenant_notifications = True # bool |  (необов’язковий)
    sso = 'sso_example' # str |  (необов’язковий)
    try:
        api_response = api_instance.get_user_notifications(tenant_id, GetUserNotificationsOptions(url_id=url_id, page_size=page_size, after_id=after_id, include_context=include_context, after_created_at=after_created_at, unread_only=unread_only, dm_only=dm_only, no_dm=no_dm, include_translations=include_translations, include_tenant_notifications=include_tenant_notifications, sso=sso))
        print("The response of PublicApi->get_user_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_notifications: %s\n" % e)

reset_user_notification_count

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

reset_user_notification_count Приклад

Copy

import client
from client.models.reset_user_notifications_response import ResetUserNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлено на https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть в контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язковий)
    try:
        api_response = api_instance.reset_user_notification_count(tenant_id, sso=sso)
        print("The response of PublicApi->reset_user_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->reset_user_notification_count: %s\n" % e)

reset_user_notifications

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
afterId	string	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
sso	string	query	No

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

reset_user_notifications Приклад

Copy

import client
from client.api.public_api import ResetUserNotificationsOptions
from client.models.reset_user_notifications_response import ResetUserNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (необов’язковий)
    after_created_at = 56 # int |  (необов’язковий)
    unread_only = True # bool |  (необов’язковий)
    dm_only = True # bool |  (необов’язковий)
    no_dm = True # bool |  (необов’язковий)
    sso = 'sso_example' # str |  (необов’язковий)
    try:
        api_response = api_instance.reset_user_notifications(tenant_id, ResetUserNotificationsOptions(after_id=after_id, after_created_at=after_created_at, unread_only=unread_only, dm_only=dm_only, no_dm=no_dm, sso=sso))
        print("The response of PublicApi->reset_user_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->reset_user_notifications: %s\n" % e)

update_user_notification_comment_subscription_status

Увімкнути або вимкнути сповіщення для певного коментаря.

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
notificationId	string	path	Так
optedInOrOut	string	path	Так
commentId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse

Приклад

Приклад update_user_notification_comment_subscription_status

Copy

import client
from client.models.update_user_notification_comment_subscription_status_response import UpdateUserNotificationCommentSubscriptionStatusResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    notification_id = 'notification_id_example' # str | 
    opted_in_or_out = 'opted_in_or_out_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, sso=sso)
        print("The response of PublicApi->update_user_notification_comment_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_comment_subscription_status: %s\n" % e)

update_user_notification_page_subscription_status

Увімкнення або вимкнення повідомлень для сторінки. Коли користувачі підписані на сторінку, створюються повідомлення про нові кореневі коментарі, а також

Параметри

Name	Type	Location	Обов'язково
tenantId	string	query	Так
urlId	string	query	Так
url	string	query	Так
pageTitle	string	query	Так
subscribedOrUnsubscribed	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: UpdateUserNotificationPageSubscriptionStatusResponse

Приклад

Приклад update_user_notification_page_subscription_status

Copy

import client
from client.models.update_user_notification_page_subscription_status_response import UpdateUserNotificationPageSubscriptionStatusResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням = https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    url = 'url_example' # str | 
    page_title = 'page_title_example' # str | 
    subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, sso=sso)
        print("The response of PublicApi->update_user_notification_page_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_page_subscription_status: %s\n" % e)

update_user_notification_status

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
notificationId	string	path	Так
newStatus	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: UpdateUserNotificationStatusResponse

Приклад

Приклад update_user_notification_status

Copy

import client
from client.models.update_user_notification_status_response import UpdateUserNotificationStatusResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове і за замовчуванням https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    notification_id = 'notification_id_example' # str | 
    new_status = 'new_status_example' # str | 
    sso = 'sso_example' # str |  (необов'язково)
    try:
        api_response = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, sso=sso)
        print("The response of PublicApi->update_user_notification_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_status: %s\n" % e)

get_user_presence_statuses

Параметри

Назва	Тип	Розташування	Обов'язкове
tenantId	string	query	Так
urlIdWS	string	query	Так
userIds	string	query	Так

Відповідь

Повертає: GetUserPresenceStatusesResponse

Приклад

Приклад get_user_presence_statuses

Copy

import client
from client.models.get_user_presence_statuses_response import GetUserPresenceStatusesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням має значення https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id_ws = 'url_id_ws_example' # str | 
    user_ids = 'user_ids_example' # str | 
    try:
        api_response = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
        print("The response of PublicApi->get_user_presence_statuses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_presence_statuses: %s\n" % e)

search_users

Parameters

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
urlId	string	query	Так
usernameStartsWith	string	query	Ні
mentionGroupIds	array	query	Ні
sso	string	query	Ні
searchSection	string	query	Ні

Response

Повертає: SearchUsersResult

Example

search_users Приклад

Copy

import client
from client.api.public_api import SearchUsersOptions
from client.models.search_users_result import SearchUsersResult
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Відкрити контекст з екземпляром клієнта API
with client.ApiClient(configuration) as api_client:
    # Створити екземпляр класу API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    username_starts_with = 'username_starts_with_example' # str |  (optional)
    mention_group_ids = ['mention_group_ids_example'] # List[str] |  (optional)
    sso = 'sso_example' # str |  (optional)
    search_section = 'search_section_example' # str |  (optional)
    try:
        api_response = api_instance.search_users(tenant_id, url_id, SearchUsersOptions(username_starts_with=username_starts_with, mention_group_ids=mention_group_ids, sso=sso, search_section=search_section))
        print("The response of PublicApi->search_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->search_users: %s\n" % e)

get_user

Parameters

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetUserResponse

Приклад

Приклад get_user

Copy

import client
from client.models.get_user_response import GetUserResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов'язковим і за замовчуванням дорівнює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче, використовуйте приклад, який
# відповідає вашому сценарію використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкрийте контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user(tenant_id, id)
        print("The response of DefaultApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user: %s\n" % e)

create_vote

Parameters

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	query	Yes
direction	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

Response

Повертає: VoteResponse

Приклад

create_vote Приклад

Copy

import client
from client.api.default_api import CreateVoteOptions
from client.models.vote_response import VoteResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хосту є необов'язковим і за замовчуванням встановлює https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API сервера.
# Приклади для кожного методу автентифікації надаються нижче, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за допомогою API ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо це потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Відкриття контексту з інстансом API клієнта
with client.ApiClient(configuration) as api_client:
    # Створення інстансу класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    direction = 'direction_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.create_vote(tenant_id, comment_id, direction, CreateVoteOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->create_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_vote: %s\n" % e)

delete_vote

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
editKey	string	query	Ні

Відповідь

Повертає: VoteDeleteResponse

Приклад

Приклад delete_vote

Copy

import client
from client.models.vote_delete_response import VoteDeleteResponse
from client.rest import ApiException
from pprint import pprint
# Визначення host необов'язкове; за замовчуванням — https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт має налаштувати параметри аутентифікації та авторизації
# згідно з політикою безпеки API-сервера.
# Нижче наведено приклади для кожного методу аутентифікації, використайте приклад, який
# відповідає вашому випадку використання автентифікації.
# Налаштуйте авторизацію за допомогою API-ключа: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    edit_key = 'edit_key_example' # str |  (optional)
    try:
        api_response = api_instance.delete_vote(tenant_id, id, edit_key=edit_key)
        print("The response of DefaultApi->delete_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_vote: %s\n" % e)

get_votes

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
urlId	string	query	Так

Відповідь

Повертає: GetVotesResponse

Приклад

Приклад get_votes

Copy

import client
from client.models.get_votes_response import GetVotesResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста необов'язкове; за замовчуванням використовується https://fastcomments.com
# Див. configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче; використайте той приклад, який
# відповідає вашому варіанту використання автентифікації.
# Налаштуйте авторизацію за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Увійдіть у контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Створіть екземпляр класу API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_votes(tenant_id, url_id)
        print("The response of DefaultApi->get_votes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_votes: %s\n" % e)

get_votes_for_user

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
urlId	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

Відповідь

Повертає: GetVotesForUserResponse

Приклад

Приклад get_votes_for_user

Copy

import client
from client.api.default_api import GetVotesForUserOptions
from client.models.get_votes_for_user_response import GetVotesForUserResponse
from client.rest import ApiException
from pprint import pprint
# Визначення хоста є необов’язковим і за замовчуванням https://fastcomments.com
# Дивіться configuration.py для списку всіх підтримуваних параметрів конфігурації.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Клієнт повинен налаштувати параметри автентифікації та авторизації
# відповідно до політики безпеки API-сервера.
# Приклади для кожного методу автентифікації наведені нижче, використайте приклад,
# який відповідає вашому випадку використання автентифікації.
# Налаштування авторизації за API-ключем: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Розкоментуйте нижче, щоб задати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Введіть контекст з екземпляром API-клієнта
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.get_votes_for_user(tenant_id, url_id, GetVotesForUserOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->get_votes_for_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_votes_for_user: %s\n" % e)

Потрібна допомога?

Якщо ви зіткнулися з будь-якими проблемами або маєте питання щодо Python SDK, будь ласка:

Участь

Внески вітаються! Будь ласка, відвідайте репозиторій GitHub для отримання вказівок щодо внесків.

Мова 🇺🇦 Українська

Початок роботи

Документація

Агрегація

Журнали аудиту

Аутентифікація

Блокування через коментар

Перевірка заблокованих коментарів

Коментарі

Коментарі користувача

Налаштування доменів

Шаблони електронних листів

Журнал подій

Пости стрічки

Позначення коментаря

GIF

Хештеги

Модерація

Модератори

Кількість сповіщень

Сповіщення

Реакції на сторінці

Сторінки

Очікувані події вебхука

Налаштування питань

Результати запитань

Агрегація результатів запитань

Користувачі SSO

Підписки

Щоденне використання орендаря

Пакети орендаря

Користувачі орендаря

Орендарі

Тікети

Переклади

Завантажити зображення

Прогрес бейджів користувача

Бейджі користувача

Сповіщення користувача

Стани присутності користувача

Пошук користувачів

Користувачі

Голоси

FastComments SDK для Python

Репозиторій

Встановлення

Встановити з GitHub

Вміст бібліотеки

Публічні та захищені API

Швидкий старт

Використання автентифікованих API (DefaultApi)

Використання публічних API (PublicApi)

Використання панелі модерації (ModerationApi)

Використання SSO (Single Sign-On)

Живі підписки (PubSub)

Поширені проблеми

Примітки

Ідентифікатори трансляцій

Вимоги

aggregate

Параметри

Відповідь

Приклад

get_audit_logs

Параметри

Відповідь

Приклад

logout_public

Response

Example

block_from_comment_public

Параметри

Відповідь

Приклад

un_block_comment_public

Параметри

Відповідь

Приклад

checked_comments_for_blocked

Параметри