FastComments.com

FastComments SDK ל‑Ruby


זהו ה-SDK הרשמי של Ruby עבור FastComments.

ה-SDK הרשמי של Ruby עבור ה-API של FastComments

מאגר

צפה ב-GitHub


התקנה Internal Link


הוסף שורה זו ל-Gemfile של היישום שלך:

gem 'fastcomments'

ואז הרץ:

bundle install

או התקן אותו בעצמך כך:

gem install fastcomments

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

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

APIs ציבוריים לעומת מאובטחים

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

התחלה מהירה Internal Link

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

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

require 'fastcomments-client'

# צור והגדר את לקוח ה-API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# דרוש: הגדר את מפתח ה-API שלך (קבל אותו מדשבורד FastComments שלך)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# צור את מופע ה-API עם הלקוח שהוגדר
api = FastCommentsClient::DefaultApi.new(api_client)

# עכשיו תוכל לבצע קריאות API מאומתות
begin
  # דוגמה: הוסף משתמש SSO
  user_data = {
    id: 'user-123',
    email: 'user@example.com',
    displayName: 'John Doe'
  }

  response = api.add_sso_user('YOUR_TENANT_ID', user_data)
  puts "User created: #{response}"

rescue FastCommentsClient::ApiError => e
  puts "Error: #{e.response_body}"
  # שגיאות נפוצות:
  # - 401: מפתח ה-API חסר או לא תקף
  # - 400: אימות הבקשה נכשל
end

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

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

require 'fastcomments-client'

public_api = FastCommentsClient::PublicApi.new

begin
  response = public_api.get_comments_public(
    tenant_id: 'YOUR_TENANT_ID',
    url_id: 'page-url-id'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

בעיות נפוצות

  1. שגיאת 401 "missing-api-key": ודא שאתה מגדיר config.api_key['x-api-key'] = 'YOUR_KEY' לפני יצירת מופע DefaultApi.
  2. מחלקת API שגויה: השתמש ב-DefaultApi עבור בקשות מאומתות בצד השרת, וב-PublicApi עבור בקשות בצד הלקוח/ציבוריות.
  3. מפתח API ריק: ה-SDK פשוט ידלג על אימות אם מפתח ה-API הוא null, מה שייגרום לשגיאות 401.

הערות Internal Link

מזהי שידור

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

SSO (כניסה אחידה)

לדוגמאות ל-SSO, ראה למטה.

שימוש ב-SSO Internal Link

SSO פשוט

require 'fastcomments'
require 'fastcomments-client'

# צור אסימון SSO פשוט
user = FastComments::SSO::SimpleSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  avatar: 'https://example.com/avatar.jpg'
)

sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token

puts "SSO Token: #{token}"

# השתמש באסימון SSO כדי לבצע קריאת API מאומתת
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

response = public_api.get_comments_public(
  tenant_id: 'your-tenant-id',
  url_id: 'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

SSO מאובטח

require 'fastcomments'
require 'fastcomments-client'

# צור אסימון SSO מאובטח
user = FastComments::SSO::SecureSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  username: 'johndoe',
  avatar: 'https://example.com/avatar.jpg'
)

api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token

puts "Secure SSO Token: #{token}"

# השתמש באסימון SSO כדי לבצע קריאת API מאומתת
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

