FastComments Python SDK

זה ה-SDK הרשמי של FastComments לפייתון.

ה-SDK הרשמי בפייתון עבור ממשק ה-API של FastComments

מאגר

התקנה

PyPI

pip install fastcomments

תכולת הספרייה

ספרייה זו מכילה שני מודולים: לקוח ה-API שנוצר והספרייה המרכזית של Python שמכילה כלי עזר שנכתבו ידנית כדי להקל על העבודה עם ה-API, כולל תמיכה ב-SSO.

ממשקי API ציבוריים לעומת מאובטחים

בעבור לקוח ה-API, יש שתי מחלקות, DefaultApi ו-PublicApi. ה-DefaultApi מכילה שיטות שדורשות את מפתח ה-API שלך, ו-PublicApi מכילה קריאות API שניתן לבצע ישירות מדפדפן/מכשיר נייד/וכו' ללא אימות.

התחלה מהירה

שימוש ב-APIs מאומתים (DefaultApi)

חשוב: עליך להגדיר את מפתח ה-API ב-Configuration לפני ביצוע בקשות מאומתות. אם לא תעשה זאת, הבקשות ייכשלו עם שגיאת 401.

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

# צור והגדר את לקוח ה-API
config = Configuration()
config.host = "https://fastcomments.com/api"

# נדרש: הגדר את מפתח ה-API שלך (קבל אותו מלוח הבקרה של FastComments)
config.api_key = {"ApiKeyAuth": "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(
        tenant_id="YOUR_TENANT_ID",
        create_apisso_user_data=user_data
    )
    print(f"User created: {response}")

except Exception as e:
    print(f"Error: {e}")
    # שגיאות נפוצות:
    # - 401: מפתח ה-API חסר או שגוי
    # - 400: אימות הבקשה נכשל

שימוש ב-APIs ציבוריים (PublicApi)

נקודות קצה ציבוריות אינן דורשות אימות:

from client import ApiClient, Configuration, PublicApi

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

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

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

שימוש ב-SSO (כניסה יחידה)

ערכת הכלים (SDK) כוללת כלי עזר ליצירת טוקני SSO מאובטחים:

from sso import FastCommentsSSO, SecureSSOUserData

# צור נתוני משתמש
user_data = SecureSSOUserData(
    user_id="user-123",
    email="user@example.com",
    username="johndoe",
    avatar="https://example.com/avatar.jpg"
)

# צור מופע SSO עם הסוד של ה-API שלך
sso = FastCommentsSSO.new_secure(
    api_secret="YOUR_API_SECRET",
    user_data=user_data
)

# הפק את טוקן ה-SSO
sso_token = sso.create_token()

# השתמש בטוקן זה בצד הלקוח שלך או העבר אותו לקריאות API
print(f"SSO Token: {sso_token}")

עבור SSO פשוט (פחות מאובטח, למטרות בדיקה):

from sso import FastCommentsSSO, SimpleSSOUserData

user_data = SimpleSSOUserData(
    user_id="user-123",
    email="user@example.com"
)

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

בעיות נפוצות

401 "missing-api-key" error: וודא שהגדרת config.api_key = {"ApiKeyAuth": "YOUR_KEY"} לפני יצירת מופע DefaultApi.
Wrong API class: השתמש ב-DefaultApi עבור בקשות מאומתות בצד השרת, וב-PublicApi עבור בקשות בצד הלקוח/ציבוריות.
Import errors: וודא שאתה מייבא מהממודול הנכון:
- לקוח ה-API: from client import ...
- כלי SSO: from sso import ...

הערות

מזהי שידור

תראה שעליך להעביר broadcast_id בחלק מבקשות ה-API. כאשר תקבל אירועים, תקבל בחזרה את המזהה הזה, כך תדע להתעלם מהאירוע אם בכוונתך להחיל שינויים באופן אופטימי בצד הלקוח (סביר שתרצה לעשות זאת שכן זה מספק את חוויית המשתמש הטובה ביותר). יש להעביר כאן UUID. המזהה צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים במהלך סשן בדפדפן.

דרישות

Python >= 3.8
urllib3 >= 1.25.3
python-dateutil >= 2.8.2
pydantic >= 2.0.0
typing-extensions >= 4.0.0

אגרגציה

מאגד מסמכים על ידי קיבוצם (אם מסופק groupBy) ויישום מספר פעולות. פעולות שונות (למשל sum, countDistinct, avg וכו') נתמכות.

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
parentTenantId	string	query	לא
includeStats	boolean	query	לא

תגובה

מחזיר: AggregationResponse

דוגמה

דוגמה ל-aggregate

Copy

import client
from client.models.aggregation_request import AggregationRequest
from client.models.aggregation_response import AggregationResponse
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"
)
# The client must configure the authentication and authorization parameters
# בהתאם למדיניות האבטחה של שרת ה-API.
# דוגמאות לכל שיטת אימות מסופקות למטה, השתמשו בדוגמה ש
# מספקת את דרישת האימות שלכם.
# Configure API key authorization: api_key
# קבעו אימות באמצעות מפתח API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
# הכנסו להקשר עם מופע של לקוח ה-API
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    # צרו מופע של מחלקת ה-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 |  (אופציונלי)
    include_stats = True # bool |  (אופציונלי)
    try:
        api_response = api_instance.aggregate(tenant_id, aggregation_request, 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)

קבלת יומני ביקורת

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
limit	number	query	לא
skip	number	query	לא
order	string	query	לא
after	number	query	לא
before	number	query	לא

תגובה

מחזיר: GetAuditLogs200Response

דוגמה

דוגמה ל-get_audit_logs

Copy

import client
from client.models.get_audit_logs200_response import GetAuditLogs200Response
from client.models.sortdir import SORTDIR
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 | 
    limit = 3.4 # float |  (אופציונלי)
    skip = 3.4 # float |  (אופציונלי)
    order = client.SORTDIR() # SORTDIR |  (אופציונלי)
    after = 3.4 # float |  (אופציונלי)
    before = 3.4 # float |  (אופציונלי)
    try:
        api_response = api_instance.get_audit_logs(tenant_id, 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)

חסימה מתגובה ציבורית

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
commentId	string	path	כן
sso	string	query	לא

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-block_from_comment_public

Copy

import client
from client.models.block_from_comment_public200_response import BlockFromCommentPublic200Response
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
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.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)

ביטול חסימה מתגובה ציבורית

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
commentId	string	path	כן
sso	string	query	לא

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

un_block_comment_public דוגמה

Copy

import client
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.models.un_block_comment_public200_response import UnBlockCommentPublic200Response
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)

בדיקת תגובות לחסימה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
commentIds	string	query	כן	רשימת מזהי תגובות מופרדת בפסיקים.
sso	string	query	לא

תגובה

מחזיר: CheckedCommentsForBlocked200Response

דוגמה

דוגמה ל-checked_comments_for_blocked

Copy

import client
from client.models.checked_comments_for_blocked200_response import CheckedCommentsForBlocked200Response
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)

חסימת משתמש בעקבות תגובה

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא
anonUserId	string	query	לא

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-block_user_from_comment

Copy

import client
from client.models.block_from_comment_params import BlockFromCommentParams
from client.models.block_from_comment_public200_response import BlockFromCommentPublic200Response
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"]
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל 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, 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)

יצירת תגובה ציבורית

פרמטרים

Name	Type	Location	Required
tenantId	string	path	כן
urlId	string	query	כן
broadcastId	string	query	כן
sessionId	string	query	לא
sso	string	query	לא

תגובה

מחזיר: CreateCommentPublic200Response

דוגמה

דוגמה ל-create_comment_public

Copy

import client
from client.models.comment_data import CommentData
from client.models.create_comment_public200_response import CreateCommentPublic200Response
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 | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_data = client.CommentData() # CommentData | 
    session_id = 'session_id_example' # str |  (אופציונלי)
    sso = 'sso_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, 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)

מחיקת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
id	string	path	כן
contextUserId	string	query	לא
isLive	boolean	query	לא

תגובה

מחזיר: DeleteComment200Response

דוגמה

דוגמת delete_comment

Copy

