FastComments SDK ל‑Ruby
זהו ה-SDK הרשמי של Ruby עבור FastComments.
ה-SDK הרשמי של Ruby עבור ה-API של FastComments
מאגר
סוכני קידוד AI 
תן לסוכן הקידוד שלך את ההקשר של FastComments שהוא צריך – וידג׳טים, תצורה, Secure SSO, ה‑REST API וה‑SDKs:
npx skills add fastcomments/skillsעובד עם Claude Code, Codex, Cursor, Copilot, Gemini, וכל סוכן אחר שה‑skills CLI תומך בו.
Installation
הוסף שורה זו לקובץ Gemfile של היישום שלך:
gem 'fastcomments'ואז הפעל:
bundle installאו התקן זאת בעצמך כ:
gem install fastcommentsLibrary Contents
ספרייה זו מכילה את לקוח ה‑API שנוצר ואת כלי ה‑SSO שמקלים על העבודה עם ה‑API.
Public vs Secured APIs
ללקוח ה‑API יש שלוש מחלקות: DefaultApi, PublicApi ו‑ModerationApi. ה‑DefaultApi מכילה שיטות הדורשות מפתח API שלך, וה‑PublicApi מכילה קריאות API שניתן לבצע ישירות מדפדפן/מכשיר נייד/וכו׳ ללא אימות. ה‑ModerationApi מכילה את השיטות שמפעילות את לוח המחוונים של המודרטור.
ה‑ModerationApi מספקת חבילה נרחבת של API מודרציה בזמן אמת ומהירה. כל שיטה ב‑ModerationApi מקבלת פרמטר sso ויכולה לאמת באמצעות SSO או קוביית סשן של FastComments.com.
Quick Start
שימוש ב‑APIs מאומתים (DefaultApi)
חשוב: עליך להגדיר את מפתח ה‑API שלך ב‑ApiClient לפני ביצוע בקשות מאומתות. אם לא תעשה זאת, הבקשות יכשלו עם שגיאת 401.
require 'fastcomments'
# צור וקונפיגור את לקוח ה‑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'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
'YOUR_TENANT_ID',
'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
endשימוש ב‑APIs מודרציה (ModerationApi)
שיטות המודרציה מקנות כוח ללוח הבקרה של המודרטור. העבר אסימון sso כך שהבקשה תתבצע בשם מודרטור מאומת ב‑SSO:
require 'fastcomments'
moderation_api = FastCommentsClient::ModerationApi.new
begin
# דוגמה: רשימת תגובות בתור המודרציה
response = moderation_api.get_api_comments(
sso: 'YOUR_MODERATOR_SSO_TOKEN'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
endבעיות נפוצות
- שגיאת 401 "missing-api-key": ודא שהגדרת
config.api_key['x-api-key'] = 'YOUR_KEY'לפני יצירת מופע DefaultApi. - מחלקת API שגויה: השתמש ב‑
DefaultApiעבור בקשות מאומתות בצד השרת, ב‑PublicApiעבור בקשות בצד הלקוח/ציבוריות, וב‑ModerationApiעבור בקשות ללוח הבקרה של המודרטור. - מפתח API ריק: ה‑SDK ידלג בשקט על אימות אם מפתח ה‑API ריק, מה שיוביל לשגיאות 401.
Notes
מזהי שידור
תראה שעליך להעביר broadcastId בחלק מקריאות ה-API. כשאתה מקבל אירועים, תקבל את המזהה הזה בחזרה, כך תדע להתעלם מהאירוע אם אתה מתכנן להחיל שינויים באופן אופטימי בצד הלקוח
(סביר שתרצה לעשות זאת מכיוון שזה מספק את חוויית המשתמש הטובה ביותר). העבר כאן UUID. המזהה צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים במהלך מושב בדפדפן.
SSO (כניסה אחידה)
לדוגמאות ל-SSO, ראה למטה.
SSO Usage
Simple SSO
require 'fastcomments'
# צור אסימון 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(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"Secure SSO
require 'fastcomments'
# צור אסימון 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(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"aggregate
מאגד מסמכים על ידי קיבוצם (אם groupBy מסופק) ויישום מספר פעולות. נתמכות פעולות שונות (למשל sum, countDistinct, avg וכו').
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| parentTenantId | string | query | לא | |
| includeStats | boolean | query | לא |
תגובה
מחזיר: AggregateResponse
דוגמה
דוגמה ל-aggregate
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 |
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
get_audit_logs
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| limit | number | query | לא | |
| skip | number | query | לא | |
| order | string | query | לא | |
| after | number | query | לא | |
| before | number | query | לא |
תגובה
מחזיר: GetAuditLogsResponse
דוגמה
דוגמה ל-get_audit_logs
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
logout_public
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-logout_public
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6
7begin
8
9 result = api_instance.logout_public
10 p result
11rescue FastCommentsClient::ApiError => e
12 puts "Error when calling PublicApi->logout_public: #{e}"
13end
14
block_from_comment_public
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: BlockSuccess
דוגמה
דוגמה ל-block_from_comment_public
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # מחרוזת |
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
un_block_comment_public
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UnblockSuccess
דוגמה
דוגמה ל-un_block_comment_public
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
checked_comments_for_blocked
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentIds | string | query | כן | רשימת מזהי תגובות מופרדת בפסיקים. |
| sso | string | query | לא |
תגובה
מחזיר: CheckBlockedCommentsResponse
דוגמה
דוגמה ל-checked_comments_for_blocked
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
block_user_from_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: BlockSuccess
דוגמה
דוגמה ל-block_user_from_comment
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
create_comment_public
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| sessionId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: SaveCommentsResponseWithPresence
דוגמה
דוגמה ל-create_comment_public
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 |
8broadcast_id = 'broadcast_id_example' # String |
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', # String |
12 sso: 'sso_example' # String |
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
delete_comment
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
תגובה
מחזיר: DeleteCommentResult
דוגמה
דוגמת delete_comment
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
delete_comment_public
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: PublicAPIDeleteCommentResponse
דוגמה
דוגמה ל-delete_comment_public
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
delete_comment_vote
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| voteId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: VoteDeleteResponse
דוגמה
דוגמה ל-delete_comment_vote
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 |
8vote_id = 'vote_id_example' # String |
9url_id = 'url_id_example' # String |
10broadcast_id = 'broadcast_id_example' # String |
11opts = {
12 edit_key: 'edit_key_example', # String |
13 sso: 'sso_example' # String |
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
flag_comment
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: FlagCommentResponse
דוגמה
דוגמה ל-flag_comment
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
get_comment
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIGetCommentResponse
דוגמה
דוגמה ל-get_comment
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
get_comment_text
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: PublicAPIGetCommentTextResponse
דוגמה
דוגמה ל-get_comment_text
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
get_comment_vote_user_names
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| dir | integer | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetCommentVoteUserNamesSuccessResponse
דוגמה
דוגמה ל-get_comment_vote_user_names
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
get_comments
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| page | integer | query | לא | |
| limit | integer | query | לא | |
| skip | integer | query | לא | |
| asTree | boolean | query | לא | |
| skipChildren | integer | query | לא | |
| limitChildren | integer | query | לא | |
| maxTreeDepth | integer | query | לא | |
| urlId | string | query | לא | |
| userId | string | query | לא | |
| anonUserId | string | query | לא | |
| contextUserId | string | query | לא | |
| hashTag | string | query | לא | |
| parentId | string | query | לא | |
| direction | string | query | לא | |
| fromDate | integer | query | לא | |
| toDate | integer | query | לא |
תגובה
מחזיר: APIGetCommentsResponse
דוגמה
דוגמה ל-get_comments
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 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 from_date: 789, # Integer |
30 to_date: 789 # Integer |
31}
32
33begin
34
35 result = api_instance.get_comments(tenant_id, opts)
36 p result
37rescue FastCommentsClient::ApiError => e
38 puts "Error when calling DefaultApi->get_comments: #{e}"
39end
40
get_comments_public
req tenantId urlId
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| page | integer | query | לא | |
| direction | string | query | לא | |
| sso | string | query | לא | |
| skip | integer | query | לא | |
| skipChildren | integer | query | לא | |
| limit | integer | query | לא | |
| limitChildren | integer | query | לא | |
| countChildren | boolean | query | לא | |
| fetchPageForCommentId | string | query | לא | |
| includeConfig | boolean | query | לא | |
| countAll | boolean | query | לא | |
| includei10n | boolean | query | לא | |
| locale | string | query | לא | |
| modules | string | query | לא | |
| isCrawler | boolean | query | לא | |
| includeNotificationCount | boolean | query | לא | |
| asTree | boolean | query | לא | |
| maxTreeDepth | integer | query | לא | |
| useFullTranslationIds | boolean | query | לא | |
| parentId | string | query | לא | |
| searchText | string | query | לא | |
| hashTags | array | query | לא | |
| userId | string | query | לא | |
| customConfigStr | string | query | לא | |
| afterCommentId | string | query | לא | |
| beforeCommentId | string | query | לא |
תשובה
מחזיר: GetCommentsResponseWithPresencePublicComment
דוגמה
דוגמה ל-get_comments_public
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8opts = {
9 page: 56, # מספר שלם |
10 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
11 sso: 'sso_example', # מחרוזת |
12 skip: 56, # מספר שלם |
13 skip_children: 56, # מספר שלם |
14 limit: 56, # מספר שלם |
15 limit_children: 56, # מספר שלם |
16 count_children: true, # בוליאני |
17 fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # מחרוזת |
18 include_config: true, # בוליאני |
19 count_all: true, # בוליאני |
20 includei10n: true, # בוליאני |
21 locale: 'locale_example', # מחרוזת |
22 modules: 'modules_example', # מחרוזת |
23 is_crawler: true, # בוליאני |
24 include_notification_count: true, # בוליאני |
25 as_tree: true, # בוליאני |
26 max_tree_depth: 56, # מספר שלם |
27 use_full_translation_ids: true, # בוליאני |
28 parent_id: 'parent_id_example', # מחרוזת |
29 search_text: 'search_text_example', # מחרוזת |
30 hash_tags: ['inner_example'], # מערך<String> |
31 user_id: 'user_id_example', # מחרוזת |
32 custom_config_str: 'custom_config_str_example', # מחרוזת |
33 after_comment_id: 'after_comment_id_example', # מחרוזת |
34 before_comment_id: 'before_comment_id_example' # מחרוזת |
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
lock_comment
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-lock_comment
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.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
pin_comment
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: ChangeCommentPinStatusResponse
דוגמה
דוגמה ל-pin_comment
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.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
save_comment
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| sendEmails | boolean | query | לא | |
| populateNotifications | boolean | query | לא |
תגובה
מחזיר: APISaveCommentResponse
דוגמה
דוגמה ל-save_comment
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_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
save_comments_bulk
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| sendEmails | boolean | query | לא | |
| populateNotifications | boolean | query | לא |
Response
מחזיר: SaveCommentsBulkResponse
דוגמה
דוגמה ל-save_comments_bulk
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 |
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'})] # Array<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_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
set_comment_text
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: PublicAPISetCommentTextResponse
דוגמה
דוגמה ל-set_comment_text
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
un_block_user_from_comment
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: UnblockSuccess
דוגמה
דוגמה של un_block_user_from_comment
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' # מחרוזת |
15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # מחרוזת |
18 anon_user_id: 'anon_user_id_example' # מחרוזת |
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
un_flag_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
תגובה
מחזיר: FlagCommentResponse
דוגמה
דוגמה ל-un_flag_comment
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
un_lock_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-un_lock_comment
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.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
un_pin_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: ChangeCommentPinStatusResponse
דוגמה
דוגמה ל-un_pin_comment
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
update_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| contextUserId | string | query | לא | |
| doSpamCheck | boolean | query | לא | |
| isLive | boolean | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_comment
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
vote_comment
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| sessionId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: VoteResponse
דוגמה
vote_comment דוגמה
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
get_comments_for_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| userId | string | query | לא | |
| direction | string | query | לא | |
| repliesToUserId | string | query | לא | |
| page | number | query | לא | |
| includei10n | boolean | query | לא | |
| locale | string | query | לא | |
| isCrawler | boolean | query | לא |
תגובה
מחזיר: GetCommentsForUserResponse
דוגמה
דוגמה ל-get_comments_for_user
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6opts = {
7 user_id: 'user_id_example', # String |
8 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
9 replies_to_user_id: 'replies_to_user_id_example', # String |
10 page: 1.2, # Float |
11 includei10n: true, # Boolean |
12 locale: 'locale_example', # String |
13 is_crawler: true # Boolean |
14}
15
16begin
17
18 result = api_instance.get_comments_for_user(opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->get_comments_for_user: #{e}"
22end
23
add_domain_config
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddDomainConfigResponse
דוגמה
דוגמה ל-add_domain_config
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' # מחרוזת |
14add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |
15
16begin
17
18 result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_domain_config: #{e}"
22end
23
delete_domain_config
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domain | string | path | כן |
תגובה
מחזיר: DeleteDomainConfigResponse
דוגמה
דוגמה ל-delete_domain_config
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 |
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
get_domain_config
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domain | string | path | כן |
תגובה
מחזיר: GetDomainConfigResponse
דוגמה
דוגמת get_domain_config
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 = 'domain_example' # String |
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
get_domain_configs
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetDomainConfigsResponse
דוגמה
דוגמה ל-get_domain_configs
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
patch_domain_config
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
תגובה
מחזיר: PatchDomainConfigResponse
דוגמה
דוגמה ל-patch_domain_config
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
put_domain_config
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domainToUpdate | string | path | כן |
תגובה
מחזיר: PutDomainConfigResponse
דוגמה
דוגמה ל-put_domain_config
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
create_email_template
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateEmailTemplateResponse
דוגמה
דוגמה ל-create_email_template
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_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
delete_email_template
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_email_template
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_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_email_template: #{e}"
22end
23
delete_email_template_render_error
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| errorId | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_email_template_render_error
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 |
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
get_email_template
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetEmailTemplateResponse
דוגמה
דוגמה ל-get_email_template
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
get_email_template_definitions
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetEmailTemplateDefinitionsResponse
דוגמה
דוגמה ל-get_email_template_definitions
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_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
get_email_template_render_errors
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetEmailTemplateRenderErrorsResponse
דוגמה
דוגמה ל-get_email_template_render_errors
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 skip: 1.2 # Float |
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
get_email_templates
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetEmailTemplatesResponse
דוגמה
דוגמת get_email_templates
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_email_templates(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_email_templates: #{e}"
24end
25
render_email_template
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| locale | string | query | לא |
תגובה
מחזיר: RenderEmailTemplateResponse
דוגמה
דוגמת render_email_template
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
update_email_template
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_email_template
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
get_event_log
req tenantId urlId userIdWS
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| userIdWS | string | query | כן | |
| startTime | integer | query | כן | |
| endTime | integer | query | לא |
תגובה
מחזיר: GetEventLogResponse
דוגמה
דוגמת get_event_log
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 # מספר שלם |
10opts = {
11 end_time: 789 # מספר שלם |
12}
13
14begin
15
16 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_event_log: #{e}"
20end
21
get_global_event_log
req tenantId urlId userIdWS
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| userIdWS | string | query | כן | |
| startTime | integer | query | כן | |
| endTime | integer | query | לא |
תגובה
מחזיר: GetEventLogResponse
דוגמה
דוגמה ל-get_global_event_log
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 # מספר שלם |
10opts = {
11 end_time: 789 # מספר שלם |
12}
13
14begin
15
16 result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_global_event_log: #{e}"
20end
21
create_feed_post
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| broadcastId | string | query | לא | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| skipDupCheck | boolean | query | לא |
תגובה
מחזיר: CreateFeedPostsResponse
דוגמה
דוגמה ל-create_feed_post
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_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
create_feed_post_public
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: CreateFeedPostResponse
דוגמה
דוגמה ל-create_feed_post_public
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
delete_feed_post_public
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: DeleteFeedPostPublicResponse
דוגמה
דוגמא ל-delete_feed_post_public
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
get_feed_posts
req tenantId afterId
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| afterId | string | query | לא | |
| limit | integer | query | לא | |
| tags | array | query | לא |
תגובה
מחזיר: GetFeedPostsResponse
דוגמה
דוגמה ל-get_feed_posts
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 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
get_feed_posts_public
req tenantId afterId
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| afterId | string | query | לא | |
| limit | integer | query | לא | |
| tags | array | query | לא | |
| sso | string | query | לא | |
| isCrawler | boolean | query | לא | |
| includeUserInfo | boolean | query | לא |
תגובה
Returns: PublicFeedPostsResponse
דוגמה
דוגמה ל-get_feed_posts_public
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
get_feed_posts_stats
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postIds | array | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: FeedPostsStatsResponse
דוגמה
דוגמה ל-get_feed_posts_stats
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7post_ids = ['inner_example'] # מערך<String> |
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
get_user_reacts_public
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | נתיב | כן | |
| postIds | array | שאילתה | לא | |
| sso | string | שאילתה | לא |
תגובה
מחזיר: UserReactsResponse
דוגמה
דוגמה ל-get_user_reacts_public
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
react_feed_post_public
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postId | string | path | כן | |
| isUndo | boolean | query | לא | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ReactFeedPostResponse
דוגמה
דוגמה ל-react_feed_post_public
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 |
8react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams |
9opts = {
10 is_undo: true, # Boolean |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
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
update_feed_post
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_feed_post
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
update_feed_post_public
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: CreateFeedPostResponse
דוגמה
דוגמה ל-update_feed_post_public
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
flag_comment_public
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| isFlagged | boolean | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-flag_comment_public
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7comment_id = 'comment_id_example' # מחרוזת |
8is_flagged = true # בוליאני |
9opts = {
10 sso: 'sso_example' # מחרוזת |
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
get_gif_large
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| largeInternalURLSanitized | string | query | כן |
תגובה
מחזיר: GifGetLargeResponse
דוגמה
get_gif_large דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7large_internal_url_sanitized = 'large_internal_url_sanitized_example' # מחרוזת |
8
9begin
10
11 result = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_gif_large: #{e}"
15end
16
get_gifs_search
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| search | string | query | כן | |
| locale | string | query | לא | |
| rating | string | query | לא | |
| page | number | query | לא |
תגובה
מחזיר: GetGifsSearchResponse
דוגמה
דוגמה ל-get_gifs_search
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7search = 'search_example' # String |
8opts = {
9 locale: 'locale_example', # String |
10 rating: 'rating_example', # String |
11 page: 1.2 # Float |
12}
13
14begin
15
16 result = api_instance.get_gifs_search(tenant_id, search, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_gifs_search: #{e}"
20end
21
get_gifs_trending
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| locale | string | query | לא | |
| rating | string | query | לא | |
| page | number | query | לא |
תגובה
מחזיר: GetGifsTrendingResponse
דוגמה
דוגמה ל-get_gifs_trending
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 locale: 'locale_example', # String |
9 rating: 'rating_example', # String |
10 page: 1.2 # Float |
11}
12
13begin
14
15 result = api_instance.get_gifs_trending(tenant_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_gifs_trending: #{e}"
19end
20
add_hash_tag
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תשובה
מחזיר: CreateHashTagResponse
דוגמה
add_hash_tag דוגמה
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_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
15
16begin
17
18 result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "שגיאה בעת קריאה ל-DefaultApi->add_hash_tag: #{e}"
22end
23
add_hash_tags_bulk
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: BulkCreateHashTagsResponse
דוגמה
add_hash_tags_bulk דוגמה
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_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
15
16begin
17
18 result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
22end
23
delete_hash_tag
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
תגובה
Returns: APIEmptyResponse
דוגמה
delete_hash_tag דוגמה
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 |
14tag = 'tag_example' # String |
15delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody |
16
17begin
18
19 result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "שגיאה בעת קריאת DefaultApi->delete_hash_tag: #{e}"
23end
24
get_hash_tags
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| page | number | query | לא |
תגובה
מחזיר: GetHashTagsResponse
דוגמה
דוגמה ל-get_hash_tags
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
patch_hash_tag
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| tag | string | path | כן |
תגובה
מחזיר: UpdateHashTagResponse
דוגמה
patch_hash_tag דוגמה
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 |
14tag = 'tag_example' # String |
15update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
16
17begin
18
19 result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
23end
24
delete_moderation_vote
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
מחזיר: VoteDeleteResponse
דוגמה
דוגמה למחיקת delete_moderation_vote
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8vote_id = 'vote_id_example' # String |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->delete_moderation_vote: #{e}"
20end
21
get_api_comments
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPIGetCommentsResponse
דוגמה
get_api_comments דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 page: 1.2, # Float |
9 count: 1.2, # Float |
10 text_search: 'text_search_example', # String |
11 by_ip_from_comment: 'by_ip_from_comment_example', # String |
12 filters: 'filters_example', # String |
13 search_filters: 'search_filters_example', # String |
14 sorts: 'sorts_example', # String |
15 demo: true, # Boolean |
16 sso: 'sso_example' # String |
17}
18
19begin
20
21 result = api_instance.get_api_comments(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling ModerationApi->get_api_comments: #{e}"
25end
26
get_api_export_status
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| batchJobId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ModerationExportStatusResponse
דוגמה
get_api_export_status דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 batch_job_id: 'batch_job_id_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_api_export_status(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_api_export_status: #{e}"
18end
19
get_api_ids
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPIGetCommentIdsResponse
דוגמה
דוגמת get_api_ids
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filters: 'filters_example', # String |
11 search_filters: 'search_filters_example', # String |
12 after_id: 'after_id_example', # String |
13 demo: true, # Boolean |
14 sso: 'sso_example' # String |
15}
16
17begin
18
19 result = api_instance.get_api_ids(tenant_id, opts)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling ModerationApi->get_api_ids: #{e}"
23end
24
get_ban_users_from_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetBannedUsersFromCommentResponse
דוגמה
דוגמה get_ban_users_from_comment
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_ban_users_from_comment(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_ban_users_from_comment: #{e}"
18end
19
get_comment_ban_status
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
מחזיר: GetCommentBanStatusResponse
דוגמה
דוגמת get_comment_ban_status
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_comment_ban_status(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_comment_ban_status: #{e}"
18end
19
get_comment_children
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
Returns: ModerationAPIChildCommentsResponse
דוגמה
get_comment_children דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_comment_children(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_comment_children: #{e}"
18end
19
get_count
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPICountCommentsResponse
דוגמה
דוגמה get_count
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filter: 'filter_example', # String |
11 search_filters: 'search_filters_example', # String |
12 demo: true, # Boolean |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.get_count(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling ModerationApi->get_count: #{e}"
22end
23
get_counts
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetBannedUsersCountResponse
דוגמה
דוגמת get_counts
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.get_counts(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling ModerationApi->get_counts: #{e}"
17end
18
get_logs
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPIGetLogsResponse
דוגמה
דוגמה של get_logs
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_logs(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_logs: #{e}"
18end
19
get_manual_badges
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetTenantManualBadgesResponse
דוגמה
דוגמת get_manual_badges
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.get_manual_badges(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling ModerationApi->get_manual_badges: #{e}"
17end
18
get_manual_badges_for_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| badgesUserId | string | query | לא | |
| commentId | string | query | לא | |
| sso | string | query | לא |
תשובה
מחזיר: GetUserManualBadgesResponse
דוגמה
דוגמה get_manual_badges_for_user
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 badges_user_id: 'badges_user_id_example', # String |
9 comment_id: 'comment_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.get_manual_badges_for_user(tenant_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->get_manual_badges_for_user: #{e}"
19end
20
get_moderation_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPICommentResponse
דוגמה
get_moderation_comment דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 include_email: true, # Boolean |
10 include_ip: true, # Boolean |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.get_moderation_comment(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->get_moderation_comment: #{e}"
20end
21
get_moderation_comment_text
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
מחזיר: GetCommentTextResponse
דוגמה
דוגמה get_moderation_comment_text
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_moderation_comment_text(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_moderation_comment_text: #{e}"
18end
19
get_pre_ban_summary
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: PreBanSummary
דוגמה
get_pre_ban_summary דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 include_by_user_id_and_email: true, # Boolean |
10 include_by_ip: true, # Boolean |
11 include_by_email_domain: true, # Boolean |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.get_pre_ban_summary(tenant_id, comment_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->get_pre_ban_summary: #{e}"
21end
22
get_search_comments_summary
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
תשובה
מחזיר: ModerationCommentSearchResponse
דוגמה
דוגמת get_search_comments_summary
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7opts = {
8 value: 'value_example', # מחרוזת |
9 filters: 'filters_example', # מחרוזת |
10 search_filters: 'search_filters_example', # מחרוזת |
11 sso: 'sso_example' # מחרוזת |
12}
13
14begin
15
16 result = api_instance.get_search_comments_summary(tenant_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
20end
21
get_search_pages
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationPageSearchResponse
דוגמה
get_search_pages דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 value: 'value_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_search_pages(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_pages: #{e}"
18end
19
get_search_sites
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| value | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ModerationSiteSearchResponse
דוגמה
get_search_sites דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 value: 'value_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_search_sites(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_sites: #{e}"
18end
19
get_search_suggest
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationSuggestResponse
דוגמה
דוגמת get_search_suggest
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_search_suggest(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_suggest: #{e}"
18end
19
get_search_users
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationUserSearchResponse
דוגמה
דוגמת get_search_users
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7opts = {
8 value: 'value_example', # מחרוזת |
9 sso: 'sso_example' # מחרוזת |
10}
11
12begin
13
14 result = api_instance.get_search_users(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_users: #{e}"
18end
19
get_trust_factor
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: GetUserTrustFactorResponse
דוגמה
get_trust_factor דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 user_id: 'user_id_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_trust_factor(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_trust_factor: #{e}"
18end
19
get_user_ban_preference
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: APIModerateGetUserBanPreferencesResponse
דוגמה
get_user_ban_preference דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.get_user_ban_preference(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling ModerationApi->get_user_ban_preference: #{e}"
17end
18
get_user_internal_profile
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: GetUserInternalProfileResponse
דוגמה
get_user_internal_profile דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7opts = {
8 comment_id: 'comment_id_example', # מחרוזת |
9 sso: 'sso_example' # מחרוזת |
10}
11
12begin
13
14 result = api_instance.get_user_internal_profile(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_user_internal_profile: #{e}"
18end
19
post_adjust_comment_votes
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: AdjustVotesResponse
דוגמה
post_adjust_comment_votes דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_adjust_comment_votes: #{e}"
20end
21
post_api_export
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Response
מחזיר: ModerationExportResponse
Example
post_api_export דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7opts = {
8 text_search: 'text_search_example', # מחרוזת |
9 by_ip_from_comment: 'by_ip_from_comment_example', # מחרוזת |
10 filters: 'filters_example', # מחרוזת |
11 search_filters: 'search_filters_example', # מחרוזת |
12 sorts: 'sorts_example', # מחרוזת |
13 sso: 'sso_example' # מחרוזת |
14}
15
16begin
17
18 result = api_instance.post_api_export(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling ModerationApi->post_api_export: #{e}"
22end
23
post_ban_user_from_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| banEmail | boolean | query | לא | |
| banEmailDomain | boolean | query | לא | |
| banIP | boolean | query | לא | |
| deleteAllUsersComments | boolean | query | לא | |
| bannedUntil | string | query | לא | |
| isShadowBan | boolean | query | לא | |
| updateId | string | query | לא | |
| banReason | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: BanUserFromCommentResult
דוגמה
post_ban_user_from_comment דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 ban_email: true, # Boolean |
10 ban_email_domain: true, # Boolean |
11 ban_ip: true, # Boolean |
12 delete_all_users_comments: true, # Boolean |
13 banned_until: 'banned_until_example', # String |
14 is_shadow_ban: true, # Boolean |
15 update_id: 'update_id_example', # String |
16 ban_reason: 'ban_reason_example', # String |
17 sso: 'sso_example' # String |
18}
19
20begin
21
22 result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling ModerationApi->post_ban_user_from_comment: #{e}"
26end
27
post_ban_user_undo
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזירה: APIEmptyResponse
דוגמה
דוגמת post_ban_user_undo
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7ban_user_undo_params = FastCommentsClient::BanUserUndoParams.new({changelog: FastCommentsClient::APIBanUserChangeLog.new}) # BanUserUndoParams |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->post_ban_user_undo: #{e}"
18end
19
post_bulk_pre_ban_summary
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: BulkPreBanSummary
דוגמה
post_bulk_pre_ban_summary דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7bulk_pre_ban_params = FastCommentsClient::BulkPreBanParams.new({comment_ids: ['comment_ids_example']}) # BulkPreBanParams |
8opts = {
9 include_by_user_id_and_email: true, # Boolean |
10 include_by_ip: true, # Boolean |
11 include_by_email_domain: true, # Boolean |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->post_bulk_pre_ban_summary: #{e}"
21end
22
post_comments_by_ids
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזירה: ModerationAPIChildCommentsResponse
דוגמה
post_comments_by_ids דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comments_by_ids_params = FastCommentsClient::CommentsByIdsParams.new({ids: ['ids_example']}) # CommentsByIdsParams |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->post_comments_by_ids: #{e}"
18end
19
post_flag_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
post_flag_comment דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.post_flag_comment(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->post_flag_comment: #{e}"
19end
20
post_remove_comment
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
Response
מחזיר: PostRemoveCommentApiResponse
Example
דוגמה post_remove_comment
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.post_remove_comment(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->post_remove_comment: #{e}"
19end
20
post_restore_deleted_comment
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: APIEmptyResponse
דוגמה
post_restore_deleted_comment דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.post_restore_deleted_comment(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->post_restore_deleted_comment: #{e}"
19end
20
post_set_comment_approval_status
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: SetCommentApprovedResponse
דוגמה
post_set_comment_approval_status דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 approved: true, # Boolean |
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_set_comment_approval_status(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_set_comment_approval_status: #{e}"
20end
21
post_set_comment_review_status
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| reviewed | boolean | query | לא | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזירים: APIEmptyResponse
דוגמה
post_set_comment_review_status דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 reviewed: true, # Boolean |
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_set_comment_review_status(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_set_comment_review_status: #{e}"
20end
21
post_set_comment_spam_status
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| spam | boolean | query | לא | |
| permNotSpam | boolean | query | לא | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
Returns: APIEmptyResponse
דוגמה
post_set_comment_spam_status דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 spam: true, # Boolean |
10 perm_not_spam: true, # Boolean |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
21end
22
post_set_comment_text
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
Returns: SetCommentTextResponse
דוגמה
post_set_comment_text דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8set_comment_text_params = FastCommentsClient::SetCommentTextParams.new({comment: 'comment_example'}) # SetCommentTextParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_set_comment_text: #{e}"
20end
21
post_un_flag_comment
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
Returns: APIEmptyResponse
דוגמה
post_un_flag_comment דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.post_un_flag_comment(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->post_un_flag_comment: #{e}"
19end
20
post_vote
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תשובה
מחזיר: VoteResponse
דוגמה
דוגמת post_vote
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 direction: 'direction_example', # String |
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_vote(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_vote: #{e}"
20end
21
put_award_badge
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תשובה
מחזיר: AwardUserBadgeResponse
דוגמה
put_award_badge דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7badge_id = 'badge_id_example' # String |
8opts = {
9 user_id: 'user_id_example', # String |
10 comment_id: 'comment_id_example', # String |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.put_award_badge(tenant_id, badge_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->put_award_badge: #{e}"
21end
22
put_close_thread
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
put_close_thread דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.put_close_thread(tenant_id, url_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->put_close_thread: #{e}"
18end
19
put_remove_badge
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: RemoveUserBadgeResponse
דוגמה
דוגמת put_remove_badge
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7badge_id = 'badge_id_example' # String |
8opts = {
9 user_id: 'user_id_example', # String |
10 comment_id: 'comment_id_example', # String |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.put_remove_badge(tenant_id, badge_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->put_remove_badge: #{e}"
21end
22
put_reopen_thread
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמת put_reopen_thread
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8opts = {
9 sso: 'sso_example' # מחרוזת |
10}
11
12begin
13
14 result = api_instance.put_reopen_thread(tenant_id, url_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->put_reopen_thread: #{e}"
18end
19
set_trust_factor
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: SetUserTrustFactorResponse
דוגמה
דוגמת set_trust_factor
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 user_id: 'user_id_example', # String |
9 trust_factor: 'trust_factor_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.set_trust_factor(tenant_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->set_trust_factor: #{e}"
19end
20
create_moderator
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateModeratorResponse
דוגמה
דוגמה ל-create_moderator
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_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
delete_moderator
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| sendEmail | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמת delete_moderator
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
get_moderator
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetModeratorResponse
דוגמה
דוגמה ל-get_moderator
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_moderator(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_moderator: #{e}"
22end
23
get_moderators
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetModeratorsResponse
דוגמה
דוגמה ל-get_moderators
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
send_invite
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| fromName | string | query | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-send_invite
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 |
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
update_moderator
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_moderator
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_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
delete_notification_count
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_notification_count
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_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_notification_count: #{e}"
22end
23
get_cached_notification_count
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מוחזר: GetCachedNotificationCountResponse
דוגמה
דוגמה ל-get_cached_notification_count
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
get_notification_count
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| urlId | string | query | לא | |
| fromCommentId | string | query | לא | |
| viewed | boolean | query | לא | |
| type | string | query | לא |
תגובה
מחזיר: GetNotificationCountResponse
דוגמה
דוגמה ל-get_notification_count
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 user_id: 'user_id_example', # מחרוזת |
16 url_id: 'url_id_example', # מחרוזת |
17 from_comment_id: 'from_comment_id_example', # מחרוזת |
18 viewed: true, # בוליאני |
19 type: 'type_example' # מחרוזת |
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
get_notifications
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| urlId | string | query | לא | |
| fromCommentId | string | query | לא | |
| viewed | boolean | query | לא | |
| type | string | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetNotificationsResponse
דוגמה
דוגמה ל-get_notifications
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 user_id: 'user_id_example', # מחרוזת |
16 url_id: 'url_id_example', # מחרוזת |
17 from_comment_id: 'from_comment_id_example', # מחרוזת |
18 viewed: true, # בוליאני |
19 type: 'type_example', # מחרוזת |
20 skip: 1.2 # מספר עשרוני |
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
update_notification
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תשובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_notification
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_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
create_v1_page_react
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| title | string | query | לא |
תגובה
מחזיר: CreateV1PageReact
דוגמה
דוגמה ל-create_v1_page_react
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 title: 'title_example' # String |
10}
11
12begin
13
14 result = api_instance.create_v1_page_react(tenant_id, url_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->create_v1_page_react: #{e}"
18end
19
create_v2_page_react
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No |
תגובה
מחזיר: CreateV1PageReact
דוגמה
דוגמה ל-create_v2_page_react
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 |
8id = 'id_example' # String |
9opts = {
10 title: 'title_example' # String |
11}
12
13begin
14
15 result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->create_v2_page_react: #{e}"
19end
20
delete_v1_page_react
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: CreateV1PageReact
דוגמה
דוגמת delete_v1_page_react
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 |
8
9begin
10
11 result = api_instance.delete_v1_page_react(tenant_id, url_id)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->delete_v1_page_react: #{e}"
15end
16
delete_v2_page_react
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| id | string | query | כן |
תגובה
מחזיר: CreateV1PageReact
דוגמה
דוגמה ל-delete_v2_page_react
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8id = 'id_example' # מחרוזת |
9
10begin
11
12 result = api_instance.delete_v2_page_react(tenant_id, url_id, id)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->delete_v2_page_react: #{e}"
16end
17
get_v1_page_likes
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetV1PageLikes
דוגמה
דוגמה ל-get_v1_page_likes
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8
9begin
10
11 result = api_instance.get_v1_page_likes(tenant_id, url_id)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_v1_page_likes: #{e}"
15end
16
get_v2_page_react_users
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| id | string | query | כן |
תגובה
מחזיר: GetV2PageReactUsersResponse
דוגמה
דוגמה ל-get_v2_page_react_users
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8id = 'id_example' # מחרוזת |
9
10begin
11
12 result = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->get_v2_page_react_users: #{e}"
16end
17
get_v2_page_reacts
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetV2PageReacts
דוגמה
דוגמה ל-get_v2_page_reacts
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 |
8
9begin
10
11 result = api_instance.get_v2_page_reacts(tenant_id, url_id)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_v2_page_reacts: #{e}"
15end
16
add_page
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddPageAPIResponse
דוגמה
דוגמה ל-add_page
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
delete_page
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: DeletePageAPIResponse
דוגמה
דוגמה ל-delete_page
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
get_offline_users
מצביעים שניקבו בעבר בעמוד ואינם מקוונים כרגע. ממוינים לפי displayName. השתמש בזה לאחר שתרוקנו את /users/online כדי להציג מדור 'חברים'. דפדוף מבוסס סמן על commenterName: השרת מהלך את האינדקס החלקי {tenantId, urlId, commenterName} מהafterName והלאה באמצעות $gt, ללא עלות $skip.
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | מזהה כתובת ה-URL של הדף (מנוקה בצד השרת). |
| afterName | string | query | לא | סמן: העבר את nextAfterName מהתגובה הקודמת. |
| afterUserId | string | query | לא | שובר שוויון של הסמן: העבר את nextAfterUserId מהתגובה הקודמת. נדרש כאשר afterName מוגדר כדי ששוויון בשמות לא יגרום להחמצת רשומות. |
תגובה
מחזיר: PageUsersOfflineResponse
דוגמה
דוגמה ל-get_offline_users
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 | מזהה כתובת ה-URL של הדף (מנוקה בצד השרת).
8opts = {
9 after_name: 'after_name_example', # String | סמן: העבר את nextAfterName מהתגובה הקודמת.
10 after_user_id: 'after_user_id_example' # String | שובר שוויון של הסמן: העבר את nextAfterUserId מהתגובה הקודמת. נדרש כאשר afterName מוגדר כדי ששוויון בשמות לא יגרום להחמצת רשומות.
11}
12
13begin
14
15 result = api_instance.get_offline_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_offline_users: #{e}"
19end
20
get_online_users
צופים שמחוברים כעת לעמוד: אנשים שה-session שלהם ב-websocket מנוי לעמוד כרגע. מחזיר anonCount + totalCount (מנויים ברחבי החדר, כולל צופים אנונימיים שאותם אנו לא מפרטים).
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | מזהה URL של העמוד (מנוקה בצד השרת). |
| afterName | string | query | לא | Cursor: העבר את nextAfterName מהתגובה הקודמת. |
| afterUserId | string | query | לא | שובר שוויון עבור Cursor: העבר את nextAfterUserId מהתגובה הקודמת. נדרש כאשר afterName מוגדר כדי שמקרים של שוויון בשמות לא יגרמו להשמטת רשומות. |
תגובה
מחזיר: PageUsersOnlineResponse
דוגמה
get_online_users Example
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 | מזהה URL של העמוד (מנוקה בצד השרת).
8opts = {
9 after_name: 'after_name_example', # String | Cursor: העבר את nextAfterName מהתגובה הקודמת.
10 after_user_id: 'after_user_id_example' # String | שובר שוויון עבור Cursor: העבר את nextAfterUserId מהתגובה הקודמת. נדרש כאשר afterName מוגדר כדי שמקרים של שוויון בשמות לא יגרמו להשמטת רשומות.
11}
12
13begin
14
15 result = api_instance.get_online_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_online_users: #{e}"
19end
20
get_page_by_urlid
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetPageByURLIdAPIResponse
דוגמה
דוגמה ל-get_page_by_urlid
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
get_pages
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetPagesAPIResponse
דוגמה
דוגמת get_pages
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
get_pages_public
רשימת דפים עבור tenant. משמשת על ידי לקוח שולחן העבודה של FChat כדי למלא את רשימת החדרים שלו.
דורש ש-enableFChat יהיה true בקונפיגורציית ה-custom שנפתרה עבור כל דף.
דפים שדורשים SSO מסוננים לפי גישת הקבוצות של המשתמש המבקש.
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| cursor | string | query | לא | מצביע דפדוף אטום שהוחזר כ-nextCursor מבקשה קודמת. קשור לאותו sortBy. |
| limit | integer | query | לא | 1..200, ברירת מחדל 50 |
| q | string | query | לא | מסנן אופציונלי על תחילת הכותרת, שאינו רגיש להבדל בין אותיות גדולות וקטנות. |
| sortBy | string | query | לא | סדר המיון. updatedAt (ברירת מחדל, החדשים ביותר תחילה), commentCount (הכי הרבה תגובות תחילה), או title (אלפביתי). |
| hasComments | boolean | query | לא | אם true, החזר רק דפים עם לפחות תגובה אחת. |
תגובה
מחזיר: GetPublicPagesResponse
דוגמה
get_pages_public דוגמה
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7opts = {
8 cursor: 'cursor_example', # מחרוזת | מצביע דפדוף אטום שהוחזר כ-`nextCursor` מבקשה קודמת. קשור לאותו `sortBy`.
9 limit: 56, # מספר שלם | 1..200, ברירת מחדל 50
10 q: 'q_example', # מחרוזת | מסנן אופציונלי על תחילת הכותרת, שאינו רגיש להבדל בין אותיות גדולות וקטנות.
11 sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | סדר המיון. `updatedAt` (ברירת מחדל, החדשים ביותר תחילה), `commentCount` (הכי הרבה תגובות תחילה), או `title` (אלפביתי).
12 has_comments: true # בוליאני | אם true, החזר רק דפים שבהם לפחות תגובה אחת.
13}
14
15begin
16
17 result = api_instance.get_pages_public(tenant_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->get_pages_public: #{e}"
21end
22
get_users_info
מידע משתמשים באצווה עבור טננט. בהינתן userIds, מחזיר מידע להצגה מ-User / SSOUser. משמש את ווידג'ט ההערות להעשיר משתמשים שהופיעו זה עתה באמצעות אירוע נוכחות. אין הקשר של דף: הפרטיות נאכפת באופן אחיד (פרופילים פרטיים מוסתרים).
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds מופרדים בפסיקים. |
תגובה
מחזיר: PageUsersInfoResponse
דוגמה
דוגמה ל-get_users_info
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7ids = 'ids_example' # String | Comma-delimited userIds.
8
9begin
10
11 result = api_instance.get_users_info(tenant_id, ids)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_users_info: #{e}"
15end
16
patch_page
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: PatchPageAPIResponse
דוגמה
דוגמה ל-patch_page
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
delete_pending_webhook_event
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_pending_webhook_event
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
get_pending_webhook_event_count
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | לא | |
| externalId | string | query | לא | |
| eventType | string | query | לא | |
| type | string | query | לא | |
| domain | string | query | לא | |
| attemptCountGT | number | query | לא |
תגובה
מחזיר: GetPendingWebhookEventCountResponse
דוגמה
get_pending_webhook_event_count דוגמה
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
get_pending_webhook_events
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | לא | |
| externalId | string | query | לא | |
| eventType | string | query | לא | |
| type | string | query | לא | |
| domain | string | query | לא | |
| attemptCountGT | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetPendingWebhookEventsResponse
דוגמה
דוגמה ל-get_pending_webhook_events
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 skip: 1.2 # Float |
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
create_question_config
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תגובה
מחזיר: CreateQuestionConfigResponse
דוגמה
דוגמה ל-create_question_config
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
delete_question_config
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_question_config
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
get_question_config
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetQuestionConfigResponse
דוגמה
דוגמה ל-get_question_config
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
get_question_configs
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetQuestionConfigsResponse
דוגמה
דוגמה ל-get_question_configs
Copy
1
2require 'time'
3require 'fastcomments-client'
4# הגדרת אימות
5FastCommentsClient.configure do |config|
6 # הגדר אימות באמצעות מפתח API: api_key
7 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת המחדל: nil)
8end
9
10api_instance = FastCommentsClient::DefaultApi.new
11tenant_id = 'tenant_id_example' # String |
12opts = {
13 skip: 1.2 # Float |
14}
15
16begin
17
18 result = api_instance.get_question_configs(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_configs: #{e}"
22end
23
update_question_config
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_question_config
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
create_question_result
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תשובה
מחזיר: CreateQuestionResultResponse
דוגמה
דוגמה ל-create_question_result
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
delete_question_result
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמת delete_question_result
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_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23
get_question_result
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: GetQuestionResultResponse
דוגמה
דוגמה ל-get_question_result
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
get_question_results
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | לא | |
| userId | string | query | לא | |
| startDate | string | query | לא | |
| questionId | string | query | לא | |
| questionIds | string | query | לא | |
| skip | number | query | לא |
תשובה
מחזיר: GetQuestionResultsResponse
דוגמה
דוגמה ל-get_question_results
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 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
update_question_result
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_question_result
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_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
aggregate_question_results
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
תגובה
מחזיר: AggregateQuestionResultsResponse
דוגמה
דוגמה ל-aggregate_question_results
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 |
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
bulk_aggregate_question_results
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| forceRecalculate | boolean | query | לא |
תגובה
מחזיר: BulkAggregateQuestionResultsResponse
דוגמה
דוגמה ל-bulk_aggregate_question_results
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 |
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
combine_comments_with_question_results
פרמטרים
| שם | Type | Location | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| questionId | string | query | לא | |
| questionIds | array | query | לא | |
| urlId | string | query | לא | |
| startDate | string | query | לא | |
| forceRecalculate | boolean | query | לא | |
| minValue | number | query | לא | |
| maxValue | number | query | לא | |
| limit | number | query | לא |
תגובה
מחזיר: CombineQuestionResultsWithCommentsResponse
דוגמה
דוגמה ל-combine_comments_with_question_results
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 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
add_sso_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddSSOUserAPIResponse
דוגמה
דוגמה ל-add_sso_user
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
delete_sso_user
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| deleteComments | boolean | query | לא | |
| commentDeleteMode | string | query | לא |
תגובה
מחזיר: DeleteSSOUserAPIResponse
דוגמה
דוגמה ל-delete_sso_user
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
get_sso_user_by_email
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| string | path | כן |
תגובה
מחזיר: GetSSOUserByEmailAPIResponse
דוגמה
דוגמה ל-get_sso_user_by_email
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
get_sso_user_by_id
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetSSOUserByIdAPIResponse
דוגמה
דוגמה ל-get_sso_user_by_id
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
get_sso_users
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | integer | query | לא |
תגובה
מחזיר: GetSSOUsersResponse
דוגמה
get_sso_users דוגמה
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: 56 # Integer |
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
patch_sso_user
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | boolean | query | לא |
תגובה
מחזיר: PatchSSOUserAPIResponse
דוגמה
דוגמה ל-patch_sso_user
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
put_sso_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | boolean | query | לא |
תגובה
מחזיר: PutSSOUserAPIResponse
דוגמה
דוגמה ל-put_sso_user
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
create_subscription
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateSubscriptionAPIResponse
דוגמה
דוגמה ל-create_subscription
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
delete_subscription
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: DeleteSubscriptionAPIResponse
דוגמה
דוגמה ל-delete_subscription
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
get_subscriptions
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא |
תשובה
מחזיר: GetSubscriptionsAPIResponse
דוגמה
דוגמה ל-get_subscriptions
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
update_subscription
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: UpdateSubscriptionAPIResponse
דוגמה
דוגמה ל-update_subscription
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
get_tenant_daily_usages
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
תגובה
מחזיר: GetTenantDailyUsagesResponse
דוגמה
דוגמה ל-get_tenant_daily_usages
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
create_tenant_package
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תגובה
מחזיר: CreateTenantPackageResponse
דוגמה
דוגמה ל-create_tenant_package
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
delete_tenant_package
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_tenant_package
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
get_tenant_package
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetTenantPackageResponse
דוגמה
דוגמה ל-get_tenant_package
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
get_tenant_packages
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
תגובה
מחזיר: GetTenantPackagesResponse
דוגמה
דוגמת get_tenant_packages
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
replace_tenant_package
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-replace_tenant_package
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_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
update_tenant_package
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_tenant_package
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
create_tenant_user
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תגובה
מחזיר: CreateTenantUserResponse
דוגמה
דוגמה ל-create_tenant_user
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_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
delete_tenant_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| deleteComments | string | query | לא | |
| commentDeleteMode | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_tenant_user
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: 'delete_comments_example', # String |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
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
get_tenant_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: GetTenantUserResponse
דוגמה
דוגמה ל-get_tenant_user
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
get_tenant_users
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetTenantUsersResponse
דוגמה
דוגמת get_tenant_users
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_tenant_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_users: #{e}"
24end
25
replace_tenant_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-replace_tenant_user
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
send_login_link
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| redirectURL | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-send_login_link
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
update_tenant_user
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_tenant_user
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
create_tenant
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תשובה
מחזיר: CreateTenantResponse
דוגמה
דוגמת create_tenant
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_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
delete_tenant
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| sure | string | query | לא |
תשובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-delete_tenant
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 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
get_tenant
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetTenantResponse
דוגמה
דוגמת get_tenant
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
get_tenants
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| meta | string | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetTenantsResponse
דוגמה
דוגמה ל-get_tenants
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 meta: 'meta_example', # String |
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_tenants(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_tenants: #{e}"
25end
26
update_tenant
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה
דוגמה ל-update_tenant
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
change_ticket_state
פרמטרים
| שם | Type | Location | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: ChangeTicketStateResponse
דוגמה
דוגמה ל-change_ticket_state
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
create_ticket
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | כן |
תגובה
מחזיר: CreateTicketResponse
דוגמה
דוגמה ל-create_ticket
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
get_ticket
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: GetTicketResponse
דוגמה
דוגמה ל-get_ticket
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.get_ticket(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_ticket: #{e}"
25end
26
get_tickets
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| state | number | query | לא | |
| skip | number | query | לא | |
| limit | number | query | לא |
תשובה
מחזיר: GetTicketsResponse
דוגמה
דוגמת get_tickets
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 |
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
get_translations
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | כן | |
| component | string | path | כן | |
| locale | string | query | לא | |
| useFullTranslationIds | boolean | query | לא |
תגובה
מחזיר: GetTranslationsResponse
דוגמה
דוגמה ל-get_translations
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6namespace = 'namespace_example' # מחרוזת |
7component = 'component_example' # מחרוזת |
8opts = {
9 locale: 'locale_example', # מחרוזת |
10 use_full_translation_ids: true # בוליאני |
11}
12
13begin
14
15 result = api_instance.get_translations(namespace, component, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_translations: #{e}"
19end
20
upload_image
העלאה ושינוי גודל תמונה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| sizePreset | string | query | לא | ערכת גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים) |
| urlId | string | query | לא | מזהה העמוד שממנו מתבצעת ההעלאה, לצורך קונפיגורציה |
תגובה
מחזיר: UploadImageResponse
דוגמה
דוגמה ל-upload_image
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
get_user_badge_progress_by_id
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIGetUserBadgeProgressResponse
דוגמה
get_user_badge_progress_by_id דוגמה
Copy
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
get_user_badge_progress_by_user_id
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | path | כן |
תגובה
מחזיר: APIGetUserBadgeProgressResponse
דוגמה
דוגמה ל-get_user_badge_progress_by_user_id
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 "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
22end
23
get_user_badge_progress_list
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| limit | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: APIGetUserBadgeProgressListResponse
דוגמה
דוגמה של get_user_badge_progress_list
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 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
create_user_badge
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תגובה
מחזיר: APICreateUserBadgeResponse
דוגמה
דוגמה ל-create_user_badge
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_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
delete_user_badge
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptySuccessResponse
דוגמה
דוגמה ל-delete_user_badge
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_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_user_badge: #{e}"
22end
23
get_user_badge
פרמטרים
| שם | Type | Location | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIGetUserBadgeResponse
דוגמה
דוגמה ל-get_user_badge
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_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23
get_user_badges
פרמטרים
| שם | Type | Location | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| badgeId | string | query | לא | |
| type | number | query | לא | |
| displayedOnComments | boolean | query | לא | |
| limit | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: APIGetUserBadgesResponse
דוגמה
דוגמה ל-get_user_badges
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 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
update_user_badge
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptySuccessResponse
דוגמה
דוגמה ל-update_user_badge
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_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
get_user_notification_count
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetUserNotificationCountResponse
דוגמה
get_user_notification_count דוגמה
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
get_user_notifications
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | לא | משמש כדי לקבוע האם העמוד הנוכחי מנוי. |
| pageSize | integer | query | לא | |
| afterId | string | query | לא | |
| includeContext | boolean | query | לא | |
| afterCreatedAt | integer | query | לא | |
| unreadOnly | boolean | query | לא | |
| dmOnly | boolean | query | לא | |
| noDm | boolean | query | לא | |
| includeTranslations | boolean | query | לא | |
| includeTenantNotifications | boolean | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: GetMyNotificationsResponse
דוגמה
דוגמה ל-get_user_notifications
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 url_id: 'url_id_example', # String | משמש כדי לקבוע האם העמוד הנוכחי מנוי.
9 page_size: 56, # Integer |
10 after_id: 'after_id_example', # String |
11 include_context: true, # Boolean |
12 after_created_at: 789, # Integer |
13 unread_only: true, # Boolean |
14 dm_only: true, # Boolean |
15 no_dm: true, # Boolean |
16 include_translations: true, # Boolean |
17 include_tenant_notifications: true, # Boolean |
18 sso: 'sso_example' # String |
19}
20
21begin
22
23 result = api_instance.get_user_notifications(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling PublicApi->get_user_notifications: #{e}"
27end
28
reset_user_notification_count
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: ResetUserNotificationsResponse
דוגמה
דוגמה ל-reset_user_notification_count
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
reset_user_notifications
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| afterId | string | query | לא | |
| afterCreatedAt | integer | query | לא | |
| unreadOnly | boolean | query | לא | |
| dmOnly | boolean | query | לא | |
| noDm | boolean | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ResetUserNotificationsResponse
דוגמה
דוגמה ל-reset_user_notifications
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
update_user_notification_comment_subscription_status
הפעל או בטל התראות עבור תגובה ספציפית.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| notificationId | string | path | כן | |
| optedInOrOut | string | path | כן | |
| commentId | string | query | כן | |
| sso | string | query | לא |
Response
מחזיר: UpdateUserNotificationCommentSubscriptionStatusResponse
דוגמה
דוגמה ל-update_user_notification_comment_subscription_status
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
update_user_notification_page_subscription_status
הפעל או השבת התראות עבור דף. כאשר משתמשים מנויים לדף, נוצרות התראות עבור תגובות שורש חדשות, וגם
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| url | string | query | כן | |
| pageTitle | string | query | כן | |
| subscribedOrUnsubscribed | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationPageSubscriptionStatusResponse
דוגמה
דוגמה ל-update_user_notification_page_subscription_status
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8url = 'url_example' # מחרוזת |
9page_title = 'page_title_example' # מחרוזת |
10subscribed_or_unsubscribed = 'subscribe' # מחרוזת |
11opts = {
12 sso: 'sso_example' # מחרוזת |
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
update_user_notification_status
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| notificationId | string | path | כן | |
| newStatus | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationStatusResponse
דוגמה
דוגמה ל-update_user_notification_status
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7notification_id = 'notification_id_example' # מחרוזת |
8new_status = 'read' # מחרוזת |
9opts = {
10 sso: 'sso_example' # מחרוזת |
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
get_user_presence_statuses
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlIdWS | string | query | כן | |
| userIds | string | query | כן |
תגובה
מחזיר: GetUserPresenceStatusesResponse
דוגמה
דוגמה ל-get_user_presence_statuses
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
search_users
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| usernameStartsWith | string | query | לא | |
| mentionGroupIds | array | query | לא | |
| sso | string | query | לא | |
| searchSection | string | query | לא |
תגובה
מחזיר: SearchUsersResult
דוגמה
דוגמה ל-search_users
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # מחרוזת |
7url_id = 'url_id_example' # מחרוזת |
8opts = {
9 username_starts_with: 'username_starts_with_example', # מחרוזת |
10 mention_group_ids: ['inner_example'], # מערך<מחרוזת> |
11 sso: 'sso_example', # מחרוזת |
12 search_section: 'fast' # מחרוזת |
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
get_user
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetUserResponse
דוגמה
דוגמה ל-get_user
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(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user: #{e}"
22end
23
create_vote
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | כן | |
| direction | string | query | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: VoteResponse
דוגמה
דוגמה ל-create_vote
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 |
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
delete_vote
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| editKey | string | query | לא |
תגובה
מחזיר: VoteDeleteResponse
דוגמה
דוגמה ל-delete_vote
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
get_votes
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
תגובה
מחזיר: GetVotesResponse
דוגמה
דוגמה ל-get_votes
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 |
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
get_votes_for_user
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: GetVotesForUserResponse
דוגמה
get_votes_for_user Example
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 |
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 לקבלת הנחיות לתרומה.