FastComments Ruby SDK

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

gem 'fastcomments'

ואז הרץ:

bundle install

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

gem install fastcomments

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

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

• תיעוד ספריית לקוח ה-API

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

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

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

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

require 'fastcomments-client'

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

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

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

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

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

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

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

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

require 'fastcomments-client'

public_api = FastCommentsClient::PublicApi.new

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

בעיות נפוצות

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

מזהי שידור

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

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

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

SSO פשוט

require 'fastcomments'
require 'fastcomments-client'

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

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

puts "SSO Token: #{token}"

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

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

puts "Status: #{response}"

SSO מאובטח

require 'fastcomments'
require 'fastcomments-client'

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

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

puts "Secure SSO Token: #{token}"

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

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

puts "Status: #{response}"

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

פרמטרים

תגובה

מחזיר: AggregationResponse

דוגמה

דוגמה ל-aggregate

Copy

1

2require 'time'

3require 'fastcomments-client'

4# הגדרת אימות

5FastCommentsClient.configure do |config|

6 # הגדר אימות באמצעות מפתח API: api_key

7 config.api_key['x-api-key'] = 'YOUR API KEY'

8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)

9 # config.api_key_prefix['x-api-key'] = 'Bearer'

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |

15opts = {

16 parent_tenant_id: 'parent_tenant_id_example', # String |

17 include_stats: true # Boolean |

18}

19

20begin

21

22 result = api_instance.aggregate(tenant_id, aggregation_request, opts)

23 p result

24rescue FastCommentsClient::ApiError => e

25 puts "Error when calling DefaultApi->aggregate: #{e}"

26end

27

פרמטרים

תגובה

מחזיר: GetAuditLogs200Response

דוגמה

דוגמת 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

פרמטרים

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-block_from_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.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

פרמטרים

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: CheckedCommentsForBlocked200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-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

פרמטרים

Response

מחזיר: CreateCommentPublic200Response

דוגמה

דוגמה ל-create_comment_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # מחרוזת |

7url_id = 'url_id_example' # מחרוזת |

8broadcast_id = 'broadcast_id_example' # מחרוזת |

9comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData |

10opts = {

11 session_id: 'session_id_example', # מחרוזת |

12 sso: 'sso_example' # מחרוזת |

13}

14

15begin

16

17 result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)

18 p result

19rescue FastCommentsClient::ApiError => e

20 puts "Error when calling PublicApi->create_comment_public: #{e}"

21end

22

פרמטרים

תגובה

מחזיר: DeleteComment200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: DeleteCommentPublic200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: DeleteCommentVote200Response

דוגמה

דוגמה ל-delete_comment_vote

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # מחרוזת |

7comment_id = 'comment_id_example' # מחרוזת |

8vote_id = 'vote_id_example' # מחרוזת |

9url_id = 'url_id_example' # מחרוזת |

10broadcast_id = 'broadcast_id_example' # מחרוזת |

11opts = {

12 edit_key: 'edit_key_example', # מחרוזת |

13 sso: 'sso_example' # מחרוזת |

14}

15

16begin

17

18 result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)

19 p result

20rescue FastCommentsClient::ApiError => e

21 puts "Error when calling PublicApi->delete_comment_vote: #{e}"

22end

23

פרמטרים

תשובה

מחזיר: FlagComment200Response

דוגמה

דוגמת 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

פרמטרים

תגובה

מחזיר: GetComment200Response

דוגמה

דוגמה של 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

פרמטרים

תגובה

מחזיר: GetCommentText200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: GetCommentVoteUserNames200Response

דוגמה

דוגמה ל־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

פרמטרים

תגובה

מחזיר: GetComments200Response

דוגמה

דוגמה ל-get_comments

Copy

1

2require 'time'

3require 'fastcomments-client'

4# הגדרת הרשאה

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

7 config.api_key['x-api-key'] = 'YOUR API KEY'

8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת עבור מפתח ה-API, למשל 'Bearer' (ברירת מחדל nil)

9 # config.api_key_prefix['x-api-key'] = 'Bearer'

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14opts = {

15 page: 56, # Integer |

16 limit: 56, # Integer |

17 skip: 56, # Integer |

18 as_tree: true, # Boolean |

19 skip_children: 56, # Integer |

20 limit_children: 56, # Integer |

21 max_tree_depth: 56, # Integer |

22 url_id: 'url_id_example', # String |

23 user_id: 'user_id_example', # String |

24 anon_user_id: 'anon_user_id_example', # String |

25 context_user_id: 'context_user_id_example', # String |

26 hash_tag: 'hash_tag_example', # String |

27 parent_id: 'parent_id_example', # String |

28 direction: FastCommentsClient::SortDirections::OF # SortDirections |

29}

30

31begin

32

33 result = api_instance.get_comments(tenant_id, opts)