import client
from client.models.delete_comment200_response import DeleteComment200Response
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 client
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 |  (אופציונלי)
    is_live = True # bool |  (אופציונלי)
    try:
        api_response = api_instance.delete_comment(tenant_id, id, 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)

מחיקת תגובה ציבורית

פרמטרים

Name	Type	Location	Required
tenantId	string	path	כן
commentId	string	path	כן
broadcastId	string	query	כן
editKey	string	query	לא
sso	string	query	לא

תגובה

מחזיר: DeleteCommentPublic200Response

דוגמה

דוגמה ל-delete_comment_public

Copy

import client
from client.models.delete_comment_public200_response import DeleteCommentPublic200Response
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 | 
    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, 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)

מחיקת הצבעה על תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
voteId	string	path	כן
urlId	string	query	כן
broadcastId	string	query	כן
editKey	string	query	לא
sso	string	query	לא

תגובה

מחזיר: DeleteCommentVote200Response

דוגמה

דוגמה ל-delete_comment_vote

Copy

import client
from client.models.delete_comment_vote200_response import DeleteCommentVote200Response
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 | 
    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, 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)

דיווח על תגובה

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא
anonUserId	string	query	לא

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמה ל-flag_comment

Copy

import client
from client.models.flag_comment200_response import FlagComment200Response
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 | 
    user_id = 'user_id_example' # str |  (אופציונלי)
    anon_user_id = 'anon_user_id_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.flag_comment(tenant_id, id, 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)

קבלת תגובה

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetComment200Response

דוגמה

דוגמת get_comment

Copy

import client
from client.models.get_comment200_response import GetComment200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת host אופציונלית והברירת מחדל היא https://fastcomments.com
# ראה את configuration.py לרשימת כל פרמטרי ההגדרה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# על ה-client להגדיר את פרמטרי האימות וההרשאה
# בהתאם למדיניות האבטחה של שרת ה-API.
# דוגמאות לכל שיטת אימות מסופקות למטה — השתמש בדוגמה שמתאימה למקרה השימוש שלך.
# קבע הרשאת מפתח API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# הסר את ההערה למטה כדי לקבוע קידומת (למשל Bearer) עבור מפתח ה-API, אם צריך
# configuration.api_key_prefix['api_key'] = 'Bearer'
# פתח הקשר עם מופע של ה-API client
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)

קבלת טקסט התגובה

פרמטרים

Name	Type	Location	Required
tenantId	string	path	כן
commentId	string	path	כן
editKey	string	query	לא
sso	string	query	לא

תגובה

מחזיר: GetCommentText200Response

דוגמה

דוגמה של get_comment_text

Copy

import client
from client.models.get_comment_text200_response import GetCommentText200Response
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 | 
    edit_key = 'edit_key_example' # str |  (אופציונלי)
    sso = 'sso_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.get_comment_text(tenant_id, comment_id, 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)

קבלת שמות משתמשים שהצביעו על תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
dir	integer	query	כן
sso	string	query	לא

תגובה

מחזיר: GetCommentVoteUserNames200Response

דוגמה

דוגמה ל-get_comment_vote_user_names

Copy

import client
from client.models.get_comment_vote_user_names200_response import GetCommentVoteUserNames200Response
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 | 
    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)

קבלת תגובות

פרמטרים

Name	Type	Location	Required
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

תגובה

מחזיר: GetComments200Response

דוגמה

דוגמה ל-get_comments

Copy

import client
from client.models.get_comments200_response import GetComments200Response
from client.models.sort_directions import SortDirections
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 | 
    page = 56 # int |  (אופציונלי)
    limit = 56 # int |  (אופציונלי)
    skip = 56 # int |  (אופציונלי)
    as_tree = True # bool |  (אופציונלי)
    skip_children = 56 # int |  (אופציונלי)
    limit_children = 56 # int |  (אופציונלי)
    max_tree_depth = 56 # int |  (אופציונלי)
    url_id = 'url_id_example' # str |  (אופציונלי)
    user_id = 'user_id_example' # str |  (אופציונלי)
    anon_user_id = 'anon_user_id_example' # str |  (אופציונלי)
    context_user_id = 'context_user_id_example' # str |  (אופציונלי)
    hash_tag = 'hash_tag_example' # str |  (אופציונלי)
    parent_id = 'parent_id_example' # str |  (אופציונלי)
    direction = client.SortDirections() # SortDirections |  (אופציונלי)
    try:
        api_response = api_instance.get_comments(tenant_id, 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)
        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)

קבלת תגובות ציבוריות

req tenantId urlId

פרמטרים

שם	Type	Location	נדרש
tenantId	string	path	כן
urlId	string	query	כן
page	integer	query	לא
direction	string	query	לא
sso	string	query	לא
skip	integer	query	לא
skipChildren	integer	query	לא
limit	integer	query	לא
limitChildren	integer	query	לא
countChildren	boolean	query	לא
fetchPageForCommentId	string	query	לא
includeConfig	boolean	query	לא
countAll	boolean	query	לא
includei10n	boolean	query	לא
locale	string	query	לא
modules	string	query	לא
isCrawler	boolean	query	לא
includeNotificationCount	boolean	query	לא
asTree	boolean	query	לא
maxTreeDepth	integer	query	לא
useFullTranslationIds	boolean	query	לא
parentId	string	query	לא
searchText	string	query	לא
hashTags	array	query	לא
userId	string	query	לא
customConfigStr	string	query	לא
afterCommentId	string	query	לא
beforeCommentId	string	query	לא

תגובה

מחזיר: GetCommentsPublic200Response

דוגמה

get_comments_public דוגמה

Copy

import client
from client.models.get_comments_public200_response import GetCommentsPublic200Response
from client.models.sort_directions import SortDirections
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 | 
    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, 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)

נעילת תגובה

פרמטרים

Name	Type	Location	Required
tenantId	string	path	כן
commentId	string	path	כן
broadcastId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה ל-lock_comment

Copy

import client
from client.models.lock_comment200_response import LockComment200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host היא אופציונלית והבררת מחדל היא 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 | 
    sso = 'sso_example' # str |  (אופציונלי)
    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)

נעיצת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
broadcastId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: PinComment200Response

דוגמה

pin_comment דוגמה

Copy

import client
from client.models.pin_comment200_response import PinComment200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host היא אופציונלית והברירת מחדל היא https://fastcomments.com
# ראה configuration.py לרשימה של כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# הכנס לקונטקסט עם מופע של ApiClient
with client.ApiClient(configuration) as api_client:
    # צור מופע של PublicApi
    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)

שמירת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
isLive	boolean	query	לא
doSpamCheck	boolean	query	לא
sendEmails	boolean	query	לא
populateNotifications	boolean	query	לא

תגובה

מחזיר: SaveComment200Response

דוגמה

דוגמת save_comment

Copy

import client
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comment200_response import SaveComment200Response
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_comment_params = client.CreateCommentParams() # CreateCommentParams | 
    is_live = True # bool |  (אופציונלי)
    do_spam_check = True # bool |  (אופציונלי)
    send_emails = True # bool |  (אופציונלי)
    populate_notifications = True # bool |  (אופציונלי)
    try:
        api_response = api_instance.save_comment(tenant_id, create_comment_params, 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)

שמירת תגובות בכמות גדולה

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
isLive	boolean	query	לא
doSpamCheck	boolean	query	לא
sendEmails	boolean	query	לא
populateNotifications	boolean	query	לא

תגובה

מחזיר: SaveComment200Response

דוגמה

דוגמה ל-save_comments_bulk

Copy

import client
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comment200_response import SaveComment200Response
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_comment_params = [client.CreateCommentParams()] # List[CreateCommentParams] | 
    is_live = True # bool |  (אופציונלי)
    do_spam_check = True # bool |  (אופציונלי)
    send_emails = True # bool |  (אופציונלי)
    populate_notifications = True # bool |  (אופציונלי)
    try:
        api_response = api_instance.save_comments_bulk(tenant_id, create_comment_params, 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)

הגדרת טקסט התגובה

פרמטרים

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

תגובה

מחזיר: SetCommentText200Response

דוגמה

דוגמה ל-set_comment_text

Copy