response = public_api.get_comments_public(
  tenant_id: 'your-tenant-id',
  url_id: 'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

אגרגציה Internal Link

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
parentTenantIdstringqueryלא
includeStatsbooleanqueryלא

תגובה

מחזיר: AggregationResponse

דוגמה

דוגמה ל-aggregate
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |
15opts = {
16 parent_tenant_id: 'parent_tenant_id_example', # String |
17 include_stats: true # Boolean |
18}
19
20begin
21
22 result = api_instance.aggregate(tenant_id, aggregation_request, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->aggregate: #{e}"
26end
27

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

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
limitnumberqueryלא
skipnumberqueryלא
orderstringqueryלא
afternumberqueryלא
beforenumberqueryלא

תגובה

מחזיר: GetAuditLogs200Response

דוגמה

דוגמת get_audit_logs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה על השורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 limit: 1.2, # Float |
16 skip: 1.2, # Float |
17 order: FastCommentsClient::SORTDIR::ASC, # SORTDIR |
18 after: 1.2, # Float |
19 before: 1.2 # Float |
20}
21
22begin
23
24 result = api_instance.get_audit_logs(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_audit_logs: #{e}"
28end
29

חסימה מתגובה (ציבורי) Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringשאילתהכן
commentIdstringנתיבכן
ssostringשאילתהלא

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-block_from_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->block_from_comment_public: #{e}"
19end
20

הסרת חסימה מתגובה (ציבורי) Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה ל-un_block_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_block_comment_public: #{e}"
19end
20

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
commentIdsstringqueryכןרשימת מזהי תגובות מופרדת בפסיקים.
ssostringqueryלא

תגובה

מחזיר: CheckedCommentsForBlocked200Response

דוגמה

דוגמה ל-checked_comments_for_blocked
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_ids = 'comment_ids_example' # String | רשימת מזהי תגובות מופרדת בפסיקים.
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
18end
19

חסימת משתמש מתגובה Internal Link

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא
anonUserIdstringqueryלא

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
27end
28

יצירת תגובה (ציבורי) Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
urlIdstringqueryכן
broadcastIdstringqueryכן
sessionIdstringqueryלא
ssostringqueryלא

Response

מחזיר: CreateCommentPublic200Response

דוגמה

דוגמה ל-create_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8broadcast_id = 'broadcast_id_example' # מחרוזת |
9comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData |
10opts = {
11 session_id: 'session_id_example', # מחרוזת |
12 sso: 'sso_example' # מחרוזת |
13}
14
15begin
16
17 result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->create_comment_public: #{e}"
21end
22

מחיקת תגובה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
isLivebooleanqueryNo

תגובה

מחזיר: DeleteComment200Response

דוגמה

דוגמה ל-delete_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדרת אישור באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, למשל 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 context_user_id: 'context_user_id_example', # String |
17 is_live: true # Boolean |
18}
19
20begin
21
22 result = api_instance.delete_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_comment: #{e}"
26end
27

מחיקת תגובה (ציבורי) Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
commentIdstringpathכן
broadcastIdstringqueryכן
editKeystringqueryלא
ssostringqueryלא

תגובה

מחזיר: DeleteCommentPublic200Response

דוגמה

דוגמה ל-delete_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8broadcast_id = 'broadcast_id_example' # מחרוזת |
9opts = {
10 edit_key: 'edit_key_example', # מחרוזת |
11 sso: 'sso_example' # מחרוזת |
12}
13
14begin
15
16 result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->delete_comment_public: #{e}"
20end
21

מחיקת הצבעת תגובה Internal Link

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringpathכן
commentIdstringpathכן
voteIdstringpathכן
urlIdstringqueryכן
broadcastIdstringqueryכן
editKeystringqueryלא
ssostringqueryלא

תגובה

מחזיר: DeleteCommentVote200Response

דוגמה

דוגמה ל-delete_comment_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8vote_id = 'vote_id_example' # מחרוזת |
9url_id = 'url_id_example' # מחרוזת |
10broadcast_id = 'broadcast_id_example' # מחרוזת |
11opts = {
12 edit_key: 'edit_key_example', # מחרוזת |
13 sso: 'sso_example' # מחרוזת |
14}
15
16begin
17
18 result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->delete_comment_vote: #{e}"
22end
23

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא
anonUserIdstringqueryלא

תשובה

מחזיר: FlagComment200Response

דוגמה

דוגמת flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אישור
5FastCommentsClient.configure do |config|
6 # הגדר אישור מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל היא nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->flag_comment: #{e}"
26end
27

קבלת תגובה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetComment200Response

דוגמה

דוגמה של get_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # קבע תצורת אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_comment(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_comment: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
commentIdstringpathכן
editKeystringqueryלא
ssostringqueryלא

תגובה

מחזיר: GetCommentText200Response

דוגמה

דוגמה ל-get_comment_text
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8opts = {
9 edit_key: 'edit_key_example', # מחרוזת |
10 sso: 'sso_example' # מחרוזת |
11}
12
13begin
14
15 result = api_instance.get_comment_text(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_text: #{e}"
19end
20

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

תגובה

מחזיר: GetCommentVoteUserNames200Response

דוגמה

דוגמה ל־get_comment_vote_user_names
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8dir = 56 # מספר שלם |
9opts = {
10 sso: 'sso_example' # מחרוזת |
11}
12
13begin
14
15 result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
19end
20

קבלת תגובות Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
pageintegerqueryלא
limitintegerqueryלא
skipintegerqueryלא
asTreebooleanqueryלא
skipChildrenintegerqueryלא
limitChildrenintegerqueryלא
maxTreeDepthintegerqueryלא
urlIdstringqueryלא
userIdstringqueryלא
anonUserIdstringqueryלא
contextUserIdstringqueryלא
hashTagstringqueryלא
parentIdstringqueryלא
directionstringqueryלא

תגובה

מחזיר: GetComments200Response

דוגמה

דוגמה ל-get_comments
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 56, # Integer |
16 limit: 56, # Integer |
17 skip: 56, # Integer |
18 as_tree: true, # Boolean |
19 skip_children: 56, # Integer |
20 limit_children: 56, # Integer |
21 max_tree_depth: 56, # Integer |
22 url_id: 'url_id_example', # String |
23 user_id: 'user_id_example', # String |
24 anon_user_id: 'anon_user_id_example', # String |
25 context_user_id: 'context_user_id_example', # String |
26 hash_tag: 'hash_tag_example', # String |
27 parent_id: 'parent_id_example', # String |
28 direction: FastCommentsClient::SortDirections::OF # SortDirections |
29}
30
31begin
32
33 result = api_instance.get_comments(tenant_id, opts)
34 p result
35rescue FastCommentsClient::ApiError => e
36 puts "Error when calling DefaultApi->get_comments: #{e}"
37end
38

קבלת תגובות (ציבורי) Internal Link

req tenantId urlId

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringנתיבכן
urlIdstringשאילתהכן
pageintegerשאילתהלא
directionstringשאילתהלא
ssostringשאילתהלא
skipintegerשאילתהלא
skipChildrenintegerשאילתהלא
limitintegerשאילתהלא
limitChildrenintegerשאילתהלא
countChildrenbooleanשאילתהלא
fetchPageForCommentIdstringשאילתהלא
includeConfigbooleanשאילתהלא
countAllbooleanשאילתהלא
includei10nbooleanשאילתהלא
localestringשאילתהלא
modulesstringשאילתהלא
isCrawlerbooleanשאילתהלא
includeNotificationCountbooleanשאילתהלא
asTreebooleanשאילתהלא
maxTreeDepthintegerשאילתהלא
useFullTranslationIdsbooleanשאילתהלא
parentIdstringשאילתהלא
searchTextstringשאילתהלא
hashTagsarrayשאילתהלא
userIdstringשאילתהלא
customConfigStrstringשאילתהלא
afterCommentIdstringשאילתהלא
beforeCommentIdstringשאילתהלא

תגובה

מחזיר: GetCommentsPublic200Response

דוגמה

דוגמה של get_comments_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 page: 56, # Integer |
10 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
11 sso: 'sso_example', # String |
12 skip: 56, # Integer |
13 skip_children: 56, # Integer |
14 limit: 56, # Integer |
15 limit_children: 56, # Integer |
16 count_children: true, # Boolean |
17 fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String |
18 include_config: true, # Boolean |
19 count_all: true, # Boolean |
20 includei10n: true, # Boolean |
21 locale: 'locale_example', # String |
22 modules: 'modules_example', # String |
23 is_crawler: true, # Boolean |
24 include_notification_count: true, # Boolean |
25 as_tree: true, # Boolean |
26 max_tree_depth: 56, # Integer |
27 use_full_translation_ids: true, # Boolean |
28 parent_id: 'parent_id_example', # String |
29 search_text: 'search_text_example', # String |
30 hash_tags: ['inner_example'], # Array<String> |
31 user_id: 'user_id_example', # String |
32 custom_config_str: 'custom_config_str_example', # String |
33 after_comment_id: 'after_comment_id_example', # String |
34 before_comment_id: 'before_comment_id_example' # String |
35}
36
37begin
38
39 result = api_instance.get_comments_public(tenant_id, url_id, opts)
40 p result
41rescue FastCommentsClient::ApiError => e
42 puts "Error when calling PublicApi->get_comments_public: #{e}"
43end
44

נעילת תגובה Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
commentIdstringpathכן
broadcastIdstringqueryכן
ssostringqueryלא

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמת lock_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->lock_comment: #{e}"
19end
20