34 p result

35rescue FastCommentsClient::ApiError => e

36 puts "Error when calling DefaultApi->get_comments: #{e}"

37end

38

req tenantId urlId

פרמטרים

תגובה

מחזיר: GetCommentsPublic200Response

דוגמה

דוגמה של get_comments_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 |

8opts = {

9 page: 56, # Integer |

10 direction: FastCommentsClient::SortDirections::OF, # SortDirections |

11 sso: 'sso_example', # String |

12 skip: 56, # Integer |

13 skip_children: 56, # Integer |

14 limit: 56, # Integer |

15 limit_children: 56, # Integer |

16 count_children: true, # Boolean |

17 fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String |

18 include_config: true, # Boolean |

19 count_all: true, # Boolean |

20 includei10n: true, # Boolean |

21 locale: 'locale_example', # String |

22 modules: 'modules_example', # String |

23 is_crawler: true, # Boolean |

24 include_notification_count: true, # Boolean |

25 as_tree: true, # Boolean |

26 max_tree_depth: 56, # Integer |

27 use_full_translation_ids: true, # Boolean |

28 parent_id: 'parent_id_example', # String |

29 search_text: 'search_text_example', # String |

30 hash_tags: ['inner_example'], # Array<String> |

31 user_id: 'user_id_example', # String |

32 custom_config_str: 'custom_config_str_example', # String |

33 after_comment_id: 'after_comment_id_example', # String |

34 before_comment_id: 'before_comment_id_example' # String |

35}

36

37begin

38

39 result = api_instance.get_comments_public(tenant_id, url_id, opts)

40 p result

41rescue FastCommentsClient::ApiError => e

42 puts "Error when calling PublicApi->get_comments_public: #{e}"

43end

44

פרמטרים

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמת 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.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

פרמטרים

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמה ל-pin_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.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

פרמטרים

תגובה

מחזיר: SaveComment200Response

דוגמה

דוגמה ל-save_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 |

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

פרמטרים

תגובה

מחזיר: Array<SaveComment200Response>

דוגמה

דוגמה ל-save_comments_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' # מחרוזת |

14create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # מערך<CreateCommentParams> |

15opts = {

16 is_live: true, # בוליאני |

17 do_spam_check: true, # בוליאני |

18 send_emails: true, # בוליאני |

19 populate_notifications: true # בוליאני |

20}

21

22begin

23

24 result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)

25 p result

26rescue FastCommentsClient::ApiError => e

27 puts "Error when calling DefaultApi->save_comments_bulk: #{e}"

28end

29

פרמטרים

תגובה

מחזיר: SetCommentText200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה ל-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' # String |

14id = 'id_example' # String |

15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |

16opts = {

17 user_id: 'user_id_example', # String |

18 anon_user_id: 'anon_user_id_example' # String |

19}

20

21begin

22

23 result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)

24 p result

25rescue FastCommentsClient::ApiError => e

26 puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"

27end

28

פרמטרים

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה: un_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.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

פרמטרים

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

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

פרמטרים

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: AddDomainConfig200Response

דוגמה

דוגמה ל-add_domain_config

Copy

1

2require 'time'

3require 'fastcomments-client'

4# הגדרת הרשאה

5FastCommentsClient.configure do |config|

6 # קבע את הרשאת מפתח ה-API: api_key

7 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת המחדל: nil)

8 # config.api_key_prefix['x-api-key'] = 'Bearer'

9end

10

11api_instance = FastCommentsClient::DefaultApi.new

12tenant_id = 'tenant_id_example' # String |

13add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |

14

15begin

16

17 result = api_instance.add_domain_config(tenant_id, add_domain_config_params)

18 p result

19rescue FastCommentsClient::ApiError => e

20 puts "Error when calling DefaultApi->add_domain_config: #{e}"

21end

22

פרמטרים

תגובה

מחזיר: DeleteDomainConfig200Response

דוגמה

דוגמה ל-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 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)

9 # config.api_key_prefix['x-api-key'] = 'Bearer'

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14domain = 'domain_example' # String |

15

16begin

17

18 result = api_instance.delete_domain_config(tenant_id, domain)

19 p result

20rescue FastCommentsClient::ApiError => e

21 puts "Error when calling DefaultApi->delete_domain_config: #{e}"

22end

23

פרמטרים

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-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' # מחרוזת |

14domain = 'domain_example' # מחרוזת |

15

16begin

17

18 result = api_instance.get_domain_config(tenant_id, domain)

19 p result

20rescue FastCommentsClient::ApiError => e

21 puts "Error when calling DefaultApi->get_domain_config: #{e}"

22end

23

פרמטרים

תגובה

מחזיר: GetDomainConfigs200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: GetDomainConfig200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: CreateEmailTemplate200Response

דוגמה