import client
from client.models.comment_text_update_request import CommentTextUpdateRequest
from client.models.set_comment_text200_response import SetCommentText200Response
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 | 
    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, 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)

ביטול חסימה של משתמש בעקבות תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא
anonUserId	string	query	לא

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה ל-un_block_user_from_comment

Copy

import client
from client.models.un_block_comment_public200_response import UnBlockCommentPublic200Response
from client.models.un_block_from_comment_params import UnBlockFromCommentParams
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"]
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל 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 |  (אופציונלי)
    anon_user_id = 'anon_user_id_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, 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)

ביטול דיווח על תגובה

פרמטרים

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

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמת un_flag_comment

Copy

import client
from client.models.flag_comment200_response import FlagComment200Response
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 | 
    user_id = 'user_id_example' # str |  (אופציונלי)
    anon_user_id = 'anon_user_id_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.un_flag_comment(tenant_id, id, 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)

ביטול נעילת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
broadcastId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה ל-un_lock_comment

Copy

import client
from client.models.lock_comment200_response import LockComment200Response
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 | 
    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)

הסרת נעיצת תגובה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
commentId	string	path	כן
broadcastId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמה ל-un_pin_comment

Copy

import client
from client.models.pin_comment200_response import PinComment200Response
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 | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (אופציונלי)
    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)

עדכון תגובה

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
contextUserId	string	query	לא
doSpamCheck	boolean	query	לא
isLive	boolean	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_comment

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.pick_api_comment_updatable_comment_fields import PickAPICommentUpdatableCommentFields
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 | 
    body = client.PickAPICommentUpdatableCommentFields() # PickAPICommentUpdatableCommentFields | 
    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, body, 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)

הצבעת תגובה

פרמטרים

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

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמה ל-vote_comment

Copy

import client
from client.models.vote_body_params import VoteBodyParams
from client.models.vote_comment200_response import VoteComment200Response
from client.rest import ApiException
from pprint import pprint
# קביעת ה-host אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com
# ראו את configuration.py לרשימת כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# פתחו הקשר (context) עם מופע של לקוח ה-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, 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)

הוספת תצורת דומיין

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן

תגובה

מחזיר: AddDomainConfig200Response

דוגמה

דוגמה ל-add_domain_config

Copy

import client
from client.models.add_domain_config200_response import AddDomainConfig200Response
from client.models.add_domain_config_params import AddDomainConfigParams
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'
# פתחו קונטקסט (context) עם מופע של לקוח ה-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)

מחיקת תצורת דומיין

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
domain	string	path	כן

תגובה

מחזיר: DeleteDomainConfig200Response

דוגמה

דוגמת delete_domain_config

Copy

import client
from client.models.delete_domain_config200_response import DeleteDomainConfig200Response
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'
# 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 | 
    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)

קבלת תצורת דומיין

פרמטרים

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

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-get_domain_config

Copy

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
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'
# 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 | 
    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)

קבלת תצורות דומיין

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן

תגובה

מחזיר: GetDomainConfigs200Response

דוגמה

דוגמה ל-get_domain_configs

Copy

import client
from client.models.get_domain_configs200_response import GetDomainConfigs200Response
from client.rest import ApiException
from pprint import pprint
# קביעת ה-host אופציונלית ובברירת המחדל היא https://fastcomments.com
# ראו configuration.py לרשימת כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# על ה-client להגדיר את פרמטרי האימות וההרשאות
# בהתאם למדיניות האבטחה של שרת ה-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'
# 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 | 
    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)

עדכון חלקי של תצורת דומיין

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
domainToUpdate	string	path	כן

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-patch_domain_config

Copy

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
from client.models.patch_domain_config_params import PatchDomainConfigParams
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'
# הכנסו להקשר (context) עם מופע של לקוח ה-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)

עדכון מלא של תצורת דומיין

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
domainToUpdate	string	path	כן

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-put_domain_config

Copy

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
from client.models.update_domain_config_params import UpdateDomainConfigParams
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"]
# הסר הערה מהמקטע למטה כדי להגדיר קידומת (למשל 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)

יצירת תבנית דוא"ל

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן

תגובה

מחזיר: CreateEmailTemplate200Response

דוגמה

דוגמת create_email_template

Copy

import client
from client.models.create_email_template200_response import CreateEmailTemplate200Response
from client.models.create_email_template_body import CreateEmailTemplateBody
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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)

מחיקת תבנית דוא"ל

פרמטרים

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

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_email_template

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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.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)

מחיקת שגיאת רינדור של תבנית דוא"ל

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
errorId	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של delete_email_template_render_error

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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)

קבלת תבנית דוא"ל

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetEmailTemplate200Response

דוגמה

דוגמה ל-get_email_template

Copy

import client
from client.models.get_email_template200_response import GetEmailTemplate200Response
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_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)

קבלת הגדרות תבניות דוא"ל

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: GetEmailTemplateDefinitions200Response

דוגמה

דוגמה ל-get_email_template_definitions

Copy

import client
from client.models.get_email_template_definitions200_response import GetEmailTemplateDefinitions200Response
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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)

קבלת שגיאות רינדור של תבניות דוא"ל

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
skip	number	query	לא

תגובה

מחזיר: GetEmailTemplateRenderErrors200Response

דוגמה

דוגמה ל-get_email_template_render_errors

Copy

import client
from client.models.get_email_template_render_errors200_response import GetEmailTemplateRenderErrors200Response
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"]
# הסר את ההערה (uncomment) שלמטה כדי להגדיר קידומת (למשל 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)

קבלת תבניות דוא"ל

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
skip	number	query	לא

תגובה

מחזיר: GetEmailTemplates200Response

דוגמה

דוגמת get_email_templates

Copy

import client
from client.models.get_email_templates200_response import GetEmailTemplates200Response
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_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)

רינדור תבנית דוא"ל

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
locale	string	query	לא

תגובה

מחזיר: RenderEmailTemplate200Response

דוגמה

דוגמה ל-render_email_template

Copy

import client
from client.models.render_email_template200_response import RenderEmailTemplate200Response
from client.models.render_email_template_body import RenderEmailTemplateBody
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host היא אופציונלית וברירת המחדל היא https://fastcomments.com
# ראה configuration.py לרשימה של כל פרמטרי הקונפיגורציה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# על הלקוח להגדיר את פרמטרי האימות והרשאה
# בהתאם למדיניות האבטחה של שרת ה-API.
# דוגמאות לכל שיטת אימות מסופקות למטה, השתמש בדוגמה ש
# מתאימה למקרי השימוש שלך.
# Configure API key authorization: api_key
# הגדר הרשאת מפתח API: api_key
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש
# Enter a context with an instance of the API client
# פתח הקשר עם מופע של client.ApiClient
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    # צור מופע של מחלקת ה-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)

עדכון תבנית דוא"ל

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
id	string	path	כן

תשובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_email_template

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_email_template_body import UpdateEmailTemplateBody
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_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)

קבלת יומן אירועים

req tenantId urlId userIdWS

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
urlId	string	query	כן
userIdWS	string	query	כן
startTime	integer	query	כן
endTime	integer	query	כן

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-get_event_log

Copy

import client
from client.models.get_event_log200_response import GetEventLog200Response
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_event_log(tenant_id, url_id, user_id_ws, start_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)

קבלת יומן אירועים גלובלי

req tenantId urlId userIdWS

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
urlId	string	query	כן
userIdWS	string	query	כן
startTime	integer	query	כן
endTime	integer	query	כן

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-get_global_event_log

Copy

import client
from client.models.get_event_log200_response import GetEventLog200Response
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)
        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)

יצירת פוסט בפיד

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
broadcastId	string	query	לא
isLive	boolean	query	לא
doSpamCheck	boolean	query	לא
skipDupCheck	boolean	query	לא

תגובה

מחזיר: CreateFeedPost200Response

דוגמה

דוגמה ל-create_feed_post

Copy

import client
from client.models.create_feed_post200_response import CreateFeedPost200Response
from client.models.create_feed_post_params import CreateFeedPostParams
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'
# 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_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (אופציונלי)
    is_live = True # bool |  (אופציונלי)
    do_spam_check = True # bool |  (אופציונלי)
    skip_dup_check = True # bool |  (אופציונלי)
    try:
        api_response = api_instance.create_feed_post(tenant_id, create_feed_post_params, 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)

