FastComments.com

FastComments SDK για Ruby

Αυτό είναι το επίσημο Ruby SDK για το FastComments.

Επίσημο Ruby SDK για το API του FastComments

Αποθετήριο

Προβολή στο GitHub


Installation Internal Link

Add this line to your application's Gemfile:

gem 'fastcomments'

And then execute:

bundle install

Or install it yourself as:

gem install fastcomments

Library Contents

Αυτή η βιβλιοθήκη περιέχει τον παραγόμενο πελάτη API και τα εργαλεία SSO για να διευκολύνουν τη χρήση του API.

Public vs Secured APIs

Για τον πελάτη API, υπάρχουν τρεις κλάσεις, DefaultApi, PublicApi και ModerationApi. Η DefaultApi περιέχει μεθόδους που απαιτούν το κλειδί API σας, η PublicApi περιλαμβάνει κλήσεις API που μπορούν να γίνουν απευθείας από πρόγραμμα περιήγησης/συσκευή κινητής κ.λπ. χωρίς έλεγχο ταυτότητας. Η ModerationApi περιέχει τις μεθόδους που τροφοδοτούν τον πίνακα ελέγχου του συντονιστή.

Η ModerationApi προσφέρει ένα εκτενές σύνολο ζωντανών και γρήγορων API συντονισμού. Κάθε μέθοδος ModerationApi δέχεται ένα παράμετρο sso και μπορεί να πιστοποιηθεί μέσω SSO ή ενός cookie συνεδρίας FastComments.com.

Quick Start Internal Link

Χρήση Πιστοποιημένων API (DefaultApi)

Σημαντικό: Πρέπει να ορίσετε το κλειδί API σας στο ApiClient πριν κάνετε αιτήματα με πιστοποίηση. Εάν δεν το κάνετε, τα αιτήματα θα αποτύχουν με σφάλμα 401.

require 'fastcomments'

# Create and configure the API client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Create the API instance with the configured client
api = FastCommentsClient::DefaultApi.new(api_client)

# Now you can make authenticated API calls
begin
  # Example: Add an SSO user
  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}"
  # Common errors:
  # - 401: API key is missing or invalid
  # - 400: Request validation failed
end