נעיצה של תגובה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
commentIdstringpathכן
broadcastIdstringqueryכן
ssostringqueryלא

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמה ל-pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->pin_comment: #{e}"
19end
20

שמירת תגובה Internal Link


פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
isLivebooleanqueryלא
doSpamCheckbooleanqueryלא
sendEmailsbooleanqueryלא
populateNotificationsbooleanqueryלא

תגובה

מחזיר: SaveComment200Response

דוגמה

דוגמה ל-save_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קביעת הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comment(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comment: #{e}"
28end
29

שמירת תגובות באצווה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
isLivebooleanqueryלא
doSpamCheckbooleanqueryלא
sendEmailsbooleanqueryלא
populateNotificationsbooleanqueryלא

תגובה

מחזיר: Array&lt;SaveComment200Response&gt;

דוגמה

דוגמה ל-save_comments_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # מערך<CreateCommentParams> |
15opts = {
16 is_live: true, # בוליאני |
17 do_spam_check: true, # בוליאני |
18 send_emails: true, # בוליאני |
19 populate_notifications: true # בוליאני |
20}
21
22begin
23
24 result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
28end
29

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

תגובה

מחזיר: SetCommentText200Response

דוגמה

דוגמה ל-set_comment_text
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest |
10opts = {
11 edit_key: 'edit_key_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->set_comment_text: #{e}"
21end
22

הסרת חסימה של משתמש מתגובה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא
anonUserIdstringqueryלא

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה ל-un_block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
27end
28

הסרת דיווח על תגובה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא
anonUserIdstringqueryלא

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמה ל-un_flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.un_flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->un_flag_comment: #{e}"
26end
27

שחרור נעילת תגובה Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
commentIdstringpathכן
broadcastIdstringqueryכן
ssostringqueryלא

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה: un_lock_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8broadcast_id = 'broadcast_id_example' # מחרוזת |
9opts = {
10 sso: 'sso_example' # מחרוזת |
11}
12
13begin
14
15 result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_lock_comment: #{e}"
19end
20

הסרת נעיצה של תגובה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
commentIdstringpathכן
broadcastIdstringqueryכן
ssostringqueryלא

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמה ל-un_pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8broadcast_id = 'broadcast_id_example' # מחרוזת |
9opts = {
10 sso: 'sso_example' # מחרוזת |
11}
12
13begin
14
15 result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_pin_comment: #{e}"
19end
20

עדכון תגובה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
contextUserIdstringqueryלא
doSpamCheckbooleanqueryלא
isLivebooleanqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

update_comment דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams |
16opts = {
17 context_user_id: 'context_user_id_example', # String |
18 do_spam_check: true, # Boolean |
19 is_live: true # Boolean |
20}
21
22begin
23
24 result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->update_comment: #{e}"
28end
29

הצבעה על תגובה Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
commentIdstringpathכן
urlIdstringqueryכן
broadcastIdstringqueryכן
sessionIdstringqueryלא
ssostringqueryלא

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמה ל-vote_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8url_id = 'url_id_example' # String |
9broadcast_id = 'broadcast_id_example' # String |
10vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams |
11opts = {
12 session_id: 'session_id_example', # String |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->vote_comment: #{e}"
22end
23

הוספת הגדרת דומיין Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: AddDomainConfig200Response

דוגמה

דוגמה ל-add_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קבע את הרשאת מפתח ה-API: api_key
7 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת המחדל: nil)
8 # config.api_key_prefix['x-api-key'] = 'Bearer'
9end
10
11api_instance = FastCommentsClient::DefaultApi.new
12tenant_id = 'tenant_id_example' # String |
13add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |
14
15begin
16
17 result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->add_domain_config: #{e}"
21end
22

מחיקת הגדרת דומיין Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
domainstringpathכן

תגובה

מחזיר: DeleteDomainConfig200Response

דוגמה

דוגמה ל-delete_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.delete_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_domain_config: #{e}"
22end
23

קבלת הגדרת דומיין Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
domainstringpathכן

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-get_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14domain = 'domain_example' # מחרוזת |
15
16begin
17
18 result = api_instance.get_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_domain_config: #{e}"
22end
23

קבלת הגדרות דומיין Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: GetDomainConfigs200Response

דוגמה

דוגמה ל-get_domain_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_domain_configs(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_domain_configs: #{e}"
21end
22

עדכון חלקי של הגדרת דומיין Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
domainToUpdatestringpathכן

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-patch_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams |
16
17begin
18
19 result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_domain_config: #{e}"
23end
24

החלפת הגדרת דומיין Internal Link

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
domainToUpdatestringpathכן

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-put_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams |
16
17begin
18
19 result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->put_domain_config: #{e}"
23end
24

יצירת תבנית אימייל Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: CreateEmailTemplate200Response

דוגמה

דוגמה ל-create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר הרשאה
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה בשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody |
15
16begin
17
18 result = api_instance.create_email_template(tenant_id, create_email_template_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_email_template: #{e}"
22end
23

מחיקת תבנית אימייל Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל היא nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_email_template: #{e}"
22end
23

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן
errorIdstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל־delete_email_template_render_error
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15error_id = 'error_id_example' # String |
16
17begin
18
19 result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
23end
24

קבלת תבנית אימייל Internal Link

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetEmailTemplate200Response

דוגמה

דוגמה ל-get_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדרת אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_email_template: #{e}"
22end
23

קבלת הגדרות תבניות אימייל Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: GetEmailTemplateDefinitions200Response

דוגמה

דוגמה ל־get_email_template_definitions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קונפיגורציה של הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14
15begin
16
17 result = api_instance.get_email_template_definitions(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
21end
22

קבלת שגיאות רינדור של תבניות אימייל Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
skipnumberqueryלא

תגובה

מחזיר: GetEmailTemplateRenderErrors200Response

דוגמה

דוגמה ל-get_email_template_render_errors
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל - nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15opts = {
16 skip: 1.2 # מספר עשרוני |
17}
18
19begin
20
21 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
25end
26

קבלת תבניות אימייל Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
skipnumberqueryלא

תגובה

מחזיר: GetEmailTemplates200Response

דוגמה

דוגמה ל-get_email_templates
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_email_templates(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_email_templates: #{e}"
24end
25

רינדור תבנית אימייל Internal Link

פרמטרים

שםסוגמיקוםדרושתיאור
tenantIdstringqueryכן
localestringqueryלא

תגובה

מחזיר: RenderEmailTemplate200Response

דוגמה

דוגמה ל-render_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # קבע אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה של השורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ערך ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody |
15opts = {
16 locale: 'locale_example' # String |
17}
18
19begin
20
21 result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->render_email_template: #{e}"
25end
26

עדכון תבנית אימייל Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody |
16
17begin
18
19 result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_email_template: #{e}"
23end
24

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

req tenantId urlId userIdWS

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
userIdWSstringqueryYes
startTimeintegerqueryYes
endTimeintegerqueryYes

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-get_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8user_id_ws = 'user_id_ws_example' # מחרוזת |
9start_time = 789 # מספר שלם |
10end_time = 789 # מספר שלם |
11
12begin
13
14 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_event_log: #{e}"
18end
19

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

req tenantId urlId userIdWS

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
urlIdstringqueryכן
userIdWSstringqueryכן
startTimeintegerqueryכן
endTimeintegerqueryכן

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה של get_global_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8user_id_ws = 'user_id_ws_example' # String |
9start_time = 789 # Integer |
10end_time = 789 # Integer |
11
12begin
13
14 result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_global_event_log: #{e}"
18end
19

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
broadcastIdstringqueryלא
isLivebooleanqueryלא
doSpamCheckbooleanqueryלא
skipDupCheckbooleanqueryלא

תגובה

מחזיר: CreateFeedPost200Response

דוגמה

דוגמה ל-create_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
15opts = {
16 broadcast_id: 'broadcast_id_example', # String |
17 is_live: true, # Boolean |
18 do_spam_check: true, # Boolean |
19 skip_dup_check: true # Boolean |
20}
21
22begin
23
24 result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->create_feed_post: #{e}"
28end
29

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
broadcastIdstringqueryלא
ssostringqueryלא

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-create_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->create_feed_post_public: #{e}"
19end
20

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

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringpathכן
postIdstringpathכן
broadcastIdstringqueryלא
ssostringqueryלא

תגובה

מחזיר: DeleteFeedPostPublic200Response

דוגמה

דוגמה ל-delete_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7post_id = 'post_id_example' # מחרוזת |
8opts = {
9 broadcast_id: 'broadcast_id_example', # מחרוזת |
10 sso: 'sso_example' # מחרוזת |
11}
12
13begin
14
15 result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
19end
20

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

req tenantId afterId

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
afterIdstringqueryלא
limitintegerqueryלא
tagsarrayqueryלא

תגובה

מחזיר: GetFeedPosts200Response

דוגמה

דוגמה ל-get_feed_posts
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 after_id: 'after_id_example', # String |
16 limit: 56, # Integer |
17 tags: ['inner_example'] # Array<String> |
18}
19
20begin
21
22 result = api_instance.get_feed_posts(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_feed_posts: #{e}"
26end
27

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

req tenantId afterId

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
afterIdstringqueryלא
limitintegerqueryלא
tagsarrayqueryלא
ssostringqueryלא
isCrawlerbooleanqueryלא
includeUserInfobooleanqueryלא

תגובה

מחזיר: GetFeedPostsPublic200Response

דוגמה

get_feed_posts_public דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 after_id: 'after_id_example', # String |
9 limit: 56, # Integer |
10 tags: ['inner_example'], # Array<String> |
11 sso: 'sso_example', # String |
12 is_crawler: true, # Boolean |
13 include_user_info: true # Boolean |
14}
15
16begin
17
18 result = api_instance.get_feed_posts_public(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
postIdsarrayqueryכן
ssostringqueryלא

תגובה

מחזיר: GetFeedPostsStats200Response

דוגמה

get_feed_posts_stats דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7post_ids = ['inner_example'] # מערך<מחרוזת> |
8opts = {
9 sso: 'sso_example' # מחרוזת |
10}
11
12begin
13
14 result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
18end
19

קבלת ריאקציות של משתמשים (ציבורי) Internal Link


פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
postIdsarrayqueryלא
ssostringqueryלא

תגובה

מחזיר: GetUserReactsPublic200Response

דוגמה

דוגמה ל-get_user_reacts_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 post_ids: ['inner_example'], # Array<String> |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_user_reacts_public(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
18end
19

הוספת ריאקציה לפוסט בפיד (ציבורי) Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
postIdstringpathכן
isUndobooleanqueryלא
broadcastIdstringqueryלא
ssostringqueryלא

תגובה

מחזיר: ReactFeedPostPublic200Response

דוגמה

דוגמה ל-react_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7post_id = 'post_id_example' # מחרוזת |
8react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams |
9opts = {
10 is_undo: true, # בוליאני |
11 broadcast_id: 'broadcast_id_example', # מחרוזת |
12 sso: 'sso_example' # מחרוזת |
13}
14
15begin
16
17 result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->react_feed_post_public: #{e}"
21end
22

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

update_feed_post דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost |
16
17begin
18
19 result = api_instance.update_feed_post(tenant_id, id, feed_post)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_feed_post: #{e}"
23end
24

עדכון פוסט בפיד (ציבורי) Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
postIdstringpathכן
broadcastIdstringqueryלא
ssostringqueryלא

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-update_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->update_feed_post_public: #{e}"
20end
21

דיווח על תגובה (ציבורי) Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
commentIdstringpathכן
isFlaggedbooleanqueryכן
ssostringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

flag_comment_public דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8is_flagged = true # Boolean |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->flag_comment_public: #{e}"
19end
20

הוספת האשטאג Internal Link

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryלא

תגובה

מחזיר: AddHashTag200Response

דוגמה

דוגמה ל-add_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קבע תצורת אימות למפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה של השורה הבאה כדי להגדיר תחילית עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tag(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
24end
25

הוספת האשטאגים באצווה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryלא

תגובה

מחזיר: AddHashTagsBulk200Response

דוגמה

דוגמה ל-add_hash_tags_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אישור מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 bulk_create_hash_tags_body: FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tags_bulk(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
24end
25

מחיקת האשטאג Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tagstringpathכן
tenantIdstringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 delete_hash_tag_request: FastCommentsClient::DeleteHashTagRequest.new # DeleteHashTagRequest |
17}
18
19begin
20
21 result = api_instance.delete_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
25end
26

קבלת האשטאגים Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
pagenumberqueryלא

תגובה

מחזיר: GetHashTags200Response

דוגמה

דוגמת get_hash_tags
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדרת אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14opts = {
15 page: 1.2 # מספר עשרוני |
16}
17
18begin
19
20 result = api_instance.get_hash_tags(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_hash_tags: #{e}"
24end
25

עדכון חלקי של האשטאג Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tagstringpathYes
tenantIdstringqueryNo

תגובה

Returns: PatchHashTag200Response

דוגמה

דוגמה ל-patch_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
17}
18
19begin
20
21 result = api_instance.patch_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
25end
26

יצירת מודרטור Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: CreateModerator200Response

דוגמה

דוגמה ל-create_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody |
15
16begin
17
18 result = api_instance.create_moderator(tenant_id, create_moderator_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_moderator: #{e}"
22end
23

מחיקת מודרטור Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
sendEmailstringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # קביעת הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 send_email: 'send_email_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_moderator(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_moderator: #{e}"
25end
26

קבלת מודרטור Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetModerator200Response

דוגמה

דוגמה ל-get_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_moderator(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_moderator: #{e}"
22end
23

קבלת מודרטורים Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
skipnumberqueryלא

תגובה

מחזיר: GetModerators200Response

דוגמה

דוגמת get_moderators
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדרת אימות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_moderators(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_moderators: #{e}"
24end
25

שליחת הזמנה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
fromNamestringqueryכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-send_invite
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15from_name = 'from_name_example' # String |
16
17begin
18
19 result = api_instance.send_invite(tenant_id, id, from_name)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->send_invite: #{e}"
23end
24

עדכון מודרטור Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody |
16
17begin
18
19 result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_moderator: #{e}"
23end
24

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר אישור באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_notification_count: #{e}"
22end
23

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

פרמטרים

שםסוגמיקוםדרושתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetCachedNotificationCount200Response

דוגמה

דוגמה ל-get_cached_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_cached_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
userIdstringqueryלא
urlIdstringqueryלא
fromCommentIdstringqueryלא
viewedbooleanqueryלא
typestringqueryלא

תגובה

מחזיר: GetNotificationCount200Response

דוגמה

get_notification_count דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example' # String |
20}
21
22begin
23
24 result = api_instance.get_notification_count(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_notification_count: #{e}"
28end
29

קבלת התראות Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
userIdstringqueryלא
urlIdstringqueryלא
fromCommentIdstringqueryלא
viewedbooleanqueryלא
typestringqueryלא
skipnumberqueryלא

תגובה

מחזיר: GetNotifications200Response

דוגמה

דוגמה ל-get_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_notifications(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_notifications: #{e}"
29end
30

עדכון התראה Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_notification
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אישור
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל היא nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_notification: #{e}"
26end
27

הוספת דף Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: AddPageAPIResponse

דוגמה

דוגמה ל-add_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה על השורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData |
15
16begin
17
18 result = api_instance.add_page(tenant_id, create_api_page_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_page: #{e}"
22end
23

מחיקת דף Internal Link


פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: DeletePageAPIResponse

דוגמה

דוגמה ל-delete_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15
16begin
17
18 result = api_instance.delete_page(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_page: #{e}"
22end
23

קבלת דף לפי URL ID Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
urlIdstringqueryכן

תגובה

מחזיר: GetPageByURLIdAPIResponse

דוגמה

דוגמה ל-get_page_by_urlid
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14url_id = 'url_id_example' # מחרוזת |
15
16begin
17
18 result = api_instance.get_page_by_urlid(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
22end
23

קבלת דפים Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: GetPagesAPIResponse

דוגמה

דוגמת get_pages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14
15begin
16
17 result = api_instance.get_pages(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_pages: #{e}"
21end
22

עדכון חלקי של דף Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: PatchPageAPIResponse

דוגמה

דוגמה ל-patch_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדרת אישור באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData |
16
17begin
18
19 result = api_instance.patch_page(tenant_id, id, update_api_page_data)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_page: #{e}"
23end
24

מחיקת אירוע webhook בהמתנה Internal Link


פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_pending_webhook_event
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_pending_webhook_event(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
22end
23

קבלת ספירת אירועי webhook בהמתנה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
commentIdstringqueryלא
externalIdstringqueryלא
eventTypestringqueryלא
typestringqueryלא
domainstringqueryלא
attemptCountGTnumberqueryלא

תגובה

מחזיר: GetPendingWebhookEventCount200Response

דוגמה

דוגמה ל-get_pending_webhook_event_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
29end
30

קבלת אירועי webhook בהמתנה Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
commentIdstringqueryלא
externalIdstringqueryלא
eventTypestringqueryלא
typestringqueryלא
domainstringqueryלא
attemptCountGTnumberqueryלא
skipnumberqueryלא

תגובה

מחזיר: GetPendingWebhookEvents200Response

דוגמה

דוגמה ל-get_pending_webhook_events
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # קבע אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14opts = {
15 comment_id: 'comment_id_example', # מחרוזת |
16 external_id: 'external_id_example', # מחרוזת |
17 event_type: 'event_type_example', # מחרוזת |
18 type: 'type_example', # מחרוזת |
19 domain: 'domain_example', # מחרוזת |
20 attempt_count_gt: 1.2, # מספר עשרוני |
21 skip: 1.2 # מספר עשרוני |
22}
23
24begin
25
26 result = api_instance.get_pending_webhook_events(tenant_id, opts)
27 p result
28rescue FastCommentsClient::ApiError => e
29 puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
30end
31

יצירת הגדרת שאלה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: CreateQuestionConfig200Response

דוגמה

דוגמה ל-create_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody |
15
16begin
17
18 result = api_instance.create_question_config(tenant_id, create_question_config_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_config: #{e}"
22end
23

מחיקת הגדרת שאלה Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15
16begin
17
18 result = api_instance.delete_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_config: #{e}"
22end
23

קבלת הגדרת שאלה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetQuestionConfig200Response

דוגמה

דוגמה ל-get_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל היא nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_config: #{e}"
22end
23

קבלת הגדרות שאלות Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
skipnumberqueryלא

תגובה

מחזיר: GetQuestionConfigs200Response

דוגמה

דוגמה ל-get_question_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר אישור
5FastCommentsClient.configure do |config|
6 # קבע אימות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר תחילית למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14opts = {
15 skip: 1.2 # מספר עשרוני |
16}
17
18begin
19
20 result = api_instance.get_question_configs(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_question_configs: #{e}"
24end
25

עדכון הגדרת שאלה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody |
16
17begin
18
19 result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_config: #{e}"
23end
24

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: CreateQuestionResult200Response

דוגמה

דוגמה ל-create_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את הערת השורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody |
15
16begin
17
18 result = api_instance.create_question_result(tenant_id, create_question_result_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_result: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetQuestionResult200Response

דוגמה

דוגמה ל-get_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15
16begin
17
18 result = api_instance.get_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_result: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
urlIdstringqueryלא
userIdstringqueryלא
startDatestringqueryלא
questionIdstringqueryלא
questionIdsstringqueryלא
skipnumberqueryלא

תגובה

מחזיר: GetQuestionResults200Response

דוגמה

דוגמה ל-get_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל היא nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 url_id: 'url_id_example', # String |
16 user_id: 'user_id_example', # String |
17 start_date: 'start_date_example', # String |
18 question_id: 'question_id_example', # String |
19 question_ids: 'question_ids_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_question_results: #{e}"
29end
30

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת update_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה של השורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody |
16
17begin
18
19 result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_result: #{e}"
23end
24

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

תגובה

מחזיר: AggregateQuestionResults200Response

דוגמה

דוגמת aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדרת אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket |
19 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
20 force_recalculate: true # Boolean |
21}
22
23begin
24
25 result = api_instance.aggregate_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
29end
30

אגרגציה גורפת של תוצאות שאלות Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringשאילתהכן
forceRecalculatebooleanשאילתהלא

תגובה

מחזיר: BulkAggregateQuestionResults200Response

דוגמה

דוגמה ל-bulk_aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest |
15opts = {
16 force_recalculate: true # Boolean |
17}
18
19begin
20
21 result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
25end
26

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
questionIdstringqueryלא
questionIdsarrayqueryלא
urlIdstringqueryלא
startDatestringqueryלא
forceRecalculatebooleanqueryלא
minValuenumberqueryלא
maxValuenumberqueryלא
limitnumberqueryלא

תגובה

מחזיר: CombineCommentsWithQuestionResults200Response

דוגמה

דוגמה ל-combine_comments_with_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
19 force_recalculate: true, # Boolean |
20 min_value: 1.2, # Float |
21 max_value: 1.2, # Float |
22 limit: 1.2 # Float |
23}
24
25begin
26
27 result = api_instance.combine_comments_with_question_results(tenant_id, opts)
28 p result
29rescue FastCommentsClient::ApiError => e
30 puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
31end
32

הוספת משתמש SSO Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן

תגובה

מחזיר: AddSSOUserAPIResponse

דוגמה

דוגמה ל-add_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר הרשאות
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData |
15
16begin
17
18 result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_sso_user: #{e}"
22end
23

מחיקת משתמש SSO Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
deleteCommentsbooleanqueryלא
commentDeleteModestringqueryלא

תגובה

מחזיר: DeleteSSOUserAPIResponse

דוגמה

דוגמה ל-delete_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה בשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: true, # Boolean |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_sso_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_sso_user: #{e}"
26end
27

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
emailstringpathכן

תגובה

מחזיר: GetSSOUserByEmailAPIResponse

דוגמה

דוגמה ל-get_sso_user_by_email
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14email = 'email_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_email(tenant_id, email)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
22end
23

קבלת משתמש SSO לפי ID Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetSSOUserByIdAPIResponse

דוגמה

דוגמה ל-get_sso_user_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר אישור באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
22end
23

קבלת משתמשי SSO Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
skipintegerqueryלא

תגובה

מחזיר: GetSSOUsers200Response

דוגמה

דוגמה ל-get_sso_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר אימות
5FastCommentsClient.configure do |config|
6 # הגדר את אימות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14opts = {
15 skip: 56 # מספר שלם |
16}
17
18begin
19
20 result = api_instance.get_sso_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_sso_users: #{e}"
24end
25

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

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
idstringpathכן
updateCommentsbooleanqueryלא

תגובה

מחזיר: PatchSSOUserAPIResponse

דוגמה

דוגמה ל-patch_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->patch_sso_user: #{e}"
26end
27

החלפת משתמש SSO Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן
updateCommentsbooleanqueryלא

תגובה

מחזיר: PutSSOUserAPIResponse

דוגמה

דוגמה ל-put_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # קביעת אישור למפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להוסיף קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->put_sso_user: #{e}"
26end
27

יצירת מנוי Internal Link

פרמטרים

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

תגובה

מחזיר: CreateSubscriptionAPIResponse

דוגמה

דוגמה ל-create_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדרת אימות עבור מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData |
15
16begin
17
18 result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_subscription: #{e}"
22end
23

מחיקת מנוי Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא

תגובה

מחזיר: DeleteSubscriptionAPIResponse

דוגמה

דוגמה ל-delete_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_subscription(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_subscription: #{e}"
25end
26

קבלת מנויים Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
userIdstringqueryלא

תשובה

מחזיר: GetSubscriptionsAPIResponse

דוגמה

דוגמה ל-get_subscriptions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example' # String |
16}
17
18begin
19
20 result = api_instance.get_subscriptions(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_subscriptions: #{e}"
24end
25

עדכון מנוי Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא

תגובה

מחזיר: UpdateSubscriptionAPIResponse

דוגמה

דוגמה ל-update_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה של השורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData |
16opts = {
17 user_id: 'user_id_example' # מחרוזת |
18}
19
20begin
21
22 result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_subscription: #{e}"
26end
27

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
yearNumbernumberqueryלא
monthNumbernumberqueryלא
dayNumbernumberqueryלא
skipnumberqueryלא

תגובה

מחזיר: GetTenantDailyUsages200Response

דוגמה

דוגמה עבור get_tenant_daily_usages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 year_number: 1.2, # Float |
16 month_number: 1.2, # Float |
17 day_number: 1.2, # Float |
18 skip: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tenant_daily_usages(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
27end
28

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן

תשובה

מחזיר: CreateTenantPackage200Response

דוגמה

דוגמה ל-create_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody |
15
16begin
17
18 result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_package: #{e}"
22end
23

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

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קבע הרשאת مפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetTenantPackage200Response

דוגמה

דוגמה ל-get_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_package: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
skipnumberqueryלא

תגובה

מחזיר: GetTenantPackages200Response

דוגמה

דוגמה ל-get_tenant_packages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסירו את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_packages(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
24end
25

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-replace_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody |
16
17begin
18
19 result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
23end
24

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # קביעת אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody |
16
17begin
18
19 result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant_package: #{e}"
23end
24

יצירת משתמש של שוכר Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן

תגובה

מחזיר: CreateTenantUser200Response

דוגמה

create_tenant_user דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody |
15
16begin
17
18 result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_user: #{e}"
22end
23

מחיקת משתמש של שוכר Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
deleteCommentsstringqueryלא
commentDeleteModestringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל־delete_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15opts = {
16 delete_comments: 'delete_comments_example', # מחרוזת |
17 comment_delete_mode: 'comment_delete_mode_example' # מחרוזת |
18}
19
20begin
21
22 result = api_instance.delete_tenant_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
26end
27

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetTenantUser200Response

דוגמה

דוגמה ל-get_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר הרשאה
5FastCommentsClient.configure do |config|
6 # קבע הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר הערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל היא nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_user: #{e}"
22end
23

קבלת משתמשי שוכר Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
skipnumberqueryלא

תשובה

מחזיר: GetTenantUsers200Response

דוגמה

דוגמה ל-get_tenant_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_users: #{e}"
24end
25

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן
updateCommentsstringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

replace_tenant_user דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
26end
27

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
redirectURLstringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-send_login_link
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 redirect_url: 'redirect_url_example' # String |
17}
18
19begin
20
21 result = api_instance.send_login_link(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->send_login_link: #{e}"
25end
26

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
updateCommentsstringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדרת הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_tenant_user: #{e}"
26end
27

יצירת שוכר Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן

תגובה

מחזיר: CreateTenant200Response

דוגמה

דוגמה ל-create_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדרת אישור באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את הסימן '#' מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody |
15
16begin
17
18 result = api_instance.create_tenant(tenant_id, create_tenant_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant: #{e}"
22end
23

מחיקת שוכר Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
surestringqueryלא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה בשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 sure: 'sure_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_tenant(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_tenant: #{e}"
25end
26

קבלת שוכר Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetTenant200Response

דוגמה

דוגמה ל-get_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant: #{e}"
22end
23

קבלת שוכרים Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
metastringqueryלא
skipnumberqueryלא

תגובה

מחזיר: GetTenants200Response

דוגמה

דוגמה ל-get_tenants
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 # בטל את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
8 # config.api_key_prefix['x-api-key'] = 'Bearer'
9end
10
11api_instance = FastCommentsClient::DefaultApi.new
12tenant_id = 'tenant_id_example' # String |
13opts = {
14 meta: 'meta_example', # String |
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenants(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenants: #{e}"
24end
25

עדכון שוכר Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-update_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אישור
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody |
16
17begin
18
19 result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant: #{e}"
23end
24

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
userIdstringqueryכן
idstringpathכן

תגובה

מחזיר: ChangeTicketState200Response

דוגמה

דוגמה ל-change_ticket_state
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערת השורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15id = 'id_example' # String |
16change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody |
17
18begin
19
20 result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->change_ticket_state: #{e}"
24end
25

יצירת כרטיס Internal Link


פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
userIdstringqueryכן

תגובה

מחזיר: CreateTicket200Response

דוגמה

דוגמה ל-create_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody |
16
17begin
18
19 result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->create_ticket: #{e}"
23end
24

קבלת כרטיס Internal Link

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
idstringpathכן
userIdstringqueryלא

תגובה

מחזיר: GetTicket200Response

דוגמה

דוגמה ל-get_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.get_ticket(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_ticket: #{e}"
25end
26

קבלת כרטיסים Internal Link

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
userIdstringqueryלא
statenumberqueryלא
skipnumberqueryלא
limitnumberqueryלא

תגובה

מחזיר: GetTickets200Response

דוגמה

דוגמת get_tickets
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 state: 1.2, # Float |
17 skip: 1.2, # Float |
18 limit: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tickets(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tickets: #{e}"
27end
28

העלאת תמונה Internal Link

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringpathכן
sizePresetstringqueryלאערכת גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים)
urlIdstringqueryלאמזהה העמוד שממנו מתבצעת ההעלאה, לצורך קונפיגורציה

תגובה

מחזיר: UploadImageResponse

דוגמה

דוגמה ל-upload_image
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7file = File.new('/path/to/some/file') # File |
8opts = {
9 size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | ערכת גודל: \"Default\" (1000x1000px) או \"CrossPlatform\" (יוצר גדלים למכשירים פופולריים)
10 url_id: 'url_id_example' # String | מזהה העמוד שממנו מתבצעת ההעלאה, לצורך קונפיגורציה
11}
12
13begin
14
15 result = api_instance.upload_image(tenant_id, file, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->upload_image: #{e}"
19end
20

קבלת התקדמות תג משתמש לפי ID Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetUserBadgeProgressById200Response

דוגמה

דוגמה ל-get_user_badge_progress_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
userIdstringpathכן

תגובה

מחזיר: GetUserBadgeProgressById200Response

דוגמה

דוגמה ל-get_user_badge_progress_by_user_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # קביעת הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר הערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "שגיאה בעת קריאה ל-DefaultApi->get_user_badge_progress_by_user_id: #{e}"
22end
23

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

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
userIdstringqueryלא
limitnumberqueryלא
skipnumberqueryלא

תגובה

מחזיר: GetUserBadgeProgressList200Response

דוגמה

get_user_badge_progress_list דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 limit: 1.2, # Float |
17 skip: 1.2 # Float |
18}
19
20begin
21
22 result = api_instance.get_user_badge_progress_list(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
26end
27

יצירת תג משתמש Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן

תגובה

מחזיר: CreateUserBadge200Response

דוגמה

דוגמת create_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams |
15
16begin
17
18 result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_user_badge: #{e}"
22end
23

מחיקת תג משתמש Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: UpdateUserBadge200Response

דוגמה

דוגמה ל-delete_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_user_badge: #{e}"
22end
23

קבלת תג משתמש Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetUserBadge200Response

דוגמה

דוגמה ל-get_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר אישור מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
userIdstringqueryלא
badgeIdstringqueryלא
typenumberqueryלא
displayedOnCommentsbooleanqueryלא
limitnumberqueryלא
skipnumberqueryלא

תגובה

מחזיר: GetUserBadges200Response

דוגמה

דוגמה ל-get_user_badges
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 badge_id: 'badge_id_example', # String |
17 type: 1.2, # Float |
18 displayed_on_comments: true, # Boolean |
19 limit: 1.2, # Float |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_user_badges(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_user_badges: #{e}"
29end
30

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: UpdateUserBadge200Response

דוגמה

דוגמה ל-update_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams |
16
17begin
18
19 result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_user_badge: #{e}"
23end
24

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
ssostringqueryלא

תגובה

מחזיר: GetUserNotificationCount200Response

דוגמה

דוגמה ל-get_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7opts = {
8 sso: 'sso_example' # מחרוזת |
9}
10
11begin
12
13 result = api_instance.get_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->get_user_notification_count: #{e}"
17end
18

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
pageSizeintegerqueryלא
afterIdstringqueryלא
includeContextbooleanqueryלא
afterCreatedAtintegerqueryלא
unreadOnlybooleanqueryלא
dmOnlybooleanqueryלא
noDmbooleanqueryלא
includeTranslationsbooleanqueryלא
ssostringqueryלא

תגובה

מחזיר: GetUserNotifications200Response

דוגמה

get_user_notifications דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 page_size: 56, # Integer |
9 after_id: 'after_id_example', # String |
10 include_context: true, # Boolean |
11 after_created_at: 789, # Integer |
12 unread_only: true, # Boolean |
13 dm_only: true, # Boolean |
14 no_dm: true, # Boolean |
15 include_translations: true, # Boolean |
16 sso: 'sso_example' # String |
17}
18
19begin
20
21 result = api_instance.get_user_notifications(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling PublicApi->get_user_notifications: #{e}"
25end
26

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
ssostringqueryלא

תגובה

מחזיר: ResetUserNotifications200Response

דוגמה

דוגמה ל-reset_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7opts = {
8 sso: 'sso_example' # מחרוזת |
9}
10
11begin
12
13 result = api_instance.reset_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
17end
18

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
afterIdstringqueryלא
afterCreatedAtintegerqueryלא
unreadOnlybooleanqueryלא
dmOnlybooleanqueryלא
noDmbooleanqueryלא
ssostringqueryלא

תגובה

מחזיר: ResetUserNotifications200Response

דוגמה

דוגמה ל-reset_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 after_id: 'after_id_example', # String |
9 after_created_at: 789, # Integer |
10 unread_only: true, # Boolean |
11 dm_only: true, # Boolean |
12 no_dm: true, # Boolean |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.reset_user_notifications(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->reset_user_notifications: #{e}"
22end
23

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

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
notificationIdstringpathכן
optedInOrOutstringpathכן
commentIdstringqueryכן
ssostringqueryלא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה ל-update_user_notification_comment_subscription_status
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7notification_id = 'notification_id_example' # String |
8opted_in_or_out = 'in' # String |
9comment_id = 'comment_id_example' # String |
10opts = {
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
20end
21

עדכון סטטוס מנוי התראות על דפים למשתמש Internal Link

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
urlIdstringqueryכן
urlstringqueryכן
pageTitlestringqueryכן
subscribedOrUnsubscribedstringpathכן
ssostringqueryלא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

update_user_notification_page_subscription_status דוגמה
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8url = 'url_example' # String |
9page_title = 'page_title_example' # String |
10subscribed_or_unsubscribed = 'subscribe' # String |
11opts = {
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
21end
22

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

פרמטרים

שםסוגמיקוםחובהתיאור
tenantIdstringqueryכן
notificationIdstringpathכן
newStatusstringpathכן
ssostringqueryלא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה ל-update_user_notification_status
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7notification_id = 'notification_id_example' # String |
8new_status = 'read' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->update_user_notification_status: #{e}"
19end
20

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

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
urlIdWSstringqueryכן
userIdsstringqueryכן

תגובה

מחזיר: GetUserPresenceStatuses200Response

דוגמה

דוגמה ל-get_user_presence_statuses
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id_ws = 'url_id_ws_example' # מחרוזת |
8user_ids = 'user_ids_example' # מחרוזת |
9
10begin
11
12 result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
16end
17

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

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringpathכן
urlIdstringqueryכן
usernameStartsWithstringqueryלא
mentionGroupIdsarrayqueryלא
ssostringqueryלא
searchSectionstringqueryלא

תגובה

מחזיר: SearchUsers200Response

דוגמה

דוגמת search_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 username_starts_with: 'username_starts_with_example', # String |
10 mention_group_ids: ['inner_example'], # Array<String> |
11 sso: 'sso_example', # String |
12 search_section: 'fast' # String |
13}
14
15begin
16
17 result = api_instance.search_users(tenant_id, url_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->search_users: #{e}"
21end
22

קבלת משתמש Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
idstringpathכן

תגובה

מחזיר: GetUser200Response

דוגמה

דוגמה ל-get_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # מחרוזת |
14id = 'id_example' # מחרוזת |
15
16begin
17
18 result = api_instance.get_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user: #{e}"
22end
23

יצירת הצבעה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
commentIdstringqueryכן
directionstringqueryכן
userIdstringqueryלא
anonUserIdstringqueryלא

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמה ל-create_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדר אימות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14comment_id = 'comment_id_example' # String |
15direction = 'up' # String |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->create_vote: #{e}"
27end
28

מחיקת הצבעה Internal Link

פרמטרים

NameTypeLocationRequiredDescription
tenantIdstringqueryכן
idstringpathכן
editKeystringqueryלא

תגובה

מחזיר: DeleteCommentVote200Response

דוגמה

דוגמת delete_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # הגדרת אישור באמצעות מפתח API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי לקבוע תחילית עבור מפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל = nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 edit_key: 'edit_key_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_vote(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_vote: #{e}"
25end
26

קבלת הצבעות Internal Link

פרמטרים

שםסוגמיקוםנדרשתיאור
tenantIdstringqueryכן
urlIdstringqueryכן

תגובה

מחזיר: GetVotes200Response

דוגמה

דוגמה ל-get_votes
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאות
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_votes(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_votes: #{e}"
22end
23

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

פרמטרים

שםסוגמיקוםדרושתיאור
tenantIdstringqueryכן
urlIdstringqueryכן
userIdstringqueryלא
anonUserIdstringqueryלא

תגובה

מחזיר: GetVotesForUser200Response

דוגמה

דוגמה ל-get_votes_for_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת הרשאה
5FastCommentsClient.configure do |config|
6 # הגדר הרשאת מפתח ה-API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # בטל את ההערה של השורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
26end
27

צריך עזרה?

אם תיתקל בבעיות או יש לך שאלות לגבי ה-SDK של Ruby, אנא:

תרומה

תרומות מתקבלות בברכה! אנא בקרו ב-מאגר GitHub לקבלת הנחיות לתרומה.