יצירת פוסט בפיד ציבורי

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
broadcastId	string	query	לא
sso	string	query	לא

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-create_feed_post_public

Copy

import client
from client.models.create_feed_post_params import CreateFeedPostParams
from client.models.create_feed_post_public200_response import CreateFeedPostPublic200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host אופציונלית וברירת המחדל היא 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 | 
    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, 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)

מחיקת פוסט פיד ציבורי

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
postId	string	path	כן
broadcastId	string	query	לא
sso	string	query	לא

תגובה

מוחזר: DeleteFeedPostPublic200Response

דוגמה

delete_feed_post_public דוגמה

Copy

import client
from client.models.delete_feed_post_public200_response import DeleteFeedPostPublic200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host היא אופציונלית וברירת המחדל היא https://fastcomments.com
# ראה configuration.py לרשימת כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# הכנס להקשר (context) עם מופע של קליינט ה-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, 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)

קבלת פוסטים בפיד

req tenantId afterId

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
afterId	string	query	לא
limit	integer	query	לא
tags	array	query	לא

תגובה

מחזיר: GetFeedPosts200Response

דוגמה

דוגמה ל-get_feed_posts

Copy

import client
from client.models.get_feed_posts200_response import GetFeedPosts200Response
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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, 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)

קבלת פוסטים בפיד ציבוריים

req tenantId afterId

פרמטרים

Name	Type	Location	Required
tenantId	string	path	כן
afterId	string	query	לא
limit	integer	query	לא
tags	array	query	לא
sso	string	query	לא
isCrawler	boolean	query	לא
includeUserInfo	boolean	query	לא

תגובה

מחזיר: GetFeedPostsPublic200Response

דוגמה

דוגמה ל-get_feed_posts_public

Copy

import client
from client.models.get_feed_posts_public200_response import GetFeedPostsPublic200Response
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:
    # 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 |  (optional)
    limit = 56 # int |  (optional)
    tags = ['tags_example'] # List[str] |  (optional)
    sso = 'sso_example' # str |  (optional)
    is_crawler = True # bool |  (optional)
    include_user_info = True # bool |  (optional)
    try:
        api_response = api_instance.get_feed_posts_public(tenant_id, 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)

קבלת סטטיסטיקות פוסטים בפיד

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
postIds	array	query	כן
sso	string	query	לא

תגובה

מחזיר: GetFeedPostsStats200Response

דוגמה

דוגמה ל-get_feed_posts_stats

Copy

import client
from client.models.get_feed_posts_stats200_response import GetFeedPostsStats200Response
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 | 
    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)

קבלת ריאקציות משתמשים ציבוריות

פרמטרים

Name	Type	Location	Required
tenantId	string	path	Yes
postIds	array	query	No
sso	string	query	No

תגובה

מחזיר: GetUserReactsPublic200Response

דוגמה

דוגמה ל-get_user_reacts_public

Copy

import client
from client.models.get_user_reacts_public200_response import GetUserReactsPublic200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host אופציונלית וברירת המחדל היא https://fastcomments.com
# ראה configuration.py לרשימה של כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# כניסה להקשר עם מופע של ApiClient
with client.ApiClient(configuration) as api_client:
    # צור מופע של המחלקה PublicApi
    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, 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)

הוספת ריאקציה לפוסט פיד ציבורי

פרמטרים

Name	Type	Location	Required
tenantId	string	path	כן
postId	string	path	כן
isUndo	boolean	query	לא
broadcastId	string	query	לא
sso	string	query	לא

תגובה

מחזיר: ReactFeedPostPublic200Response

דוגמה

react_feed_post_public דוגמה

Copy

import client
from client.models.react_body_params import ReactBodyParams
from client.models.react_feed_post_public200_response import ReactFeedPostPublic200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com
# ראה configuration.py לקבלת רשימה של כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# כניסה להקשר עם מופע של ה-API client
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 | 
    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, 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)

עדכון פוסט בפיד

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_feed_post

Copy

import client
from client.models.feed_post import FeedPost
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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)

עדכון פוסט פיד ציבורי

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	path	כן
postId	string	path	כן
broadcastId	string	query	לא
sso	string	query	לא

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-update_feed_post_public

Copy

import client
from client.models.create_feed_post_public200_response import CreateFeedPostPublic200Response
from client.models.update_feed_post_params import UpdateFeedPostParams
from client.rest import ApiException
from pprint import pprint
# הגדרת host היא אופציונלית ובברירת המחדל https://fastcomments.com
# ראו configuration.py לרשימת כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# הכנסו לקונטקסט עם מופע של ApiClient
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 | 
    update_feed_post_params = client.UpdateFeedPostParams() # UpdateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (אופציונלי)
    sso = 'sso_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, 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)

דיווח על תגובה ציבורית

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
commentId	string	path	כן
isFlagged	boolean	query	כן
sso	string	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-flag_comment_public

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 |  (אופציונלי)
    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)

הוספת תגית (Hashtag)

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	לא

תגובה

מחזיר: AddHashTag200Response

דוגמה

דוגמה ל-add_hash_tag

Copy

import client
from client.models.add_hash_tag200_response import AddHashTag200Response
from client.models.create_hash_tag_body import CreateHashTagBody
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 |  (אופציונלי)
    create_hash_tag_body = client.CreateHashTagBody() # CreateHashTagBody |  (אופציונלי)
    try:
        api_response = api_instance.add_hash_tag(tenant_id=tenant_id, create_hash_tag_body=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)

הוספת תגיות בכמות גדולה

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	לא

תגובה

מחזיר: AddHashTagsBulk200Response

דוגמה

דוגמה ל-add_hash_tags_bulk

Copy

import client
from client.models.add_hash_tags_bulk200_response import AddHashTagsBulk200Response
from client.models.bulk_create_hash_tags_body import BulkCreateHashTagsBody
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"]
# הסר את ההערה למטה על מנת להגדיר קידומת (למשל 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_create_hash_tags_body = client.BulkCreateHashTagsBody() # BulkCreateHashTagsBody |  (אופציונלי)
    try:
        api_response = api_instance.add_hash_tags_bulk(tenant_id=tenant_id, bulk_create_hash_tags_body=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)

מחיקת תגית

פרמטרים

Name	Type	Location	Required	Description
tag	string	path	כן
tenantId	string	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של delete_hash_tag

Copy

import client
from client.models.delete_hash_tag_request import DeleteHashTagRequest
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת המארח אינה חובה וברירת המחדל היא https://fastcomments.com
# עיין בקובץ configuration.py עבור רשימת כל פרמטרי התצורה הנתמכים.
# על הלקוח להגדיר את פרמטרי האימות והרשאה
# בהתאם למדיניות האבטחה של שרת ה-API.
# דוגמאות לכל שיטת אימות מסופקות להלן; השתמש בדוגמה
# שמתאימה למקרה השימוש שלך.
# Configure API key authorization: api_key
# הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
# configuration.api_key_prefix['api_key'] = 'Bearer'
# פתח הקשר (context) עם מופע של לקוח ה-API
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tag = 'tag_example' # str | 
    tenant_id = 'tenant_id_example' # str |  (אופציונלי)
    delete_hash_tag_request = client.DeleteHashTagRequest() # DeleteHashTagRequest |  (אופציונלי)
    try:
        api_response = api_instance.delete_hash_tag(tag, tenant_id=tenant_id, delete_hash_tag_request=delete_hash_tag_request)
        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)

קבלת תגיות

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
page	number	query	לא

תגובה

מחזיר: GetHashTags200Response

דוגמה

דוגמה ל-get_hash_tags

Copy

import client
from client.models.get_hash_tags200_response import GetHashTags200Response
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"]
# הסר את ההערה למטה כדי להגדיר תחילית (למשל 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 | 
    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)

עדכון חלקי של תגית

פרמטרים

Name	Type	Location	Required	Description
tag	string	path	כן
tenantId	string	query	לא

תגובה

מחזיר: PatchHashTag200Response

דוגמה

דוגמה ל-patch_hash_tag