דוגמה ל-create_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 |

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

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-delete_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 |

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

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל־delete_email_template_render_error

Copy

1

2require 'time'

3require 'fastcomments-client'

4# הגדרת אימות

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

7 config.api_key['x-api-key'] = 'YOUR API KEY'

8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)

9 # config.api_key_prefix['x-api-key'] = 'Bearer'

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14id = 'id_example' # String |

15error_id = 'error_id_example' # String |

16

17begin

18

19 result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)

20 p result

21rescue FastCommentsClient::ApiError => e

22 puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"

23end

24

פרמטרים

תגובה

מחזיר: GetEmailTemplate200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: GetEmailTemplateDefinitions200Response

דוגמה

דוגמה ל־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' # מחרוזת |

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

פרמטרים

תגובה

מחזיר: GetEmailTemplateRenderErrors200Response

דוגמה

דוגמה ל-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' # מחרוזת |

14id = 'id_example' # מחרוזת |

15opts = {

16 skip: 1.2 # מספר עשרוני |

17}

18

19begin

20

21 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)

22 p result

23rescue FastCommentsClient::ApiError => e

24 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"

25end

26

פרמטרים

תגובה

מחזיר: GetEmailTemplates200Response

דוגמה

דוגמה ל-get_email_templates

Copy

1

2require 'time'

3require 'fastcomments-client'

4# הגדרת הרשאה

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

7 config.api_key['x-api-key'] = 'YOUR API KEY'

8 # הסר את ההערה מהשורה הבאה כדי לקבוע קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל nil)

9 # config.api_key_prefix['x-api-key'] = 'Bearer'

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14opts = {

15 skip: 1.2 # Float |

16}

17

18begin

19

20 result = api_instance.get_email_templates(tenant_id, opts)

21 p result

22rescue FastCommentsClient::ApiError => e

23 puts "Error when calling DefaultApi->get_email_templates: #{e}"

24end

25

פרמטרים

תגובה

מחזיר: RenderEmailTemplate200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-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

req tenantId urlId userIdWS

פרמטרים

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-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 # מספר שלם |

10end_time = 789 # מספר שלם |

11

12begin

13

14 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)

15 p result

16rescue FastCommentsClient::ApiError => e

17 puts "Error when calling PublicApi->get_event_log: #{e}"

18end

19

req tenantId urlId userIdWS

פרמטרים

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה של get_global_event_log

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7url_id = 'url_id_example' # String |

8user_id_ws = 'user_id_ws_example' # String |

9start_time = 789 # Integer |

10end_time = 789 # Integer |

11

12begin

13

14 result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)

15 p result

16rescue FastCommentsClient::ApiError => e

17 puts "Error when calling PublicApi->get_global_event_log: #{e}"

18end

19

פרמטרים

תגובה

מחזיר: CreateFeedPost200Response

דוגמה

דוגמה ל-create_feed_post

Copy

1

2require 'time'

3require 'fastcomments-client'

4# הגדרת אימות

5FastCommentsClient.configure do |config|

6 # הגדר אימות מפתח API: api_key

7 config.api_key['x-api-key'] = 'YOUR API KEY'

8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, למשל 'Bearer' (ברירת מחדל: nil)

9 # config.api_key_prefix['x-api-key'] = 'Bearer'

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |

15opts = {

16 broadcast_id: 'broadcast_id_example', # String |

17 is_live: true, # Boolean |

18 do_spam_check: true, # Boolean |

19 skip_dup_check: true # Boolean |

20}

21

22begin

23

24 result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)

25 p result

26rescue FastCommentsClient::ApiError => e

27 puts "Error when calling DefaultApi->create_feed_post: #{e}"

28end

29

פרמטרים

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-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

פרמטרים

תגובה

מחזיר: DeleteFeedPostPublic200Response

דוגמה

דוגמה ל-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

req tenantId afterId

פרמטרים

תגובה

מחזיר: GetFeedPosts200Response

דוגמה

דוגמה ל-get_feed_posts

Copy

1

2require 'time'

3require 'fastcomments-client'

4# הגדרת אימות

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

7 config.api_key['x-api-key'] = 'YOUR API KEY'

8 # הסר את ההערה מהשורה הבאה כדי להגדיר קידומת למפתח ה-API, לדוגמה 'Bearer' (ברירת מחדל: nil)

9 # config.api_key_prefix['x-api-key'] = 'Bearer'

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14opts = {

15 after_id: 'after_id_example', # String |

16 limit: 56, # Integer |

17 tags: ['inner_example'] # Array<String> |

18}

19

20begin

21

22 result = api_instance.get_feed_posts(tenant_id, opts)

23 p result

24rescue FastCommentsClient::ApiError => e

25 puts "Error when calling DefaultApi->get_feed_posts: #{e}"

26end

27