Χρήση Δημόσιων API (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
  # Example: List comments in the moderation queue
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Κοινά Προβλήματα

  1. 401 "missing-api-key" error: Βεβαιωθείτε ότι έχετε ορίσει config.api_key['x-api-key'] = 'YOUR_KEY' πριν δημιουργήσετε την παρουσία DefaultApi.
  2. Wrong API class: Χρησιμοποιήστε DefaultApi για αιτήματα διακομιστή με πιστοποίηση, PublicApi για αιτήματα πελάτη/δημόσια, και ModerationApi για αιτήματα πίνακα ελέγχου συντονιστή.
  3. Null API key: Το SDK θα παραλείψει σιωπηλά την πιστοποίηση αν το κλειδί API είναι κενό, οδηγώντας σε σφάλματα 401.

Notes Internal Link

Αναγνωριστικά Broadcast

Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε ορισμένες κλήσεις API. Όταν λαμβάνετε συμβάντα, θα λάβετε αυτό το ID πίσω, οπότε θα γνωρίζετε να αγνοήσετε το συμβάν αν σκοπεύετε να εφαρμόσετε αλλαγές "optimistically" στον πελάτη (κάτι που πιθανότατα θα θέλετε να κάνετε, καθώς προσφέρει την καλύτερη εμπειρία). Περάστε ένα UUID εδώ. Το ID θα πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μια συνεδρία προγράμματος περιήγησης.

SSO (Ενιαία Σύνδεση)

Για παραδείγματα SSO, δείτε παρακάτω.

SSO Usage Internal Link

Απλό SSO

require 'fastcomments'

# Δημιουργία διακριτικού Simple 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}"

Ασφαλές SSO

require 'fastcomments'

# Δημιουργία διακριτικού Secure 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 Internal Link

Συγκεντρώνει έγγραφα ομαδοποιώντας τα (αν παρέχεται το groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες. Υποστηρίζονται διαφορετικές λειτουργίες (π.χ. sum, countDistinct, avg, κ.λπ.).

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
parentTenantIdstringqueryΌχι
includeStatsbooleanqueryΌχι

Απόκριση

Επιστρέφει: AggregateResponse

Παράδειγμα

Παράδειγμα aggregate
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Ρύθμιση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (εξ ορισμού nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |
15opts = {
16 parent_tenant_id: 'parent_tenant_id_example', # String |
17 include_stats: true # Boolean |
18}
19
20begin
21
22 result = api_instance.aggregate(tenant_id, aggregation_request, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->aggregate: #{e}"
26end
27

get_audit_logs Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
limitnumberqueryΌχι
skipnumberqueryΌχι
orderstringqueryΌχι
afternumberqueryΌχι
beforenumberqueryΌχι

Απόκριση

Επιστρέφει: GetAuditLogsResponse

Παράδειγμα

Παράδειγμα get_audit_logs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα logout_public
Copy 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 Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: BlockSuccess

Παράδειγμα

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

un_block_comment_public Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
commentIdstringpathΝαι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: UnblockSuccess

Παράδειγμα

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

checked_comments_for_blocked Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdsstringqueryΝαιΜια λίστα αναγνωριστικών σχολίων, χωρισμένων με κόμμα.
ssostringqueryΌχι

Απόκριση

Επιστρέφει: CheckBlockedCommentsResponse

Παράδειγμα

Παράδειγμα checked_comments_for_blocked
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_ids = 'comment_ids_example' # String | Μια λίστα αναγνωριστικών σχολίων, χωρισμένων με κόμμα.
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
18end
19

block_user_from_comment Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
userIdstringqueryΌχι
anonUserIdstringqueryΌχι

Απόκριση

Επιστρέφει: BlockSuccess

Παράδειγμα

Παράδειγμα block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης API κλειδιού: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο στην παρακάτω γραμμή για να ορίσετε πρόθεμα για το API κλειδί, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
27end
28

create_comment_public Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
urlIdstringqueryΝαι
broadcastIdstringqueryΝαι
sessionIdstringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: SaveCommentsResponseWithPresence

Παράδειγμα

Παράδειγμα create_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Συμβολοσειρά |
7url_id = 'url_id_example' # Συμβολοσειρά |
8broadcast_id = 'broadcast_id_example' # Συμβολοσειρά |
9comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData |
10opts = {
11 session_id: 'session_id_example', # Συμβολοσειρά |
12 sso: 'sso_example' # Συμβολοσειρά |
13}
14
15begin
16
17 result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->create_comment_public: #{e}"
21end
22

delete_comment Internal Link

Parameters

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
contextUserIdstringqueryΌχι
isLivebooleanqueryΌχι

Απόκριση

Επιστρέφει: DeleteCommentResult

Παράδειγμα

Παράδειγμα delete_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 context_user_id: 'context_user_id_example', # String |
17 is_live: true # Boolean |
18}
19
20begin
21
22 result = api_instance.delete_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_comment: #{e}"
26end
27

delete_comment_public Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΝαι
editKeystringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: PublicAPIDeleteCommentResponse

Παράδειγμα

Παράδειγμα delete_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Συμβολοσειρά |
7comment_id = 'comment_id_example' # Συμβολοσειρά |
8broadcast_id = 'broadcast_id_example' # Συμβολοσειρά |
9opts = {
10 edit_key: 'edit_key_example', # Συμβολοσειρά |
11 sso: 'sso_example' # Συμβολοσειρά |
12}
13
14begin
15
16 result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->delete_comment_public: #{e}"
20end
21

delete_comment_vote Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΥποχρεωτικόΠεριγραφή
tenantIdstringpathΝαι
commentIdstringpathΝαι
voteIdstringpathΝαι
urlIdstringqueryΝαι
broadcastIdstringqueryΝαι
editKeystringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: VoteDeleteResponse

Παράδειγμα

Παράδειγμα delete_comment_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
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 Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
userIdstringqueryΌχι
anonUserIdstringqueryΌχι

Απόκριση

Επιστρέφει: FlagCommentResponse

Παράδειγμα

flag_comment Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμορφώστε την εξουσιοδότηση με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->flag_comment: #{e}"
26end
27

get_comment Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIGetCommentResponse

Παράδειγμα

Παράδειγμα get_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_comment(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_comment: #{e}"
22end
23

get_comment_text Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
commentIdstringpathΝαι
editKeystringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: PublicAPIGetCommentTextResponse

Παράδειγμα

Παράδειγμα get_comment_text
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 edit_key: 'edit_key_example', # String |
10 sso: 'sso_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

Απόκριση

Επιστρέφει: GetCommentVoteUserNamesSuccessResponse

Παράδειγμα

Παράδειγμα get_comment_vote_user_names
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Συμβολοσειρά |
7comment_id = 'comment_id_example' # Συμβολοσειρά |
8dir = 56 # Ακέραιος |
9opts = {
10 sso: 'sso_example' # Συμβολοσειρά |
11}
12
13begin
14
15 result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
19end
20

get_comments Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
pageintegerqueryΌχι
limitintegerqueryΌχι
skipintegerqueryΌχι
asTreebooleanqueryΌχι
skipChildrenintegerqueryΌχι
limitChildrenintegerqueryΌχι
maxTreeDepthintegerqueryΌχι
urlIdstringqueryΌχι
userIdstringqueryΌχι
anonUserIdstringqueryΌχι
contextUserIdstringqueryΌχι
hashTagstringqueryΌχι
parentIdstringqueryΌχι
directionstringqueryΌχι
fromDateintegerqueryΌχι
toDateintegerqueryΌχι

Απάντηση

Επιστρέφει: APIGetCommentsResponse

Παράδειγμα

Παράδειγμα get_comments
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 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 Internal Link

req tenantId urlId

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
urlIdstringqueryΝαι
pageintegerqueryΌχι
directionstringqueryΌχι
ssostringqueryΌχι
skipintegerqueryΌχι
skipChildrenintegerqueryΌχι
limitintegerqueryΌχι
limitChildrenintegerqueryΌχι
countChildrenbooleanqueryΌχι
fetchPageForCommentIdstringqueryΌχι
includeConfigbooleanqueryΌχι
countAllbooleanqueryΌχι
includei10nbooleanqueryΌχι
localestringqueryΌχι
modulesstringqueryΌχι
isCrawlerbooleanqueryΌχι
includeNotificationCountbooleanqueryΌχι
asTreebooleanqueryΌχι
maxTreeDepthintegerqueryΌχι
useFullTranslationIdsbooleanqueryΌχι
parentIdstringqueryΌχι
searchTextstringqueryΌχι
hashTagsarrayqueryΌχι
userIdstringqueryΌχι
customConfigStrstringqueryΌχι
afterCommentIdstringqueryΌχι
beforeCommentIdstringqueryΌχι

Απόκριση

Επιστρέφει: GetCommentsResponseWithPresencePublicComment

Παράδειγμα

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

lock_comment Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

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

pin_comment Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΝαι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: ChangeCommentPinStatusResponse

Παράδειγμα

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

save_comment Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
isLivebooleanqueryΌχι
doSpamCheckbooleanqueryΌχι
sendEmailsbooleanqueryΌχι
populateNotificationsbooleanqueryΌχι

Απόκριση

Επιστρέφει: APISaveCommentResponse

Παράδειγμα

Παράδειγμα save_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (εξ ορισμού nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comment(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comment: #{e}"
28end
29

save_comments_bulk Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
isLivebooleanqueryΌχι
doSpamCheckbooleanqueryΌχι
sendEmailsbooleanqueryΌχι
populateNotificationsbooleanqueryΌχι

Απάντηση

Επιστρέφει: SaveCommentsBulkResponse

Παράδειγμα

Παράδειγμα save_comments_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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'})] # 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΝαι
editKeystringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: PublicAPISetCommentTextResponse

Παράδειγμα

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

un_block_user_from_comment Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
userIdstringqueryΌχι
anonUserIdstringqueryΌχι

Απόκριση

Επιστρέφει: UnblockSuccess

Παράδειγμα

Παράδειγμα un_block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Ρύθμιση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
27end
28

un_flag_comment Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
userIdstringqueryΌχι
anonUserIdstringqueryΌχι

Απόκριση

Επιστρέφει: FlagCommentResponse

Παράδειγμα

Παράδειγμα un_flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης API κλειδιού: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

un_lock_comment Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: ChangeCommentPinStatusResponse

Παράδειγμα

Παράδειγμα un_pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.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 Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
contextUserIdstringqueryΌχι
doSpamCheckbooleanqueryΌχι
isLivebooleanqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams |
16opts = {
17 context_user_id: 'context_user_id_example', # String |
18 do_spam_check: true, # Boolean |
19 is_live: true # Boolean |
20}
21
22begin
23
24 result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->update_comment: #{e}"
28end
29

vote_comment Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
commentIdstringpathΝαι
urlIdstringqueryΝαι
broadcastIdstringqueryΝαι
sessionIdstringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: VoteResponse

Παράδειγμα

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

get_comments_for_user Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
userIdstringqueryΌχι
directionstringqueryΌχι
repliesToUserIdstringqueryΌχι
pagenumberqueryΌχι
includei10nbooleanqueryΌχι
localestringqueryΌχι
isCrawlerbooleanqueryΌχι

Απόκριση

Επιστρέφει: GetCommentsForUserResponse

Παράδειγμα

Παράδειγμα get_comments_for_user
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαραίτητοΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: AddDomainConfigResponse

Παράδειγμα

Παράδειγμα add_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. 'Bearer' (η προεπιλογή είναι nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
domainstringpathΝαι

Απόκριση

Επιστρέφει: DeleteDomainConfigResponse

Παράδειγμα

Παράδειγμα delete_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
domainstringpathΝαι

Απόκριση

Επιστρέφει: GetDomainConfigResponse

Παράδειγμα

Παράδειγμα get_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
8 # config.api_key_prefix['x-api-key'] = 'Bearer'
9end
10
11api_instance = FastCommentsClient::DefaultApi.new
12tenant_id = 'tenant_id_example' # String |
13domain = 'domain_example' # String |
14
15begin
16
17 result = api_instance.get_domain_config(tenant_id, domain)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_domain_config: #{e}"
21end
22

get_domain_configs Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: GetDomainConfigsResponse

Παράδειγμα

Παράδειγμα get_domain_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_domain_configs(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_domain_configs: #{e}"
21end
22

patch_domain_config Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
domainToUpdatestringpathΝαι

Απόκριση

Επιστρέφει: PatchDomainConfigResponse

Παράδειγμα

Παράδειγμα patch_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
domainToUpdatestringpathΝαι

Απόκριση

Επιστρέφει: PutDomainConfigResponse

Παράδειγμα

Παράδειγμα put_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams |
16
17begin
18
19 result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->put_domain_config: #{e}"
23end
24

create_email_template Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateEmailTemplateResponse

Παράδειγμα

Παράδειγμα create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιασμός της παρακάτω γραμμής για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody |
15
16begin
17
18 result = api_instance.create_email_template(tenant_id, create_email_template_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_email_template: #{e}"
22end
23

delete_email_template Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα delete_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
errorIdstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα delete_email_template_render_error
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςLocationΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetEmailTemplateResponse

Παράδειγμα

Παράδειγμα get_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαTypeLocationΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: GetEmailTemplateDefinitionsResponse

Παράδειγμα

Παράδειγμα get_email_template_definitions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαραίτητοΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetEmailTemplateRenderErrorsResponse

Παράδειγμα

Παράδειγμα get_email_template_render_errors
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetEmailTemplatesResponse

Παράδειγμα

Παράδειγμα get_email_templates
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
localestringqueryΌχι

Απόκριση

Επιστρέφει: RenderEmailTemplateResponse

Παράδειγμα

Παράδειγμα render_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολίασε την παρακάτω γραμμή για να ορίσεις ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (η προεπιλογή είναι nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody |
16
17begin
18
19 result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_email_template: #{e}"
23end
24

get_event_log Internal Link

req tenantId urlId userIdWS

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
urlIdstringqueryΝαι
userIdWSstringqueryΝαι
startTimeintegerqueryΝαι
endTimeintegerqueryΌχι

Απόκριση

Επιστρέφει: GetEventLogResponse

Παράδειγμα

Παράδειγμα get_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8user_id_ws = 'user_id_ws_example' # String |
9start_time = 789 # Integer |
10opts = {
11 end_time: 789 # Integer |
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 Internal Link

req tenantId urlId userIdWS

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
urlIdstringqueryΝαι
userIdWSstringqueryΝαι
startTimeintegerqueryΝαι
endTimeintegerqueryΌχι

Απόκριση

Επιστρέφει: GetEventLogResponse

Παράδειγμα

Παράδειγμα για get_global_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8user_id_ws = 'user_id_ws_example' # String |
9start_time = 789 # Integer |
10opts = {
11 end_time: 789 # Integer |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
broadcastIdstringqueryΌχι
isLivebooleanqueryΌχι
doSpamCheckbooleanqueryΌχι
skipDupCheckbooleanqueryΌχι

Απόκριση

Επιστρέφει: CreateFeedPostsResponse

Παράδειγμα

Παράδειγμα create_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
15opts = {
16 broadcast_id: 'broadcast_id_example', # String |
17 is_live: true, # Boolean |
18 do_spam_check: true, # Boolean |
19 skip_dup_check: true # Boolean |
20}
21
22begin
23
24 result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->create_feed_post: #{e}"
28end
29

create_feed_post_public Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: CreateFeedPostResponse

Παράδειγμα

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

delete_feed_post_public Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
postIdstringpathΝαι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: DeleteFeedPostPublicResponse

Παράδειγμα

Παράδειγμα delete_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
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 Internal Link

req tenantId afterId

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
afterIdstringqueryΌχι
limitintegerqueryΌχι
tagsarrayqueryΌχι

Απόκριση

Επιστρέφει: GetFeedPostsResponse

Παράδειγμα

Παράδειγμα get_feed_posts
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (εξ ορισμού: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 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 Internal Link

req tenantId afterId

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
afterIdstringqueryΌχι
limitintegerqueryΌχι
tagsarrayqueryΌχι
ssostringqueryΌχι
isCrawlerbooleanqueryΌχι
includeUserInfobooleanqueryΌχι

Απόκριση

Επιστρέφει: PublicFeedPostsResponse

Παράδειγμα

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

get_feed_posts_stats Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
postIdsarrayqueryΝαι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: FeedPostsStatsResponse

Παράδειγμα

Παράδειγμα get_feed_posts_stats
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_ids = ['inner_example'] # Array<String> |
8opts = {
9 sso: 'sso_example' # String |
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 Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
postIdsarrayqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: UserReactsResponse

Παράδειγμα

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

react_feed_post_public Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
postIdstringpathΝαι
isUndobooleanqueryΌχι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: ReactFeedPostResponse

Παράδειγμα

Παράδειγμα react_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
postIdstringpathΝαι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: CreateFeedPostResponse

Παράδειγμα

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

flag_comment_public Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
isFlaggedbooleanqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

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

get_gif_large Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
largeInternalURLSanitizedstringqueryΝαι

Απόκριση

Επιστρέφει: GifGetLargeResponse

Παράδειγμα

get_gif_large Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7large_internal_url_sanitized = 'large_internal_url_sanitized_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
searchstringqueryΝαι
localestringqueryΌχι
ratingstringqueryΌχι
pagenumberqueryΌχι

Απόκριση

Επιστρέφει: GetGifsSearchResponse

Παράδειγμα

Παράδειγμα get_gifs_search
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Συμβολοσειρά |
7search = 'search_example' # Συμβολοσειρά |
8opts = {
9 locale: 'locale_example', # Συμβολοσειρά |
10 rating: 'rating_example', # Συμβολοσειρά |
11 page: 1.2 # Πραγματικός αριθμός |
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

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
localestringqueryΌχι
ratingstringqueryΌχι
pagenumberqueryΌχι

Απόκριση

Επιστρέφει: GetGifsTrendingResponse

Παράδειγμα

Παράδειγμα get_gifs_trending
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Συμβολοσειρά |
7opts = {
8 locale: 'locale_example', # Συμβολοσειρά |
9 rating: 'rating_example', # Συμβολοσειρά |
10 page: 1.2 # Δεκαδικός |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απάντηση

Επιστρέφει: CreateHashTagResponse

Παράδειγμα

add_hash_tag Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
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 "Error when calling DefaultApi->add_hash_tag: #{e}"
22end
23

add_hash_tags_bulk Internal Link

Parameters

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Response

Επιστρέφει: BulkCreateHashTagsResponse

Example

Παράδειγμα add_hash_tags_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Απενεργοποιήστε το σχόλιο στην επόμενη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
tagstringpathYes

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

delete_hash_tag Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Ξεσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
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 "Error when calling DefaultApi->delete_hash_tag: #{e}"
23end
24

get_hash_tags Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
pagenumberqueryΌχι

Απόκριση

Επιστρέφει: GetHashTagsResponse

Παράδειγμα

Παράδειγμα get_hash_tags
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολίασε την παρακάτω γραμμή για να ορίσεις ένα πρόθεμα για το API key, π.χ. '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: 1.2 # Float |
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 Internal Link

Parameters

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
tagstringpathΝαι

Απάντηση

Επιστρέφει: UpdateHashTagResponse

Παράδειγμα

patch_hash_tag Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Ρύθμιση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Απενεργοποιήστε το σχόλιο στην παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
voteIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Απάντηση

Επιστρέφει: VoteDeleteResponse

Παράδειγμα

delete_moderation_vote Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
pagenumberqueryNo
countnumberqueryNo
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: ModerationAPIGetCommentsResponse

Παράδειγμα

Παράδειγμα get_api_comments
Copy 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 Internal Link

Parameters

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
batchJobIdstringqueryNo
ssostringqueryNo

Response

Επιστρέφει: ModerationExportStatusResponse

Example

Παράδειγμα get_api_export_status
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: ModerationAPIGetCommentIdsResponse

Παράδειγμα

Παράδειγμα get_api_ids
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Απόκριση

Επιστρέφει: GetBannedUsersFromCommentResponse

Παράδειγμα

Παράδειγμα get_ban_users_from_comment
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Απάντηση

Επιστρέφει: GetCommentBanStatusResponse

Παράδειγμα

Παράδειγμα get_comment_ban_status
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Απόκριση

Επιστρέφει: ModerationAPIChildCommentsResponse

Παράδειγμα

get_comment_children Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
snostringqueryNo

Απόκριση

Επιστρέφει: ModerationAPICountCommentsResponse

Παράδειγμα

Παράδειγμα get_count
Copy 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 "Σφάλμα κατά την κλήση του ModerationApi->get_count: #{e}"
22end
23

get_counts Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: GetBannedUsersCountResponse

Παράδειγμα

Παράδειγμα get_counts
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: ModerationAPIGetLogsResponse

Παράδειγμα

Παράδειγμα get_logs
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
ssostringqueryNo

Απόκριση

Επιστρέφει: GetTenantManualBadgesResponse

Παράδειγμα

get_manual_badges Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: GetUserManualBadgesResponse

Παράδειγμα

get_manual_badges_for_user Παράδειγμα
Copy 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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

Απάντηση

Επιστρέφει: ModerationAPICommentResponse

Παράδειγμα

Παράδειγμα get_moderation_comment
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: GetCommentTextResponse

Παράδειγμα

get_moderation_comment_text Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringερώτημαΝαι
commentIdstringδιαδρομήΝαι
includeByUserIdAndEmailbooleanερώτημαΌχι
includeByIPbooleanερώτημαΌχι
includeByEmailDomainbooleanερώτημαΌχι
ssostringερώτημαΌχι

Απόκριση

Επιστρέφει: PreBanSummary

Παράδειγμα

get_pre_ban_summary Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

Απάντηση

Επιστρέφει: ModerationCommentSearchResponse

Παράδειγμα

Παράδειγμα get_search_comments_summary
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
valuestringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: ModerationPageSearchResponse

Παράδειγμα

Παράδειγμα get_search_pages
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
valuestringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: ModerationSiteSearchResponse

Παράδειγμα

Παράδειγμα get_search_sites
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
text-searchstringqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: ModerationSuggestResponse

Παράδειγμα

Παράδειγμα get_search_suggest
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
valuestringqueryΌχι
ssostringqueryΌχι

Απόκριση

Returns: ModerationUserSearchResponse

Παράδειγμα

get_search_users Παράδειγμα
Copy 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_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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: GetUserTrustFactorResponse

Παράδειγμα

get_trust_factor Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: APIModerateGetUserBanPreferencesResponse

Παράδειγμα

get_user_ban_preference Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: GetUserInternalProfileResponse

Παράδειγμα

get_user_internal_profile Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 comment_id: 'comment_id_example', # String |
9 sso: 'sso_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: AdjustVotesResponse

Παράδειγμα

post_adjust_comment_votes Παράδειγμα
Copy 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 Internal Link

Parameters

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
text-searchstringqueryΌχι
byIPFromCommentstringqueryΌχι
filtersstringqueryΌχι
searchFiltersstringqueryΌχι
sortsstringqueryΌχι
ssostringqueryΌχι

Response

Επιστρέφει: ModerationExportResponse

Παράδειγμα

post_api_export Παράδειγμα
Copy 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 sorts: 'sorts_example', # String |
13 sso: 'sso_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: BanUserFromCommentResult

Παράδειγμα

Παράδειγμα post_ban_user_from_comment
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

post_ban_user_undo Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: BulkPreBanSummary

Παράδειγμα

post_bulk_pre_ban_summary Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # Συμβολοσειρά |
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' # Συμβολοσειρά |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: ModerationAPIChildCommentsResponse

Παράδειγμα

post_comments_by_ids Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

post_flag_comment Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: PostRemoveCommentApiResponse

Παράδειγμα

post_remove_comment Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

post_restore_deleted_comment Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
approvedbooleanqueryΌχι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: SetCommentApprovedResponse

Παράδειγμα

post_set_comment_approval_status Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
reviewedbooleanqueryΌχι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

post_set_comment_review_status Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
spambooleanqueryNo
permNotSpambooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

post_set_comment_spam_status Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: SetCommentTextResponse

Παράδειγμα

post_set_comment_text Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα post_un_flag_comment
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringpathΝαι
directionstringqueryΌχι
broadcastIdstringqueryΌχι
ssostringqueryΌχι

Απάντηση

Επιστρέφει: VoteResponse

Παράδειγμα

post_vote Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: AwardUserBadgeResponse

Παράδειγμα

Παράδειγμα put_award_badge
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

put_close_thread Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Απάντηση

Επιστρέφει: RemoveUserBadgeResponse

Παράδειγμα

put_remove_badge Παράδειγμα
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα put_reopen_thread
Copy 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_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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Απόκριση

Επιστρέφει: SetUserTrustFactorResponse

Παράδειγμα

set_trust_factor Παράδειγμα
Copy 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 Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateModeratorResponse

Παράδειγμα

create_moderator Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
sendEmailstringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

delete_moderator Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης: 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetModeratorResponse

Παράδειγμα

Παράδειγμα get_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetModeratorsResponse

Παράδειγμα

Παράδειγμα get_moderators
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Κατάργηση σχολιασμού της παρακάτω γραμμής για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_moderators(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_moderators: #{e}"
24end
25

send_invite Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
fromNamestringqueryΝαι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα send_invite
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

update_moderator Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα delete_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetCachedNotificationCountResponse

Παράδειγμα

Παράδειγμα get_cached_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΌχι
urlIdstringqueryΌχι
fromCommentIdstringqueryΌχι
viewedbooleanqueryΌχι
typestringqueryΌχι

Απόκριση

Επιστρέφει: GetNotificationCountResponse

Παράδειγμα

Παράδειγμα get_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example' # String |
20}
21
22begin
23
24 result = api_instance.get_notification_count(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_notification_count: #{e}"
28end
29

get_notifications Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΌχι
urlIdstringqueryΌχι
fromCommentIdstringqueryΌχι
viewedbooleanqueryΌχι
typestringqueryΌχι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetNotificationsResponse

Παράδειγμα

Παράδειγμα get_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_notifications(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_notifications: #{e}"
29end
30

update_notification Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_notification
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_notification: #{e}"
26end
27

create_v1_page_react Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
urlIdstringqueryΝαι
titlestringqueryΌχι

Απόκριση

Επιστρέφει: CreateV1PageReact

Παράδειγμα

Παράδειγμα create_v1_page_react
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
urlIdstringqueryΝαι
idstringqueryΝαι
titlestringqueryΌχι

Απόκριση

Επιστρέφει: CreateV1PageReact

Παράδειγμα

Παράδειγμα create_v2_page_react
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
urlIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateV1PageReact

Παράδειγμα

delete_v1_page_react Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
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 Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
urlIdstringqueryΝαι
idstringqueryΝαι

Απόκριση

Επιστρέφει: CreateV1PageReact

Παράδειγμα

delete_v2_page_react Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8id = 'id_example' # String |
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 Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
urlIdstringqueryΝαι

Απόκριση

Επιστρέφει: GetV1PageLikes

Παράδειγμα

Παράδειγμα get_v1_page_likes
Copy 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
urlIdstringqueryΝαι
idstringqueryΝαι

Απόκριση

Επιστρέφει: GetV2PageReactUsersResponse

Παράδειγμα

Παράδειγμα get_v2_page_react_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8id = 'id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
urlIdstringqueryΝαι

Απάντηση

Επιστρέφει: GetV2PageReacts

Παράδειγμα

Παράδειγμα get_v2_page_reacts
Copy 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_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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: AddPageAPIResponse

Παράδειγμα

add_page Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData |
15
16begin
17
18 result = api_instance.add_page(tenant_id, create_api_page_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_page: #{e}"
22end
23

delete_page Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: DeletePageAPIResponse

Παράδειγμα

Παράδειγμα delete_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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 Internal Link

Προηγούμενοι σχολιαστές στη σελίδα που ΔΕΝ είναι αυτήν τη στιγμή online. Ταξινομημένοι κατά displayName. Χρησιμοποιήστε αυτό αφού εξαντληθεί το /users/online για να εμφανίσετε μια ενότητα «Μέλη». Σελιδοποίηση με δρομέα στο commenterName: ο server διασχίζει τον μερικό δείκτη {tenantId, urlId, commenterName} από afterName προς τα εμπρός μέσω του $gt, χωρίς κόστος $skip.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesΑναγνωριστικό URL σελίδας (καθαρίζεται από τον server).
afterNamestringqueryNoΔρομέας: περάστε το nextAfterName από την προηγούμενη απάντηση.
afterUserIdstringqueryNoΔιαιρέτης ισοπαλίας δρομέα: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν έχει οριστεί το afterName ώστε οι ισοπαλίες ονομάτων να μην αποκλείουν εγγραφές.

Response

Returns: PageUsersOfflineResponse

Example

Παράδειγμα get_offline_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String | Αναγνωριστικό URL σελίδας (καθαρίζεται από τον server).
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 Internal Link


Αυτήν τη στιγμή online θεατές μιας σελίδας: άτομα των οποίων η websocket συνεδρία είναι εγγεγραμμένη στη σελίδα αυτή τώρα. Επιστρέφει anonCount + totalCount (συνδρομητές σε ολόκληρο το δωμάτιο, συμπεριλαμβανομένων των ανώνυμων θεατών που δεν απαριθμούμε).

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathΝαι
urlIdstringqueryΝαιΑναγνωριστικό URL σελίδας (καθαρίζεται από τον διακομιστή).
afterNamestringqueryΌχιΔείκτης (cursor): περάστε το nextAfterName από την προηγούμενη απάντηση.
afterUserIdstringqueryΌχιΔείκτης διάσπασης ισοβαθμίας: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν έχει οριστεί το afterName ώστε ισοβαθμίες ονομάτων να μην παραλείπουν εγγραφές.

Απόκριση

Επιστρέφει: PageUsersOnlineResponse

Παράδειγμα

Παράδειγμα get_online_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String | Αναγνωριστικό URL σελίδας (καθαρίζεται από τον διακομιστή).
8opts = {
9 after_name: 'after_name_example', # String | Δείκτης (cursor): περάστε το nextAfterName από την προηγούμενη απάντηση.
10 after_user_id: 'after_user_id_example' # String | Δείκτης διάσπασης ισοβαθμίας (tiebreaker): περάστε το 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
urlIdstringqueryΝαι

Απόκριση

Επιστρέφει: GetPageByURLIdAPIResponse

Παράδειγμα

Παράδειγμα get_page_by_urlid
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: GetPagesAPIResponse

Παράδειγμα

Παράδειγμα get_pages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Λίστα σελίδων για έναν tenant. Χρησιμοποιείται από τον επιτραπέζιο πελάτη FChat για να συμπληρώσει τη λίστα δωματίων του. Απαιτεί enableFChat να είναι true στην επιλυμένη προσαρμοσμένη ρύθμιση (custom config) για κάθε σελίδα. Οι σελίδες που απαιτούν SSO φιλτράρονται με βάση την πρόσβαση ομάδας του ζητούντος χρήστη.

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringpathYes
cursorstringqueryNoΑδιαφανές cursor σελιδοποίησης που επιστρέφεται ως nextCursor από προηγούμενο αίτημα. Συνδεδεμένο με το ίδιο sortBy.
limitintegerqueryNo1..200, προεπιλογή 50
qstringqueryNoΠροαιρετικό φίλτρο προθέματος τίτλου ανεξάρτητο από πεζά/κεφαλαία.
sortBystringqueryNoΣειρά ταξινόμησης. updatedAt (προεπιλογή, πρώτες οι νεότερες), commentCount (πρώτα οι σελίδες με τα περισσότερα σχόλια), ή title (αλφαβητικά).
hasCommentsbooleanqueryNoΑν true, επιστρέφει μόνο σελίδες με τουλάχιστον ένα σχόλιο.

Απόκριση

Επιστρέφει: GetPublicPagesResponse

Παράδειγμα

Παράδειγμα get_pages_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 cursor: 'cursor_example', # String | Αδιαφανές cursor σελιδοποίησης που επιστρέφεται ως `nextCursor` από προηγούμενο αίτημα. Συνδεδεμένο με το ίδιο `sortBy`.
9 limit: 56, # Integer | 1..200, προεπιλογή 50
10 q: 'q_example', # String | Προαιρετικό φίλτρο προθέματος τίτλου ανεξάρτητο από πεζά/κεφαλαία.
11 sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Σειρά ταξινόμησης. `updatedAt` (προεπιλογή, πρώτες οι νεότερες), `commentCount` (πρώτα οι σελίδες με τα περισσότερα σχόλια), ή `title` (αλφαβητικά).
12 has_comments: true # Boolean | Αν 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 Internal Link


Μαζικές πληροφορίες χρηστών για έναν tenant. Δεδομένων των userIds, επιστρέφει πληροφορίες εμφάνισης από User / SSOUser. Χρησιμοποιείται από το comment widget για να εμπλουτίσει χρήστες που μόλις εμφανίστηκαν μέσω ενός presence event. Δεν υπάρχει συμφραζόμενο σελίδας: η ιδιωτικότητα εφαρμόζεται ομοιόμορφα (τα ιδιωτικά προφίλ αποκρύπτονται).

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathYes
idsstringqueryYesuserIds διαχωρισμένα με κόμμα.

Απόκριση

Επιστρέφει: PageUsersInfoResponse

Παράδειγμα

Παράδειγμα get_users_info
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7ids = 'ids_example' # String | 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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι

Response

Επιστρέφει: PatchPageAPIResponse

Παράδειγμα

Παράδειγμα patch_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Καταργήστε το σχόλιο από την επόμενη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

delete_pending_webhook_event Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_pending_webhook_event(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
22end
23

get_pending_webhook_event_count Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
commentIdstringqueryΌχι
externalIdstringqueryΌχι
eventTypestringqueryΌχι
typestringqueryΌχι
domainstringqueryΌχι
attemptCountGTnumberqueryΌχι

Απόκριση

Επιστρέφει: GetPendingWebhookEventCountResponse

Παράδειγμα

Παράδειγμα get_pending_webhook_event_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
commentIdstringqueryΌχι
externalIdstringqueryΌχι
eventTypestringqueryΌχι
typestringqueryΌχι
domainstringqueryΌχι
attemptCountGTnumberqueryΌχι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetPendingWebhookEventsResponse

Παράδειγμα

get_pending_webhook_events Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateQuestionConfigResponse

Παράδειγμα

Παράδειγμα create_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody |
15
16begin
17
18 result = api_instance.create_question_config(tenant_id, create_question_config_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_config: #{e}"
22end
23

delete_question_config Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι

Response

Επιστρέφει: APIEmptyResponse

Example

Παράδειγμα delete_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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_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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetQuestionConfigResponse

Παράδειγμα

Παράδειγμα get_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetQuestionConfigsResponse

Παράδειγμα

Παράδειγμα get_question_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 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 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_question_configs(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_question_configs: #{e}"
24end
25

update_question_config Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateQuestionResultResponse

Παράδειγμα

Παράδειγμα create_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (εξ ορισμού nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody |
15
16begin
17
18 result = api_instance.create_question_result(tenant_id, create_question_result_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_result: #{e}"
22end
23

delete_question_result Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

delete_question_result Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23

get_question_result Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetQuestionResultResponse

Παράδειγμα

Παράδειγμα get_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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_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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryNo
userIdstringqueryNo
startDatestringqueryNo
questionIdstringqueryNo
questionIdsstringqueryNo
skipnumberqueryNo

Απόκριση

Επιστρέφει: GetQuestionResultsResponse

Παράδειγμα

Παράδειγμα get_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
questionIdstringqueryΌχι
questionIdsarrayqueryΌχι
urlIdstringqueryΌχι
timeBucketstringqueryΌχι
startDatestringqueryΌχι
forceRecalculatebooleanqueryΌχι

Απόκριση

Επιστρέφει: AggregateQuestionResultsResponse

Παράδειγμα

Παράδειγμα aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket |
19 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
20 force_recalculate: true # Boolean |
21}
22
23begin
24
25 result = api_instance.aggregate_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
29end
30

bulk_aggregate_question_results Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
forceRecalculatebooleanqueryΌχι

Απόκριση

Επιστρέφει: BulkAggregateQuestionResultsResponse

Παράδειγμα

Παράδειγμα bulk_aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (η προεπιλογή είναι nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest |
15opts = {
16 force_recalculate: true # Boolean |
17}
18
19begin
20
21 result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
25end
26

combine_comments_with_question_results Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
questionIdstringqueryΌχι
questionIdsarrayqueryΌχι
urlIdstringqueryΌχι
startDatestringqueryΌχι
forceRecalculatebooleanqueryΌχι
minValuenumberqueryΌχι
maxValuenumberqueryΌχι
limitnumberqueryΌχι

Απόκριση

Επιστρέφει: CombineQuestionResultsWithCommentsResponse

Παράδειγμα

Παράδειγμα combine_comments_with_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: AddSSOUserAPIResponse

Παράδειγμα

Παράδειγμα add_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData |
15
16begin
17
18 result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_sso_user: #{e}"
22end
23

delete_sso_user Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
deleteCommentsbooleanqueryΌχι
commentDeleteModestringqueryΌχι

Απόκριση

Επιστρέφει: DeleteSSOUserAPIResponse

Παράδειγμα

Παράδειγμα delete_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Καταργήστε το σχόλιο από την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
emailstringpathYes

Απόκριση

Επιστρέφει: GetSSOUserByEmailAPIResponse

Παράδειγμα

Παράδειγμα get_sso_user_by_email
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (εξ ορισμού nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14email = 'email_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_email(tenant_id, email)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
22end
23

get_sso_user_by_id Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetSSOUserByIdAPIResponse

Παράδειγμα

Παράδειγμα get_sso_user_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιασμός της παρακάτω γραμμής για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλεγμένο nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
22end
23

get_sso_users Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
skipintegerqueryΌχι

Απόκριση

Επιστρέφει: GetSSOUsersResponse

Παράδειγμα

Παράδειγμα get_sso_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
updateCommentsbooleanqueryΌχι

Απόκριση

Επιστρέφει: PatchSSOUserAPIResponse

Παράδειγμα

Παράδειγμα patch_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
updateCommentsbooleanqueryΌχι

Απόκριση

Επιστρέφει: PutSSOUserAPIResponse

Παράδειγμα

Παράδειγμα put_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απάντηση

Επιστρέφει: CreateSubscriptionAPIResponse

Παράδειγμα

Παράδειγμα create_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData |
15
16begin
17
18 result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_subscription: #{e}"
22end
23

delete_subscription Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαραίτητοΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
userIdstringqueryΌχι

Απόκριση

Επιστρέφει: DeleteSubscriptionAPIResponse

Παράδειγμα

Παράδειγμα delete_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_subscription(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_subscription: #{e}"
25end
26

get_subscriptions Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
userIdstringqueryΌχι

Απόκριση

Επιστρέφει: GetSubscriptionsAPIResponse

Παράδειγμα

Παράδειγμα get_subscriptions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example' # String |
16}
17
18begin
19
20 result = api_instance.get_subscriptions(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_subscriptions: #{e}"
24end
25

update_subscription Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαραίτητοΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
userIdstringqueryΌχι

Απόκριση

Επιστρέφει: UpdateSubscriptionAPIResponse

Παράδειγμα

Παράδειγμα update_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData |
16opts = {
17 user_id: 'user_id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
yearNumbernumberqueryΌχι
monthNumbernumberqueryΌχι
dayNumbernumberqueryΌχι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetTenantDailyUsagesResponse

Παράδειγμα

Παράδειγμα get_tenant_daily_usages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Ρύθμιση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateTenantPackageResponse

Παράδειγμα

Παράδειγμα create_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Ρύθμιση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχολιασμό της επόμενης γραμμής για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαραίτητοΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

delete_tenant_package Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link


Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetTenantPackageResponse

Παράδειγμα

Παράδειγμα get_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΥποχρεωτικόΠεριγραφή
tenantIdstringqueryΝαι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetTenantPackagesResponse

Παράδειγμα

get_tenant_packages Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολίασε την ακόλουθη γραμμή για να ορίσεις πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

replace_tenant_package Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο στην παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απάντηση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Απο-σχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateTenantUserResponse

Παράδειγμα

Παράδειγμα create_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API κλειδί, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody |
15
16begin
17
18 result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_user: #{e}"
22end
23

delete_tenant_user Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
deleteCommentsstringqueryΌχι
commentDeleteModestringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα delete_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetTenantUserResponse

Παράδειγμα

Παράδειγμα get_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Κατάργησε το σχόλιο από την παρακάτω γραμμή για να ορίσεις πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_user: #{e}"
22end
23

get_tenant_users Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΥποχρεωτικόΠεριγραφή
tenantIdstringqueryΝαι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetTenantUsersResponse

Παράδειγμα

Παράδειγμα get_tenant_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_users: #{e}"
24end
25

replace_tenant_user Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
updateCommentsstringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα replace_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
26end
27

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
redirectURLstringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα send_login_link
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Καταργήστε το σχόλιο από την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 redirect_url: 'redirect_url_example' # String |
17}
18
19begin
20
21 result = api_instance.send_login_link(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->send_login_link: #{e}"
25end
26

update_tenant_user Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
updateCommentsstringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link


Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateTenantResponse

Παράδειγμα

Παράδειγμα create_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Καταργήστε το σχολιασμό της παρακάτω γραμμής για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
surestringqueryΌχι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα delete_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetTenantResponse

Παράδειγμα

Παράδειγμα get_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
metastringqueryΌχι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: GetTenantsResponse

Παράδειγμα

Παράδειγμα get_tenants
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλεγμένο nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptyResponse

Παράδειγμα

Παράδειγμα update_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody |
16
17begin
18
19 result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant: #{e}"
23end
24

change_ticket_state Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: ChangeTicketStateResponse

Παράδειγμα

Παράδειγμα change_ticket_state
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΝαι

Απόκριση

Επιστρέφει: CreateTicketResponse

Παράδειγμα

Παράδειγμα create_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαTypeLocationΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι
userIdstringqueryΌχι

Απάντηση

Επιστρέφει: GetTicketResponse

Παράδειγμα

get_ticket Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμορφώστε την εξουσιοδότηση κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΌχι
statenumberqueryΌχι
skipnumberqueryΌχι
limitnumberqueryΌχι

Απόκριση

Επιστρέφει: GetTicketsResponse

Παράδειγμα

Παράδειγμα get_tickets
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
namespacestringpathΝαι
componentstringpathΝαι
localestringqueryΌχι
useFullTranslationIdsbooleanqueryΌχι

Response

Επιστρέφει: GetTranslationsResponse

Παράδειγμα

Παράδειγμα get_translations
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6namespace = 'namespace_example' # String |
7component = 'component_example' # String |
8opts = {
9 locale: 'locale_example', # String |
10 use_full_translation_ids: true # Boolean |
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 Internal Link

Μεταφόρτωση και αλλαγή μεγέθους εικόνας

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
sizePresetstringqueryΌχιΠροεπιλογή μεγέθους: "Default" (1000x1000px) ή "CrossPlatform" (δημιουργεί μεγέθη για δημοφιλείς συσκευές)
urlIdstringqueryΌχιID σελίδας από την οποία γίνεται η μεταφόρτωση, για διαμόρφωση

Απόκριση

Επιστρέφει: UploadImageResponse

Παράδειγμα

Παράδειγμα upload_image
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7file = File.new('/path/to/some/file') # File |
8opts = {
9 size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Προεπιλογή μεγέθους: \"Default\" (1000x1000px) ή \"CrossPlatform\" (δημιουργεί μεγέθη για δημοφιλείς συσκευές)
10 url_id: 'url_id_example' # String | ID σελίδας από την οποία γίνεται η μεταφόρτωση, για διαμόρφωση
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 Internal Link

Parameters

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIGetUserBadgeProgressResponse

Παράδειγμα

Παράδειγμα get_user_badge_progress_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Καταργήστε το σχόλιο στην επόμενη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringpathΝαι

Απάντηση

Επιστρέφει: APIGetUserBadgeProgressResponse

Παράδειγμα

Παράδειγμα get_user_badge_progress_by_user_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
22end
23

get_user_badge_progress_list Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΌχι
limitnumberqueryΌχι
skipnumberqueryΌχι

Απόκριση

Επιστρέφει: APIGetUserBadgeProgressListResponse

Παράδειγμα

get_user_badge_progress_list Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 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 Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι

Απόκριση

Επιστρέφει: APICreateUserBadgeResponse

Παράδειγμα

create_user_badge Παράδειγμα
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την επόμενη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Απόκριση

Επιστρέφει: APIEmptySuccessResponse

Παράδειγμα

Παράδειγμα delete_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
idstringpathYes

Απόκριση

Επιστρέφει: APIGetUserBadgeResponse

Παράδειγμα

Παράδειγμα get_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23

get_user_badges Internal Link

Parameters

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
userIdstringqueryΌχι
badgeIdstringqueryΌχι
typenumberqueryΌχι
displayedOnCommentsbooleanqueryΌχι
limitnumberqueryΌχι
skipnumberqueryΌχι

Response

Επιστρέφει: APIGetUserBadgesResponse

Παράδειγμα

Παράδειγμα get_user_badges
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης κλειδιού API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το κλειδί API, π.χ. 'Bearer' (προεπιλογή nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 badge_id: 'badge_id_example', # String |
17 type: 1.2, # Float |
18 displayed_on_comments: true, # Boolean |
19 limit: 1.2, # Float |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_user_badges(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_user_badges: #{e}"
29end
30

update_user_badge Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: APIEmptySuccessResponse

Παράδειγμα

Παράδειγμα update_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΘέσηΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: GetUserNotificationCountResponse

Παράδειγμα

Παράδειγμα για get_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
urlIdstringqueryΌχιΧρησιμοποιείται για να καθοριστεί αν η τρέχουσα σελίδα είναι εγγεγραμμένη.
pageSizeintegerqueryΌχι
afterIdstringqueryΌχι
includeContextbooleanqueryΌχι
afterCreatedAtintegerqueryΌχι
unreadOnlybooleanqueryΌχι
dmOnlybooleanqueryΌχι
noDmbooleanqueryΌχι
includeTranslationsbooleanqueryΌχι
includeTenantNotificationsbooleanqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: GetMyNotificationsResponse

Παράδειγμα

Παράδειγμα get_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 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 Internal Link


Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: ResetUserNotificationsResponse

Παράδειγμα

Παράδειγμα reset_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Συμβολοσειρά |
7opts = {
8 sso: 'sso_example' # Συμβολοσειρά |
9}
10
11begin
12
13 result = api_instance.reset_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
17end
18

reset_user_notifications Internal Link


Παράμετροι

ΌνομαTypeLocationΑπαραίτητοΠεριγραφή
tenantIdstringqueryΝαι
afterIdstringqueryΌχι
afterCreatedAtintegerqueryΌχι
unreadOnlybooleanqueryΌχι
dmOnlybooleanqueryΌχι
noDmbooleanqueryΌχι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: ResetUserNotificationsResponse

Παράδειγμα

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

update_user_notification_comment_subscription_status Internal Link

Ενεργοποιήστε ή απενεργοποιήστε τις ειδοποιήσεις για ένα συγκεκριμένο σχόλιο.

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
notificationIdstringpathΝαι
optedInOrOutstringpathΝαι
commentIdstringqueryΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: UpdateUserNotificationCommentSubscriptionStatusResponse

Παράδειγμα

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

update_user_notification_page_subscription_status Internal Link

Ενεργοποιήστε ή απενεργοποιήστε τις ειδοποιήσεις για μια σελίδα. Όταν οι χρήστες είναι εγγεγραμμένοι σε μια σελίδα, δημιουργούνται ειδοποιήσεις για νέα σχόλια ρίζας, και επίσης

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
urlIdstringqueryΝαι
urlstringqueryΝαι
pageTitlestringqueryΝαι
subscribedOrUnsubscribedstringpathΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: UpdateUserNotificationPageSubscriptionStatusResponse

Παράδειγμα

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

update_user_notification_status Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
notificationIdstringpathΝαι
newStatusstringpathΝαι
ssostringqueryΌχι

Απόκριση

Επιστρέφει: UpdateUserNotificationStatusResponse

Παράδειγμα

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

get_user_presence_statuses Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
urlIdWSstringqueryΝαι
userIdsstringqueryΝαι

Απόκριση

Επιστρέφει: GetUserPresenceStatusesResponse

Παράδειγμα

Παράδειγμα get_user_presence_statuses
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id_ws = 'url_id_ws_example' # String |
8user_ids = 'user_ids_example' # String |
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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringpathΝαι
urlIdstringqueryΝαι
usernameStartsWithstringqueryΌχι
mentionGroupIdsarrayqueryΌχι
ssostringqueryΌχι
searchSectionstringqueryΌχι

Απόκριση

Επιστρέφει: SearchUsersResult

Παράδειγμα

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

get_user Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
idstringpathΝαι

Απόκριση

Επιστρέφει: GetUserResponse

Παράδειγμα

Παράδειγμα get_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την ακόλουθη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
commentIdstringqueryΝαι
directionstringqueryΝαι
userIdstringqueryΌχι
anonUserIdstringqueryΌχι

Απόκριση

Επιστρέφει: VoteResponse

Παράδειγμα

Παράδειγμα create_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Απο-σχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

NameTypeLocationRequiredDescription
tenantIdstringqueryΝαι
idstringpathΝαι
editKeystringqueryΌχι

Απόκριση

Επιστρέφει: VoteDeleteResponse

Παράδειγμα

Παράδειγμα delete_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryYes
urlIdstringqueryYes

Απάντηση

Επιστρέφει: GetVotesResponse

Παράδειγμα

Παράδειγμα get_votes
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αφαιρέστε το σχόλιο από την επόμενη γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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 Internal Link

Παράμετροι

ΌνομαΤύποςΤοποθεσίαΑπαιτείταιΠεριγραφή
tenantIdstringqueryΝαι
urlIdstringqueryΝαι
userIdstringqueryΌχι
anonUserIdstringqueryΌχι

Απόκριση

Επιστρέφει: GetVotesForUserResponse

Παράδειγμα

Παράδειγμα get_votes_for_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# ρύθμιση εξουσιοδότησης
5FastCommentsClient.configure do |config|
6 # Διαμόρφωση εξουσιοδότησης με κλειδί API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Αποσχολιάστε την παρακάτω γραμμή για να ορίσετε ένα πρόθεμα για το API key, π.χ. '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

Χρειάζεστε βοήθεια;

Εάν αντιμετωπίσετε οποιαδήποτε προβλήματα ή έχετε ερωτήσεις σχετικά με το Ruby SDK, παρακαλούμε:

Συνεισφορά

Οι συνεισφορές είναι ευπρόσδεκτες! Παρακαλούμε επισκεφθείτε το αποθετήριο GitHub για οδηγίες συνεισφοράς.