Copy

import client
from client.models.patch_hash_tag200_response import PatchHashTag200Response
from client.models.update_hash_tag_body import UpdateHashTagBody
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
# configuration.api_key_prefix['api_key'] = 'Bearer'
# הכנס להקשר עם מופע של לקוח ה-API
with client.ApiClient(configuration) as api_client:
    # צור מופע של מחלקת ה-API
    api_instance = client.DefaultApi(api_client)
    tag = 'tag_example' # str | 
    tenant_id = 'tenant_id_example' # str |  (אופציונלי)
    update_hash_tag_body = client.UpdateHashTagBody() # UpdateHashTagBody |  (אופציונלי)
    try:
        api_response = api_instance.patch_hash_tag(tag, tenant_id=tenant_id, update_hash_tag_body=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)

יצירת ממונה

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן

תגובה

מחזיר: CreateModerator200Response

דוגמה

דוגמה ל-create_moderator

Copy

import client
from client.models.create_moderator200_response import CreateModerator200Response
from client.models.create_moderator_body import CreateModeratorBody
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 | 
    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)

מחיקת ממונה

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
sendEmail	string	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_moderator

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"]
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל 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 |  (optional)
    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)

קבלת ממונה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetModerator200Response

דוגמה

דוגמה ל-get_moderator

Copy

import client
from client.models.get_moderator200_response import GetModerator200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host אופציונלית והברירת מחדל היא https://fastcomments.com
# ראה את configuration.py לרשימה של כל פרמטרי התצורה הנתמכים.
# הלקוח חייב להגדיר את פרמטרי האימות וההרשאה
# בהתאם למדיניות האבטחה של שרת ה-API.
# דוגמאות לכל שיטת אימות מסופקות להלן, השתמש בדוגמה ש
# מספקת את צרכי האימות שלך.
# Configure API key authorization: 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_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)

קבלת ממונים

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
skip	number	query	לא

תגובה

מחזיר: GetModerators200Response

דוגמה

דוגמה ל-get_moderators

Copy

import client
from client.models.get_moderators200_response import GetModerators200Response
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)

שליחת הזמנה

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
fromName	string	query	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של send_invite

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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)

עדכון ממונה

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_moderator

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_moderator_body import UpdateModeratorBody
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host אופציונלית ובברירת המחדל היא https://fastcomments.com
# ראה configuration.py לרשימת כל פרמטרי ההגדרה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# על ה-client להגדיר את פרמטרי האימות והרשאות
# בהתאם למדיניות האבטחה של שרת ה-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)

מחיקת ספירת התראות

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_notification_count

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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)

קבלת ספירת התראות מהמטמון

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: GetCachedNotificationCount200Response

דוגמה

דוגמה ל-get_cached_notification_count

Copy

import client
from client.models.get_cached_notification_count200_response import GetCachedNotificationCount200Response
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 | 
    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)

קבלת ספירת התראות

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
userId	string	query	לא
urlId	string	query	לא
fromCommentId	string	query	לא
viewed	boolean	query	לא
type	string	query	לא

תגובה

מחזיר: GetNotificationCount200Response

דוגמה

דוגמה ל-get_notification_count

Copy

import client
from client.models.get_notification_count200_response import GetNotificationCount200Response
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'
# 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)
    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, user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type)
        print("The response of DefaultApi->get_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_notification_count: %s\n" % e)

קבלת התראות

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
userId	string	query	לא
urlId	string	query	לא
fromCommentId	string	query	לא
viewed	boolean	query	לא
type	string	query	לא
skip	number	query	לא

תגובה

מחזיר: GetNotifications200Response

דוגמה

דוגמה ל-get_notifications

Copy

import client
from client.models.get_notifications200_response import GetNotifications200Response
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"]
# בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש
# configuration.api_key_prefix['api_key'] = 'Bearer'
# פתח הקשר (context) עם מופע של לקוח ה-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, 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)

עדכון התראה

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_notification

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_notification_body import UpdateNotificationBody
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_notification_body = client.UpdateNotificationBody() # UpdateNotificationBody | 
    user_id = 'user_id_example' # str |  (אופציונלי)
    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)

הוספת עמוד

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
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
# קביעת ה-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_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)

מחיקת עמוד

פרמטרים

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
# הגדרת ה-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'
# 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)

קבלת עמוד לפי מזהה URL

פרמטרים

Name	Type	Location	Required	Description
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
# הגדרת ה-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"]
# הסר את ההערה שמתחת כדי להגדיר קידומת (למשל 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)

קבלת עמודים

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	Yes

תגובה

מחזיר: GetPagesAPIResponse

דוגמה

דוגמה ל-get_pages

Copy

import client
from client.models.get_pages_api_response import GetPagesAPIResponse
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 | 
    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)

עדכון חלקי של עמוד

פרמטרים

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

תגובה

מחזיר: 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
# קביעה של ה-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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם צריך
# configuration.api_key_prefix['api_key'] = 'Bearer'
# הכנס להקשר עם מופע של ה-API client
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)

מחיקת אירוע webhook ממתין

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

delete_pending_webhook_event דוגמה

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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.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)

קבלת ספירת אירועי webhook ממתינים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
commentId	string	query	לא
externalId	string	query	לא
eventType	string	query	לא
type	string	query	לא
domain	string	query	לא
attemptCountGT	number	query	לא

תגובה

מחזיר: GetPendingWebhookEventCount200Response

דוגמה

דוגמה ל-get_pending_webhook_event_count

Copy

import client
from client.models.get_pending_webhook_event_count200_response import GetPendingWebhookEventCount200Response
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 | 
    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, 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)

קבלת אירועי webhook ממתינים

פרמטרים

Name	Type	Location	Required
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
skip	number	query	No

תגובה

מחזיר: GetPendingWebhookEvents200Response

דוגמה

דוגמה ל-get_pending_webhook_events

Copy

import client
from client.models.get_pending_webhook_events200_response import GetPendingWebhookEvents200Response
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 | 
    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 |  (אופציונלי)
    skip = 3.4 # float |  (אופציונלי)
    try:
        api_response = api_instance.get_pending_webhook_events(tenant_id, 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)

יצירת תצורת שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תשובה

מחזיר: CreateQuestionConfig200Response

דוגמה

דוגמה ל-create_question_config

Copy

import client
from client.models.create_question_config200_response import CreateQuestionConfig200Response
from client.models.create_question_config_body import CreateQuestionConfigBody
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_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)

מחיקת תצורת שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_question_config

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"]
# בטלו את ההערה שלהלן כדי להגדיר קידומת (למשל 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)

קבלת תצורת שאלה

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetQuestionConfig200Response

דוגמה

דוגמת get_question_config

Copy

import client
from client.models.get_question_config200_response import GetQuestionConfig200Response
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)

קבלת תצורות שאלות

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
skip	number	query	לא

תגובה

מחזיר: GetQuestionConfigs200Response

דוגמה

דוגמה ל-get_question_configs

Copy

import client
from client.models.get_question_configs200_response import GetQuestionConfigs200Response
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 |  (optional)
    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)

עדכון תצורת שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_question_config

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_question_config_body import UpdateQuestionConfigBody
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_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)

יצירת תוצאת שאלה

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן

תגובה

מחזיר: CreateQuestionResult200Response

דוגמה

דוגמה ל-create_question_result

Copy

import client
from client.models.create_question_result200_response import CreateQuestionResult200Response
from client.models.create_question_result_body import CreateQuestionResultBody
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_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)

מחיקת תוצאת שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_question_result

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"]
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל 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)

קבלת תוצאת שאלה

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetQuestionResult200Response

דוגמה

דוגמה ל-get_question_result

Copy

import client
from client.models.get_question_result200_response import GetQuestionResult200Response
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
# הסירו את ההערה מהשורה למטה כדי להגדיר קידומת (למשל 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)

קבלת תוצאות שאלות

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
urlId	string	query	לא
userId	string	query	לא
startDate	string	query	לא
questionId	string	query	לא
questionIds	string	query	לא
skip	number	query	לא

תגובה

מחזיר: GetQuestionResults200Response

דוגמה

דוגמת get_question_results

Copy

import client
from client.models.get_question_results200_response import GetQuestionResults200Response
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 | 
    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, 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)

עדכון תוצאת שאלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_question_result

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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'
# הכנס להקשר (context) עם מופע של לקוח ה-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)

אגרגציה של תוצאות שאלות

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
questionId	string	query	לא
questionIds	array	query	לא
urlId	string	query	לא
timeBucket	string	query	לא
startDate	string	query	לא
forceRecalculate	boolean	query	לא

תגובה

מחזיר: AggregateQuestionResults200Response

דוגמה

דוגמת aggregate_question_results

Copy

import client
from client.models.aggregate_question_results200_response import AggregateQuestionResults200Response
from client.models.aggregate_time_bucket import AggregateTimeBucket
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'
# 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 | 
    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, 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)

אגרגציה המונית של תוצאות שאלות

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	Yes
forceRecalculate	boolean	query	No

תגובה

מחזיר: BulkAggregateQuestionResults200Response

דוגמה

דוגמה ל-bulk_aggregate_question_results

Copy

import client
from client.models.bulk_aggregate_question_results200_response import BulkAggregateQuestionResults200Response
from client.models.bulk_aggregate_question_results_request import BulkAggregateQuestionResultsRequest
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 | 
    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)

שילוב תגובות עם תוצאות שאלות

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
questionId	string	query	לא
questionIds	array	query	לא
urlId	string	query	לא
startDate	string	query	לא
forceRecalculate	boolean	query	לא
minValue	number	query	לא
maxValue	number	query	לא
limit	number	query	לא

תגובה

מחזיר: CombineCommentsWithQuestionResults200Response

דוגמה

דוגמה ל־combine_comments_with_question_results

Copy

import client
from client.models.combine_comments_with_question_results200_response import CombineCommentsWithQuestionResults200Response
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'
# הכנס להקשר (context) עם מופע של לקוח ה-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 |  (אופציונלי)
    question_ids = ['question_ids_example'] # List[str] |  (אופציונלי)
    url_id = 'url_id_example' # str |  (אופציונלי)
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (אופציונלי)
    force_recalculate = True # bool |  (אופציונלי)
    min_value = 3.4 # float |  (אופציונלי)
    max_value = 3.4 # float |  (אופציונלי)
    limit = 3.4 # float |  (אופציונלי)
    try:
        api_response = api_instance.combine_comments_with_question_results(tenant_id, 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)

הוספת משתמש SSO

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: 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
# הגדרת ה-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"]
# בטל את ההערה למטה כדי להגדיר קידומת (למשל 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)

מחיקת משתמש SSO

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
id	string	path	כן
deleteComments	boolean	query	לא
commentDeleteMode	string	query	לא

תגובה

מחזיר: DeleteSSOUserAPIResponse

דוגמה

דוגמה ל-delete_sso_user

Copy

import client
from client.models.delete_sso_user_api_response import DeleteSSOUserAPIResponse
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 | 
    delete_comments = True # bool |  (אופציונלי)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.delete_sso_user(tenant_id, id, 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)

קבלת משתמש SSO לפי אימייל

פרמטרים

Name	Type	Location	Required	Description
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
# הגדרת ה-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 | 
    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)

קבלת משתמש SSO לפי מזהה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
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'
# היכנס להקשר עם מופע של ApiClient
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)

קבלת משתמשי SSO

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
skip	integer	query	לא

תגובה

מחזיר: GetSSOUsers200Response

דוגמה

דוגמה ל-get_sso_users

Copy

import client
from client.models.get_sso_users200_response import GetSSOUsers200Response
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"]
# הסר את ההערת השורה למטה כדי להגדיר קידומת (למשל 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)

עדכון חלקי של משתמש SSO

פרמטרים

שם	סוג	מיקום	נדרש
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
# הגדרת 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 | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  (אופציונלי)
    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)

עדכון מלא של משתמש SSO

פרמטרים

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

תגובה

מחזיר: 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
# הגדרת ה-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"]
# הסר את ההערה בשורה שלמטה כדי להגדיר קידומת (למשל 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)

יצירת מנוי

פרמטרים

Name	Type	Location	Required	Description
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
# הגדרת ה-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"]
# הסירו את ההערה מתחת כדי להגדיר קידומת (למשל 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)

מחיקת מנוי

פרמטרים

Name	Type	Location	Required
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
# הגדרת ה-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"]
# בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש
# configuration.api_key_prefix['api_key'] = 'Bearer'
# הכנס לקונטקסט (with) עם מופע של לקוח ה-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.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)

קבלת מנויים

פרמטרים

Name	Type	Location	Required	Description
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
# הגדרת ה-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 |  (אופציונלי)
    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)

עדכון מנוי

פרמטרים

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
# הגדרת ה-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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש
# configuration.api_key_prefix['api_key'] = 'Bearer'
# הכנס להקשר (context) עם מופע של לקוח ה-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 |  (optional)
    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)

קבלת שימוש יומי של השוכר

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
yearNumber	number	query	לא
monthNumber	number	query	לא
dayNumber	number	query	לא
skip	number	query	לא

תשובה

מחזיר: GetTenantDailyUsages200Response

דוגמה

דוגמה ל-get_tenant_daily_usages

Copy

import client
from client.models.get_tenant_daily_usages200_response import GetTenantDailyUsages200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host אופציונלית ובברירת המחדל היא https://fastcomments.com
# עיין בקובץ configuration.py כדי לראות את כל פרמטרי התצורה הנתמכים.
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.
# על הלקוח להגדיר את פרמטרי האימות והרשאה
# בהתאם למדיניות האבטחה של שרת ה-API.
# דוגמאות לכל שיטת אימות מוצגות להלן, השתמש בדוגמה
# שמתאימה למקרה השימוש שלך.
# Configure API key authorization: api_key
# הגדר את אישור מפתח ה-API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# הסר את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) למפתח ה-API, אם צריך
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
# הכנס להקשר עם מופע של לקוח ה-API
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    # צור מופע של מחלקת ה-API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    year_number = 3.4 # float |  (optional)
    month_number = 3.4 # float |  (optional)
    day_number = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_tenant_daily_usages(tenant_id, 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)

יצירת חבילת שוכר

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן

תגובה

מוחזר: CreateTenantPackage200Response

דוגמה

דוגמה ל-create_tenant_package

Copy

import client
from client.models.create_tenant_package200_response import CreateTenantPackage200Response
from client.models.create_tenant_package_body import CreateTenantPackageBody
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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_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)

מחיקת חבילת שוכר

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של delete_tenant_package

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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.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)

קבלת חבילת שוכר

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetTenantPackage200Response

דוגמה

דוגמה ל-get_tenant_package

Copy

import client
from client.models.get_tenant_package200_response import GetTenantPackage200Response
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"]
# הסר את ההערה משורה מתחת כדי להגדיר קידומת (למשל 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 | 
    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)

קבלת חבילות שוכרים

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
skip	number	query	לא

תגובה

מחזיר: GetTenantPackages200Response

דוגמה

דוגמה ל-get_tenant_packages

Copy

import client
from client.models.get_tenant_packages200_response import GetTenantPackages200Response
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"]
# בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש
# configuration.api_key_prefix['api_key'] = 'Bearer'
# הכנס להקשר (context) עם מופע של לקוח ה-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)

החלפת חבילת שוכר

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-replace_tenant_package

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.replace_tenant_package_body import ReplaceTenantPackageBody
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"]
# הסר את ההערה מטה כדי להגדיר קידומת (למשל 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)

עדכון חבילת שוכר

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_tenant_package

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_tenant_package_body import UpdateTenantPackageBody
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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)

יצירת משתמש שוכר

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן

תשובה

מחזיר: CreateTenantUser200Response

דוגמה

דוגמה ל-create_tenant_user

Copy

import client
from client.models.create_tenant_user200_response import CreateTenantUser200Response
from client.models.create_tenant_user_body import CreateTenantUserBody
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 | 
    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)

מחיקת משתמש שוכר

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
deleteComments	string	query	לא
commentDeleteMode	string	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_tenant_user

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# דוגמאות לכל שיטת אימות מסופקות להלן, השתמש בדוגמה המתאימה למקרה השימוש שלך.
# 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 | 
    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, 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)

קבלת משתמש שוכר

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetTenantUser200Response

דוגמה

דוגמה ל-get_tenant_user

Copy

import client
from client.models.get_tenant_user200_response import GetTenantUser200Response
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'
# 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_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)

קבלת משתמשי שוכרים

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
skip	number	query	לא

תגובה

מחזיר: GetTenantUsers200Response

דוגמה

דוגמה ל-get_tenant_users

Copy

import client
from client.models.get_tenant_users200_response import GetTenantUsers200Response
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 | 
    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)

החלפת משתמש שוכר

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
id	string	path	כן
updateComments	string	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של replace_tenant_user

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.replace_tenant_user_body import ReplaceTenantUserBody
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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)

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	Yes
id	string	path	Yes
redirectURL	string	query	No

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-send_login_link

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"]
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל 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)

עדכון משתמש שוכר

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
updateComments	string	query	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_tenant_user

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_tenant_user_body import UpdateTenantUserBody
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 | 
    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)

יצירת שוכר

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן

תגובה

מחזיר: CreateTenant200Response

דוגמה

דוגמה ל-create_tenant

Copy

import client
from client.models.create_tenant200_response import CreateTenant200Response
from client.models.create_tenant_body import CreateTenantBody
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"]
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל 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)

מחיקת שוכר

פרמטרים

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

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_tenant

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"]
# הסר הערת שורה למטה כדי להגדיר קידומת (למשל 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 | 
    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)

קבלת שוכר

פרמטרים

שם	סוג	Location	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetTenant200Response

דוגמה

דוגמה ל-get_tenant

Copy

import client
from client.models.get_tenant200_response import GetTenant200Response
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 client
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(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)

קבלת שוכרים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
meta	string	query	לא
skip	number	query	לא

תגובה

מחזיר: GetTenants200Response

דוגמה

דוגמה ל-get_tenants

Copy

import client
from client.models.get_tenants200_response import GetTenants200Response
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 | 
    meta = 'meta_example' # str |  (אופציונלי)
    skip = 3.4 # float |  (אופציונלי)
    try:
        api_response = api_instance.get_tenants(tenant_id, 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)

עדכון שוכר

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_tenant

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_tenant_body import UpdateTenantBody
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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_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)

שינוי מצב כרטיס

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
userId	string	query	כן
id	string	path	כן

תגובה

מחזיר: ChangeTicketState200Response

דוגמה

דוגמה ל-change_ticket_state

Copy

import client
from client.models.change_ticket_state200_response import ChangeTicketState200Response
from client.models.change_ticket_state_body import ChangeTicketStateBody
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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)

יצירת כרטיס

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
userId	string	query	כן

תגובה

מחזיר: CreateTicket200Response

דוגמה

דוגמה ל-create_ticket

Copy

import client
from client.models.create_ticket200_response import CreateTicket200Response
from client.models.create_ticket_body import CreateTicketBody
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 | 
    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)

קבלת כרטיס

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
id	string	path	כן
userId	string	query	לא

תגובה

מחזיר: GetTicket200Response

דוגמה

דוגמה של get_ticket

Copy

import client
from client.models.get_ticket200_response import GetTicket200Response
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"]
# בטל את ההערה למטה כדי להגדיר קידומת (למשל 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.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)

קבלת כרטיסים

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
userId	string	query	לא
state	number	query	לא
skip	number	query	לא
limit	number	query	לא

תגובה

מחזיר: GetTickets200Response

דוגמה

דוגמה ל-get_tickets

Copy

import client
from client.models.get_tickets200_response import GetTickets200Response
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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, 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)

העלאת תמונה

העלאת תמונה ושינוי גודלה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	path	כן
sizePreset	string	query	לא	תצורת גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים)
urlId	string	query	לא	מזהה דף שממנו מתבצעת ההעלאה, לצורך תצורה

תגובה

מחזיר: UploadImageResponse

דוגמה

דוגמת upload_image

Copy

import client
from client.models.size_preset import SizePreset
from client.models.upload_image_response import UploadImageResponse
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 | 
    file = None # bytearray | 
    size_preset = client.SizePreset() # SizePreset | תצורת גודל: \"Default\" (1000x1000px) או \"CrossPlatform\" (יוצר גדלים למכשירים פופולריים) (אופציונלי)
    url_id = 'url_id_example' # str | מזהה דף שממנו מתבצעת ההעלאה, לצורך תצורה (אופציונלי)
    try:
        api_response = api_instance.upload_image(tenant_id, file, 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)

קבלת התקדמות תג למשתמש לפי מזהה

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: GetUserBadgeProgressById200Response

דוגמה

דוגמה של get_user_badge_progress_by_id

Copy

import client
from client.models.get_user_badge_progress_by_id200_response import GetUserBadgeProgressById200Response
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"]
# הסירו את ההערה למטה כדי להגדיר קידומת (למשל 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_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)

קבלת התקדמות תג משתמש לפי מזהה משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
userId	string	path	כן

תגובה

מחזיר: GetUserBadgeProgressById200Response

דוגמה

דוגמה ל-get_user_badge_progress_by_user_id

Copy

import client
from client.models.get_user_badge_progress_by_id200_response import GetUserBadgeProgressById200Response
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (לדוגמה 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)

קבלת רשימת התקדמות תגי משתמש

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
userId	string	query	לא
limit	number	query	לא
skip	number	query	לא

תגובה

מחזיר: GetUserBadgeProgressList200Response

דוגמה

דוגמה ל-get_user_badge_progress_list

Copy

import client
from client.models.get_user_badge_progress_list200_response import GetUserBadgeProgressList200Response
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 |  (אופציונלי)
    limit = 3.4 # float |  (אופציונלי)
    skip = 3.4 # float |  (אופציונלי)
    try:
        api_response = api_instance.get_user_badge_progress_list(tenant_id, 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)

יצירת תג משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן

תגובה

מחזיר: CreateUserBadge200Response

דוגמה

דוגמה ל-create_user_badge

Copy

import client
from client.models.create_user_badge200_response import CreateUserBadge200Response
from client.models.create_user_badge_params import CreateUserBadgeParams
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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)

מחיקת תג משתמש

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: UpdateUserBadge200Response

דוגמה

דוגמה ל-delete_user_badge

Copy

import client
from client.models.update_user_badge200_response import UpdateUserBadge200Response
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 | 
    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)

קבלת תג משתמש

פרמטרים

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

תגובה

מחזיר: GetUserBadge200Response

דוגמה

דוגמת get_user_badge

Copy

import client
from client.models.get_user_badge200_response import GetUserBadge200Response
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)

קבלת תגי משתמש

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
userId	string	query	לא
badgeId	string	query	לא
type	number	query	לא
displayedOnComments	boolean	query	לא
limit	number	query	לא
skip	number	query	לא

תגובה

מחזיר: GetUserBadges200Response

דוגמה

דוגמת get_user_badges

Copy

import client
from client.models.get_user_badges200_response import GetUserBadges200Response
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 | 
    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, 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)

עדכון תג משתמש

פרמטרים

שם	סוג	Location	נדרש	תיאור
tenantId	string	query	כן
id	string	path	כן

תגובה

מחזיר: UpdateUserBadge200Response

דוגמה

דוגמה ל-update_user_badge

Copy

import client
from client.models.update_user_badge200_response import UpdateUserBadge200Response
from client.models.update_user_badge_params import UpdateUserBadgeParams
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_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)

קבלת ספירת התראות משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: GetUserNotificationCount200Response

דוגמה

get_user_notification_count דוגמה

Copy

import client
from client.models.get_user_notification_count200_response import GetUserNotificationCount200Response
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 | 
    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)

קבלת התראות משתמש

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
pageSize	integer	query	לא
afterId	string	query	לא
includeContext	boolean	query	לא
afterCreatedAt	integer	query	לא
unreadOnly	boolean	query	לא
dmOnly	boolean	query	לא
noDm	boolean	query	לא
includeTranslations	boolean	query	לא
sso	string	query	לא

תגובה

מחזיר: GetUserNotifications200Response

דוגמה

דוגמת get_user_notifications

Copy

import client
from client.models.get_user_notifications200_response import GetUserNotifications200Response
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 | 
    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 |  (אופציונלי)
    sso = 'sso_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.get_user_notifications(tenant_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, 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)

איפוס ספירת התראות משתמש

פרמטרים

שם	סוג	מיקום	חובה	תיאור
tenantId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: ResetUserNotifications200Response

דוגמה

דוגמה ל-reset_user_notification_count

Copy

import client
from client.models.reset_user_notifications200_response import ResetUserNotifications200Response
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 | 
    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)

איפוס התראות משתמש

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
afterId	string	query	לא
afterCreatedAt	integer	query	לא
unreadOnly	boolean	query	לא
dmOnly	boolean	query	לא
noDm	boolean	query	לא
sso	string	query	לא

תגובה

מחזיר: ResetUserNotifications200Response

דוגמה

דוגמה ל-reset_user_notifications

Copy

import client
from client.models.reset_user_notifications200_response import ResetUserNotifications200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת host היא אופציונלית ומוגדרת כברירת מחדל ל- https://fastcomments.com
# ראה את configuration.py לרשימה של כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# הכנסו להקשר עם מופע של ApiClient
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 |  (optional)
    after_created_at = 56 # int |  (optional)
    unread_only = True # bool |  (optional)
    dm_only = True # bool |  (optional)
    no_dm = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.reset_user_notifications(tenant_id, 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)

עדכון סטטוס מנוי להתראות תגובות של משתמש

הפעל או השבת התראות עבור תגובה ספציפית.

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
notificationId	string	path	כן
optedInOrOut	string	path	כן
commentId	string	query	כן
sso	string	query	לא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה ל-update_user_notification_comment_subscription_status

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com
# ראה את configuration.py לרשימת כל פרמטרי ההגדרה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# פתח הקשר (context) עם מופע של לקוח ה-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 | 
    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)

עדכון סטטוס מנוי להתראות עמוד

אפשר להפעיל או לבטל התראות עבור דף. כאשר משתמשים מנויים לדף, נוצרות התראות עבור תגובות שורש חדשות, וגם

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
urlId	string	query	כן
url	string	query	כן
pageTitle	string	query	כן
subscribedOrUnsubscribed	string	path	כן
sso	string	query	לא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה ל-update_user_notification_page_subscription_status

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
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 | 
    url = 'url_example' # str | 
    page_title = 'page_title_example' # str | 
    subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example' # str | 
    sso = 'sso_example' # str |  (אופציונלי)
    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)

עדכון סטטוס התראות משתמש

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	query	כן
notificationId	string	path	כן
newStatus	string	path	כן
sso	string	query	לא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה ל-update_user_notification_status

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
from client.rest import ApiException
from pprint import pprint
# הגדרת ה-host היא אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com
# ראו את configuration.py לרשימה של כל פרמטרי התצורה הנתמכים.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# היכנסו להקשר עם מופע של ApiClient
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)

קבלת סטטוסי נוכחות של משתמשים

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
urlIdWS	string	query	כן
userIds	string	query	כן

תגובה

מחזיר: GetUserPresenceStatuses200Response

דוגמה

דוגמה ל-get_user_presence_statuses

Copy

import client
from client.models.get_user_presence_statuses200_response import GetUserPresenceStatuses200Response
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_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)

חיפוש משתמשים

פרמטרים

שם	סוג	מיקום	נדרש
tenantId	string	path	כן
urlId	string	query	כן
usernameStartsWith	string	query	לא
mentionGroupIds	array	query	לא
sso	string	query	לא
searchSection	string	query	לא

תגובה

מחזיר: SearchUsers200Response

דוגמה

search_users דוגמה

Copy

import client
from client.models.search_users200_response import SearchUsers200Response
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 | 
    username_starts_with = 'username_starts_with_example' # str |  (אופציונלי)
    mention_group_ids = ['mention_group_ids_example'] # List[str] |  (אופציונלי)
    sso = 'sso_example' # str |  (אופציונלי)
    search_section = 'search_section_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.search_users(tenant_id, url_id, 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)

קבלת משתמש

פרמטרים

שם	סוג	מיקום	נדרש	תיאור
tenantId	string	query	Yes
id	string	path	Yes

תגובה

מחזיר: GetUser200Response

דוגמה

דוגמת get_user

Copy

import client
from client.models.get_user200_response import GetUser200Response
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(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)

יצירת הצבעה

פרמטרים

שם	סוג	מיקום	חובה
tenantId	string	query	כן
commentId	string	query	כן
direction	string	query	כן
userId	string	query	לא
anonUserId	string	query	לא

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמת create_vote

Copy

import client
from client.models.vote_comment200_response import VoteComment200Response
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 | 
    comment_id = 'comment_id_example' # str | 
    direction = 'direction_example' # str | 
    user_id = 'user_id_example' # str |  (אופציונלי)
    anon_user_id = 'anon_user_id_example' # str |  (אופציונלי)
    try:
        api_response = api_instance.create_vote(tenant_id, comment_id, direction, 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)

מחיקת הצבעה

פרמטרים

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

תגובה

מוחזר: DeleteCommentVote200Response

דוגמה

דוגמה ל-delete_vote

Copy

import client
from client.models.delete_comment_vote200_response import DeleteCommentVote200Response
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 |  (אופציונלי)
    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)

קבלת הצבעות

פרמטרים

Name	Type	Location	Required	Description
tenantId	string	query	כן
urlId	string	query	כן

תגובה

מחזיר: GetVotes200Response

דוגמה

דוגמה ל-get_votes

Copy

import client
from client.models.get_votes200_response import GetVotes200Response
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"]
# בטל את ההערה למטה כדי להגדיר קידומת (למשל 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)

קבלת הצבעות עבור משתמש

פרמטרים

Name	Type	Location	Required
tenantId	string	query	כן
urlId	string	query	כן
userId	string	query	לא
anonUserId	string	query	לא

תגובה

מחזיר: GetVotesForUser200Response

דוגמה

דוגמה ל-get_votes_for_user

Copy

import client
from client.models.get_votes_for_user200_response import GetVotesForUser200Response
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"]
# הסר את ההערה למטה כדי להגדיר קידומת (למשל 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 |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.get_votes_for_user(tenant_id, url_id, 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 לקבלת הנחיות לתרומה.

שפה 🇮🇱 עברית

התחלה

תיעוד

אגרגציה

יומני ביקורת

חסימה מתוך תגובה

בדיקת תגובות חסומות

תגובות

תצורות דומיין

תבניות דוא"ל

יומן אירועים

פוסטים בפיד

דיווח על תגובה

תגיות (Hashtags)

ממונים

ספירת התראות

התראות

עמודים

אירועי Webhook ממתינים

תצורות שאלות

תוצאות שאלות

אגרגציה של תוצאות שאלות

משתמשי SSO

מנויים

שימוש יומי של שוכר

חבילות שוכרים

משתמשי שוכרים

שוכרים

כרטיסים

העלאת תמונה

התקדמות תגי משתמש

תגי משתמש

התראות משתמש

סטטוס נוכחות משתמש

חיפוש משתמשים

משתמשים

הצבעות

FastComments Python SDK

מאגר

התקנה

PyPI

תכולת הספרייה

ממשקי API ציבוריים לעומת מאובטחים

התחלה מהירה

שימוש ב-APIs מאומתים (DefaultApi)

שימוש ב-APIs ציבוריים (PublicApi)

שימוש ב-SSO (כניסה יחידה)

בעיות נפוצות

הערות

מזהי שידור

דרישות

אגרגציה

פרמטרים

תגובה

דוגמה

קבלת יומני ביקורת

פרמטרים

תגובה

דוגמה

חסימה מתגובה ציבורית

פרמטרים

תגובה

דוגמה

ביטול חסימה מתגובה ציבורית

פרמטרים

תגובה

דוגמה

בדיקת תגובות לחסימה

פרמטרים

תגובה

דוגמה

חסימת משתמש בעקבות תגובה

פרמטרים

תגובה

דוגמה

יצירת תגובה ציבורית

פרמטרים

תגובה

דוגמה

מחיקת תגובה