FastComments.com

FastComments SDK per Ruby


Questo è l'SDK ufficiale Ruby per FastComments.

SDK Ruby ufficiale per l'API di FastComments

Repository

Visualizza su GitHub


Installazione Internal Link

Aggiungi questa riga al Gemfile della tua applicazione:

gem 'fastcomments'

E poi esegui:

bundle install

Oppure installalo manualmente con:

gem install fastcomments

Contenuti della libreria

Questa libreria contiene il client API generato e le utilità SSO per semplificare il lavoro con l'API.

API pubbliche vs API protette

Per il client API, ci sono due classi, DefaultApi e PublicApi. La DefaultApi contiene metodi che richiedono la tua chiave API, e la PublicApi contiene chiamate API che possono essere effettuate direttamente da un browser/dispositivo mobile/etc. senza autenticazione.

Avvio rapido Internal Link

Utilizzo delle API Autenticate (DefaultApi)

Importante: Devi impostare la tua chiave API su ApiClient prima di effettuare richieste autenticate. Se non lo fai, le richieste falliranno con un errore 401.

require 'fastcomments-client'

# Crea e configura il client API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# OBBLIGATORIO: Imposta la tua chiave API (prendila dalla tua dashboard FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Crea l'istanza API con il client configurato
api = FastCommentsClient::DefaultApi.new(api_client)

# Ora puoi effettuare chiamate API autenticate
begin
  # Esempio: Aggiungi un utente SSO
  user_data = {
    id: 'user-123',
    email: 'user@example.com',
    displayName: 'John Doe'
  }

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

rescue FastCommentsClient::ApiError => e
  puts "Error: #{e.response_body}"
  # Errori comuni:
  # - 401: la chiave API è mancante o non valida
  # - 400: la validazione della richiesta è fallita
end

Utilizzo delle API Pubbliche (PublicApi)

Gli endpoint pubblici non richiedono l'autenticazione:

require 'fastcomments-client'

public_api = FastCommentsClient::PublicApi.new

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

Problemi comuni

  1. Errore 401 "missing-api-key": Assicurati di impostare config.api_key['x-api-key'] = 'YOUR_KEY' prima di creare l'istanza DefaultApi.
  2. Classe API errata: Usa DefaultApi per le richieste lato server autenticate, PublicApi per le richieste lato client/pubbliche.
  3. Chiave API nulla: Lo SDK salterà silenziosamente l'autenticazione se la chiave API è null, causando errori 401.

Note Internal Link

ID di Broadcast

Vedrai che dovrai passare un broadcastId in alcune chiamate API. Quando ricevi eventi, otterrai questo ID indietro, così saprai di ignorare l'evento se prevedi di applicare in modo ottimistico le modifiche lato client (cosa che probabilmente vorrai fare poiché offre la migliore esperienza). Inserisci qui un UUID. L'ID dovrebbe essere sufficientemente unico da non presentarsi due volte in una sessione del browser.

SSO (Single Sign-On)

Per esempi di SSO, vedi sotto.

Utilizzo SSO Internal Link

SSO semplice

require 'fastcomments'
require 'fastcomments-client'

# Crea token SSO semplice
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}"

# Usa il token SSO per effettuare una chiamata API autenticata
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

SSO sicuro

require 'fastcomments'
require 'fastcomments-client'

# Crea token SSO sicuro
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}"

# Usa il token SSO per effettuare una chiamata API autenticata
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

aggregare Internal Link

Aggrega i documenti raggruppandoli (se viene fornito groupBy) e applicando più operazioni. Sono supportate diverse operazioni (ad es. sum, countDistinct, avg, ecc.).

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
parentTenantIdstringqueryNo
includeStatsbooleanqueryNo

Risposta

Restituisce: AggregationResponse

Esempio

Esempio di aggregate
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con la chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (valore predefinito: 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

ottieni_log_audit Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Risposta

Restituisce: GetAuditLogs200Response

Esempio

Esempio di get_audit_logs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con la chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

blocca_da_commento_pubblico Internal Link

Parametri

NomeTipoLocationObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: BlockFromCommentPublic200Response

Esempio

Esempio di 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

sblocca_commento_pubblico Internal Link


Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: UnBlockCommentPublic200Response

Esempio

Esempio di 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

controlla_commenti_bloccati Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdsstringqueryUna lista separata da virgole di id dei commenti.
ssostringqueryNo

Risposta

Restituisce: CheckedCommentsForBlocked200Response

Esempio

Esempio di 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 | Una lista separata da virgole di id dei commenti.
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

blocca_utente_da_commento Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: BlockFromCommentPublic200Response

Esempio

Esempio di block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

crea_commento_pubblico Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpercorso
urlIdstringquery
broadcastIdstringquery
sessionIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: CreateCommentPublic200Response

Esempio

Esempio di create_comment_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 |
8broadcast_id = 'broadcast_id_example' # String |
9comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData |
10opts = {
11 session_id: 'session_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->create_comment_public: #{e}"
21end
22

elimina_commento Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
contextUserIdstringqueryNo
isLivebooleanqueryNo

Risposta

Restituisce: DeleteComment200Response

Esempio

Esempio di delete_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

elimina_commento_pubblico Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: DeleteCommentPublic200Response

Esempio

Esempio di delete_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 |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 edit_key: 'edit_key_example', # String |
11 sso: 'sso_example' # String |
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

elimina_voto_commento Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
voteIdstringpath
urlIdstringquery
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: DeleteCommentVote200Response

Esempio

Esempio di delete_comment_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Stringa |
7comment_id = 'comment_id_example' # Stringa |
8vote_id = 'vote_id_example' # Stringa |
9url_id = 'url_id_example' # Stringa |
10broadcast_id = 'broadcast_id_example' # Stringa |
11opts = {
12 edit_key: 'edit_key_example', # Stringa |
13 sso: 'sso_example' # Stringa |
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

segnala_commento Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: FlagComment200Response

Esempio

Esempio di flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autenticazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_commento Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetComment200Response

Esempio

Esempio di get_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per l'API key, es. 'Bearer' (predefinito 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

ottieni_testo_commento Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: GetCommentText200Response

Esempio

Esempio di 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

ottieni_nomi_utenti_voto_commento Internal Link


Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringpath
commentIdstringpath
dirintegerquery
ssostringqueryNo

Risposta

Restituisce: GetCommentVoteUserNames200Response

Esempio

Esempio di get_comment_vote_user_names
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 |
8dir = 56 # Integer |
9opts = {
10 sso: 'sso_example' # String |
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

ottieni_commenti Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo

Risposta

Restituisce: GetComments200Response

Esempio

Esempio di get_comments
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione della API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 56, # Integer |
16 limit: 56, # Integer |
17 skip: 56, # Integer |
18 as_tree: true, # Boolean |
19 skip_children: 56, # Integer |
20 limit_children: 56, # Integer |
21 max_tree_depth: 56, # Integer |
22 url_id: 'url_id_example', # String |
23 user_id: 'user_id_example', # String |
24 anon_user_id: 'anon_user_id_example', # String |
25 context_user_id: 'context_user_id_example', # String |
26 hash_tag: 'hash_tag_example', # String |
27 parent_id: 'parent_id_example', # String |
28 direction: FastCommentsClient::SortDirections::OF # SortDirections |
29}
30
31begin
32
33 result = api_instance.get_comments(tenant_id, opts)
34 p result
35rescue FastCommentsClient::ApiError => e
36 puts "Error when calling DefaultApi->get_comments: #{e}"
37end
38

ottieni_commenti_pubblici Internal Link

req tenantId urlId

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
pageintegerqueryNo
directionstringqueryNo
ssostringqueryNo
skipintegerqueryNo
skipChildrenintegerqueryNo
limitintegerqueryNo
limitChildrenintegerqueryNo
countChildrenbooleanqueryNo
fetchPageForCommentIdstringqueryNo
includeConfigbooleanqueryNo
countAllbooleanqueryNo
includei10nbooleanqueryNo
localestringqueryNo
modulesstringqueryNo
isCrawlerbooleanqueryNo
includeNotificationCountbooleanqueryNo
asTreebooleanqueryNo
maxTreeDepthintegerqueryNo
useFullTranslationIdsbooleanqueryNo
parentIdstringqueryNo
searchTextstringqueryNo
hashTagsarrayqueryNo
userIdstringqueryNo
customConfigStrstringqueryNo
afterCommentIdstringqueryNo
beforeCommentIdstringqueryNo

Risposta

Restituisce: GetCommentsPublic200Response

Esempio

Esempio di 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

blocca_commento Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Risposta

Restituisce: LockComment200Response

Esempio

Esempio di 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

fissa_commento Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Risposta

Restituisce: PinComment200Response

Esempio

Esempio di 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

salva_commento Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Risposta

Restituisce: SaveComment200Response

Esempio

Esempio di save_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

salva_commenti_in_blocco Internal Link

Parametri

NomeTipoLocationObbligatorioDescrizione
tenantIdstringquery
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Risposta

Restituisce: Array&lt;SaveComment200Response&gt;

Esempio

Esempio di save_comments_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

imposta_testo_commento Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: SetCommentText200Response

Esempio

Esempio di 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

sblocca_utente_da_commento Internal Link

Parametri

NameTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: UnBlockCommentPublic200Response

Esempio

Esempio di un_block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

annulla_segnalazione_commento Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: FlagComment200Response

Esempio

Esempio di un_flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

sblocca_commento Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Risposta

Restituisce: LockComment200Response

Esempio

Esempio di 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

rimuovi_fissaggio_commento Internal Link

Parametri

NomeTipoLocationObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Risposta

Restituisce: PinComment200Response

Esempio

Esempio di 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

aggiorna_commento Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

vota_commento Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: VoteComment200Response

Esempio

Esempio di 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

aggiungi_config_dominio Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery

Risposta

Restituisce: AddDomainConfig200Response

Esempio

Esempio di add_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, ad es. 'Bearer' (valore predefinito 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

elimina_config_dominio Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
domainstringpath

Risposta

Restituisce: DeleteDomainConfig200Response

Esempio

Esempio di delete_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autenticazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_config_dominio Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
domainstringpath

Risposta

Restituisce: GetDomainConfig200Response

Esempio

Esempio di get_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla seguente riga per impostare un prefisso per la chiave API, es. 'Bearer' (di default è nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.get_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_domain_config: #{e}"
22end
23

ottieni_configurazioni_dominio Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Risposta

Restituisce: GetDomainConfigs200Response

Esempio

Esempio di get_domain_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la seguente riga per impostare un prefisso per la API key, es. 'Bearer' (predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Stringa |
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

aggiorna_parziale_config_dominio Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
domainToUpdatestringpath

Risposta

Restituisce: GetDomainConfig200Response

Esempio

Esempio di patch_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autenticazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, ad es. 'Bearer' (valore predefinito 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

sostituisci_config_dominio Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainToUpdatestringpathYes

Risposta

Restituisce: GetDomainConfig200Response

Esempio

Esempio di put_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la seguente riga per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

crea_template_email Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateEmailTemplate200Response

Esempio

Esempio di create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

elimina_template_email Internal Link

Parametri

NomeTipoLocationObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

elimina_errore_render_template_email Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
errorIdstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_email_template_render_error
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con la chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la chiave API, p.es. 'Bearer' (predefinito 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

ottieni_template_email Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetEmailTemplate200Response

Esempio

Esempio di get_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_definizioni_template_email Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery

Risposta

Restituisce: GetEmailTemplateDefinitions200Response

Esempio

Esempio di get_email_template_definitions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, ad es. 'Bearer' (predefinito 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

ottieni_errori_render_template_email Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
skipnumberqueryNo

Risposta

Restituisce: GetEmailTemplateRenderErrors200Response

Esempio

Esempio di get_email_template_render_errors
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

ottieni_template_email Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetEmailTemplates200Response

Esempio

Esempio di get_email_templates
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Imposta l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, ad es. 'Bearer' (valore predefinito 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

genera_template_email Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
localestringqueryNo

Risposta

Restituisce: RenderEmailTemplate200Response

Esempio

Esempio di render_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

aggiorna_template_email Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Response

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_registro_eventi Internal Link

req tenantId urlId userIdWS

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery

Risposta

Restituisce: GetEventLog200Response

Esempio

Esempio di 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 |
10end_time = 789 # Integer |
11
12begin
13
14 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_event_log: #{e}"
18end
19

ottieni_registro_eventi_globale Internal Link

req tenantId urlId userIdWS

Parametri

NameTipoLocationObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery

Risposta

Restituisce: GetEventLog200Response

Esempio

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

crea_post_feed Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

Risposta

Restituisce: CreateFeedPost200Response

Esempio

Esempio di create_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

crea_post_feed_pubblico Internal Link

Parametri

NomeTipoLocationObbligatorioDescrizione
tenantIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: CreateFeedPostPublic200Response

Esempio

Esempio di 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

elimina_post_feed_pubblico Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: DeleteFeedPostPublic200Response

Esempio

Esempio di delete_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Stringa |
7post_id = 'post_id_example' # Stringa |
8opts = {
9 broadcast_id: 'broadcast_id_example', # Stringa |
10 sso: 'sso_example' # Stringa |
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

ottieni_post_feed Internal Link

req tenantId afterId

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

Risposta

Restituisce: GetFeedPosts200Response

Esempio

Esempio di get_feed_posts
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_post_feed_pubblici Internal Link

req tenantId afterId

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo
ssostringqueryNo
isCrawlerbooleanqueryNo
includeUserInfobooleanqueryNo

Risposta

Restituisce: GetFeedPostsPublic200Response

Esempio

Esempio di 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

ottieni_statistiche_post_feed Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdsarrayquery
ssostringqueryNo

Risposta

Restituisce: GetFeedPostsStats200Response

Esempio

Esempio di 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

ottieni_reazioni_utente_pubbliche Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdsarrayqueryNo
ssostringqueryNo

Risposta

Restituisce: GetUserReactsPublic200Response

Esempio

Esempio di 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

reagisci_post_feed_pubblico Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdstringpath
isUndobooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: ReactFeedPostPublic200Response

Esempio

Esempio di react_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Stringa |
7post_id = 'post_id_example' # Stringa |
8react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams |
9opts = {
10 is_undo: true, # Booleano |
11 broadcast_id: 'broadcast_id_example', # Stringa |
12 sso: 'sso_example' # Stringa |
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

aggiorna_post_feed Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

aggiorna_post_feed_pubblico Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: CreateFeedPostPublic200Response

Esempio

Esempio di update_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Stringa |
7post_id = 'post_id_example' # Stringa |
8update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # Stringa |
11 sso: 'sso_example' # Stringa |
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

segnala_commento_pubblico Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
isFlaggedbooleanquery
ssostringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di 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

aggiungi_hashtag Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryNo

Risposta

Restituisce: AddHashTag200Response

Esempio

Esempio di add_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tag(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
24end
25

aggiungi_hashtag_in_blocco Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryNo

Risposta

Restituisce: AddHashTagsBulk200Response

Esempio

Esempio di add_hash_tags_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autorizzazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 bulk_create_hash_tags_body: FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tags_bulk(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
24end
25

elimina_hashtag Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tagstringpath
tenantIdstringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 delete_hash_tag_request: FastCommentsClient::DeleteHashTagRequest.new # DeleteHashTagRequest |
17}
18
19begin
20
21 result = api_instance.delete_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
25end
26

ottieni_hashtag Internal Link

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringquery
pagenumberqueryNo

Risposta

Restituisce: GetHashTags200Response

Esempio

Esempio di get_hash_tags
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, ad es. 'Bearer' (predefinito: 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

aggiorna_parziale_hashtag Internal Link

Parametri

NameTypeLocationRequiredDescription
tagstringpath
tenantIdstringqueryNo

Risposta

Restituisce: PatchHashTag200Response

Esempio

Esempio patch_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
17}
18
19begin
20
21 result = api_instance.patch_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
25end
26

crea_moderatore Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery

Risposta

Restituisce: CreateModerator200Response

Esempio

Esempio di create_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

elimina_moderatore Internal Link

Parametri

NameTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes
sendEmailstringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

ottieni_moderatore Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetModerator200Response

Esempio

Esempio di get_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per l'API key, es. 'Bearer' (predefinito: 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

ottieni_moderatori Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetModerators200Response

Esempio

Esempio di get_moderators
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

invia_invito Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
fromNamestringquery

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di send_invite
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per l'API key, es. 'Bearer' (valore predefinito 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

aggiorna_moderatore Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

elimina_conteggio_notifiche Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (valore predefinito: 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

ottieni_conteggio_notifiche_cache Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetCachedNotificationCount200Response

Esempio

Esempio di get_cached_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_conteggio_notifiche Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

Risposta

Restituisce: GetNotificationCount200Response

Esempio

Esempio di get_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_notifiche Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetNotifications200Response

Esempio

Esempio di get_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# imposta l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

aggiorna_notifica Internal Link

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_notification
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

aggiungi_pagina Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: AddPageAPIResponse

Esempio

Esempio di add_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

elimina_pagina Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: DeletePageAPIResponse

Esempio

Esempio di delete_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la seguente riga per impostare un prefisso per la API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_page(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_page: #{e}"
22end
23

ottieni_pagina_per_urlid Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdstringquery

Risposta

Restituisce: GetPageByURLIdAPIResponse

Esempio

Esempio per get_page_by_urlid
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_pagine Internal Link

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringquery

Risposta

Restituisce: GetPagesAPIResponse

Esempio

Esempio di get_pages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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_pages(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_pages: #{e}"
21end
22

aggiorna_parziale_pagina Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: PatchPageAPIResponse

Esempio

Esempio di patch_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

elimina_evento_webhook_in_sospeso Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_pending_webhook_event
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

ottieni_conteggio_eventi_webhook_in_sospeso Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

Risposta

Restituisce: GetPendingWebhookEventCount200Response

Esempio

Esempio di get_pending_webhook_event_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

ottieni_eventi_webhook_in_sospeso Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetPendingWebhookEvents200Response

Esempio

Esempio di get_pending_webhook_events
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurazione dell'autenticazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per l'API key, es. 'Bearer' (predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Stringa |
14opts = {
15 comment_id: 'comment_id_example', # Stringa |
16 external_id: 'external_id_example', # Stringa |
17 event_type: 'event_type_example', # Stringa |
18 type: 'type_example', # Stringa |
19 domain: 'domain_example', # Stringa |
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

crea_configurazione_domanda Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateQuestionConfig200Response

Esempio

Esempio di create_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con la API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

elimina_configurazione_domanda Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite 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 |
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

ottieni_configurazione_domanda Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetQuestionConfig200Response

Esempio

Esempio di get_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# imposta l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

ottieni_configurazioni_domande Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetQuestionConfigs200Response

Esempio

Esempio di get_question_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite 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' # Stringa |
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

aggiorna_configurazione_domanda Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

crea_risultato_domanda Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateQuestionResult200Response

Esempio

Esempio di create_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

elimina_risultato_domanda Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (valore predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Stringa |
14id = 'id_example' # Stringa |
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

ottieni_risultato_domanda Internal Link

Parametri

NomeTipoLocationObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetQuestionResult200Response

Esempio

Esempio get_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (valore predefinito: 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

ottieni_risultati_domande Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdstringqueryNo
userIdstringqueryNo
startDatestringqueryNo
questionIdstringqueryNo
questionIdsstringqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetQuestionResults200Response

Esempio

Esempio di get_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostare l'autenticazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

aggiorna_risultato_domanda Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (di default 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

aggrega_risultati_domande Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringquery
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

Risposta

Restituisce: AggregateQuestionResults200Response

Esempio

Esempio di aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

aggregazione_risultati_domande_in_blocco Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
forceRecalculatebooleanqueryNo

Risposta

Restituisce: BulkAggregateQuestionResults200Response

Esempio

Esempio di bulk_aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con la chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la chiave API, ad es. 'Bearer' (predefinito: 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

combina_commenti_con_risultati_domande Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Risposta

Restituisce: CombineCommentsWithQuestionResults200Response

Esempio

Esempio di combine_comments_with_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per l'API key, es. 'Bearer' (predefinito: 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

aggiungi_utente_sso Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery

Risposta

Restituisce: AddSSOUserAPIResponse

Esempio

Esempio di add_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

elimina_utente_sso Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

Risposta

Restituisce: DeleteSSOUserAPIResponse

Esempio

Esempio di delete_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (valore predefinito 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

ottieni_utente_sso_per_email Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
emailstringpath

Risposta

Restituisce: GetSSOUserByEmailAPIResponse

Esempio

Esempio di get_sso_user_by_email
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

ottieni_utente_sso_per_id Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetSSOUserByIdAPIResponse

Esempio

Esempio di get_sso_user_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autorizzazione mediante API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

ottieni_utenti_sso Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
skipintegerqueryNo

Risposta

Restituisce: GetSSOUsers200Response

Esempio

Esempio get_sso_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configurare l'autenticazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Stringa |
14opts = {
15 skip: 56 # Intero |
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

aggiorna_parziale_utente_sso Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Risposta

Restituisce: PatchSSOUserAPIResponse

Esempio

Esempio di patch_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la seguente riga per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

sostituisci_utente_sso Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
updateCommentsbooleanqueryNo

Risposta

Restituisce: PutSSOUserAPIResponse

Esempio

put_sso_user Esempio
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la seguente riga per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

crea_iscrizione Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateSubscriptionAPIResponse

Esempio

Esempio di create_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

elimina_iscrizione Internal Link

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo

Response

Restituisce: DeleteSubscriptionAPIResponse

Example

Esempio di delete_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_iscrizioni Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo

Risposta

Restituisce: GetSubscriptionsAPIResponse

Esempio

Esempio di get_subscriptions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autenticazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

aggiorna_iscrizione Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringqueryNo

Risposta

Restituisce: UpdateSubscriptionAPIResponse

Esempio

Esempio di update_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

ottieni_utilizzi_giornalieri_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
yearNumbernumberqueryNo
monthNumbernumberqueryNo
dayNumbernumberqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetTenantDailyUsages200Response

Esempio

Esempio di get_tenant_daily_usages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, ad es. 'Bearer' (predefinito 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

crea_pacchetto_tenant Internal Link

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateTenantPackage200Response

Esempio

Esempio di create_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# setup authorization
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_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

elimina_pacchetto_tenant Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la seguente riga per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

ottieni_pacchetto_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetTenantPackage200Response

Esempio

Esempio di get_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, ad es. 'Bearer' (predefinito 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

ottieni_pacchetti_tenant Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetTenantPackages200Response

Esempio

Esempio di get_tenant_packages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

sostituisci_pacchetto_tenant Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio replace_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostare l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

aggiorna_pacchetto_tenant Internal Link


Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (valore predefinito 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

crea_utente_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateTenantUser200Response

Esempio

Esempio di create_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (valore predefinito 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

elimina_utente_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
deleteCommentsstringqueryNo
commentDeleteModestringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

ottieni_utente_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetTenantUser200Response

Esempio

Esempio di get_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

ottieni_utenti_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetTenantUsers200Response

Esempio

Esempio di get_tenant_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

sostituisci_utente_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
updateCommentsstringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

replace_tenant_user Esempio
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
redirectURLstringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di send_login_link
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

aggiorna_utente_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
updateCommentsstringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

crea_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateTenant200Response

Esempio

create_tenant Esempio
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (valore predefinito: 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

elimina_tenant Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
surestringqueryNo

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di delete_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

ottieni_tenant Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetTenant200Response

Esempio

Esempio di get_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la API key, ad es. 'Bearer' (predefinito 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

ottieni_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
metastringqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetTenants200Response

Esempio

Esempio di get_tenants
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione con chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito: 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

aggiorna_tenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di update_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

cambia_stato_ticket Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringquery
idstringpath

Risposta

Restituisce: ChangeTicketState200Response

Esempio

Esempio di change_ticket_state
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la API key, es. 'Bearer' (valore predefinito 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

crea_ticket Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringquery

Risposta

Restituisce: CreateTicket200Response

Esempio

Esempio di create_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

ottieni_ticket Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Risposta

Restituisce: GetTicket200Response

Esempio

Esempio di get_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autenticazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (di default è 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

ottieni_ticket Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

Risposta

Restituisce: GetTickets200Response

Esempio

Esempio get_tickets
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la chiave API, e.g. 'Bearer' (predefinito 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

carica_immagine Internal Link

Carica e ridimensiona un'immagine

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathYes
sizePresetstringqueryNoPreset dimensioni: "Default" (1000x1000px) o "CrossPlatform" (crea dimensioni per dispositivi popolari)
urlIdstringqueryNoID della pagina da cui avviene il caricamento, per configurare

Risposta

Restituisce: UploadImageResponse

Esempio

Esempio di 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 | Preset dimensioni: \"Default\" (1000x1000px) o \"CrossPlatform\" (crea dimensioni per dispositivi popolari)
10 url_id: 'url_id_example' # String | ID della pagina da cui avviene il caricamento, per configurare
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

ottieni_progresso_badge_utente_per_id Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetUserBadgeProgressById200Response

Esempio

Esempio di get_user_badge_progress_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la seguente riga per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

ottieni_progresso_badge_utente_per_user_id Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringpath

Risposta

Restituisce: GetUserBadgeProgressById200Response

Esempio

Esempio di get_user_badge_progress_by_user_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione della chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (valore predefinito 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

ottieni_lista_progresso_badge_utente Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringqueryNo
limitnumberqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetUserBadgeProgressList200Response

Esempio

Esempio get_user_badge_progress_list
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione con API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

crea_badge_utente Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateUserBadge200Response

Esempio

Esempio di create_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione della chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovi il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

elimina_badge_utente Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: UpdateUserBadge200Response

Esempio

Esempio di delete_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

ottieni_badge_utente Internal Link

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetUserBadge200Response

Esempio

Esempio di get_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configura l'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_badge_utenti Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringqueryNo
badgeIdstringqueryNo
typenumberqueryNo
displayedOnCommentsbooleanqueryNo
limitnumberqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetUserBadges200Response

Esempio

Esempio di get_user_badges
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per l'API key, es. 'Bearer' (valore predefinito 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

aggiorna_badge_utente Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: UpdateUserBadge200Response

Esempio

Esempio di update_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la seguente riga per impostare un prefisso per la API key, es. 'Bearer' (predefinito 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

ottieni_conteggio_notifiche_utente Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Risposta

Restituisce: GetUserNotificationCount200Response

Esempio

Esempio di 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

ottieni_notifiche_utente Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: GetUserNotifications200Response

Esempio

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

reimposta_conteggio_notifiche_utente Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Risposta

Restituisce: ResetUserNotifications200Response

Esempio

Esempio di reset_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.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

reimposta_notifiche_utente Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: ResetUserNotifications200Response

Esempio

Esempio di reset_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Stringa |
7opts = {
8 after_id: 'after_id_example', # Stringa |
9 after_created_at: 789, # Intero |
10 unread_only: true, # Booleano |
11 dm_only: true, # Booleano |
12 no_dm: true, # Booleano |
13 sso: 'sso_example' # Stringa |
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

aggiorna_stato_iscrizione_commenti_notifica_utente Internal Link

Attiva o disattiva le notifiche per un commento specifico.

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
notificationIdstringpath
optedInOrOutstringpath
commentIdstringquery
ssostringqueryNo

Risposta

Restituisce: UpdateUserNotificationStatus200Response

Esempio

Esempio di 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

aggiorna_stato_iscrizione_pagina_notifica_utente Internal Link

Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, vengono create notifiche per i nuovi commenti principali e anche

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdstringquery
urlstringquery
pageTitlestringquery
subscribedOrUnsubscribedstringpath
ssostringqueryNo

Risposta

Restituisce: UpdateUserNotificationStatus200Response

Esempio

Esempio di 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

aggiorna_stato_notifica_utente Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
notificationIdstringpath
newStatusstringpath
ssostringqueryNo

Risposta

Restituisce: UpdateUserNotificationStatus200Response

Esempio

Esempio di 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

ottieni_stati_presenza_utente Internal Link


Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdWSstringquery
userIdsstringquery

Risposta

Restituisce: GetUserPresenceStatuses200Response

Esempio

Esempio di get_user_presence_statuses
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Stringa |
7url_id_ws = 'url_id_ws_example' # Stringa |
8user_ids = 'user_ids_example' # Stringa |
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

cerca_utenti Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
usernameStartsWithstringqueryNo
mentionGroupIdsarrayqueryNo
ssostringqueryNo
searchSectionstringqueryNo

Risposta

Restituisce: SearchUsers200Response

Esempio

Esempio di 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

ottieni_utente Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetUser200Response

Esempio

Esempio get_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la API key, e.g. 'Bearer' (predefinito 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

crea_voto Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringquery
directionstringquery
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: VoteComment200Response

Esempio

create_vote Esempio
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autenticazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (predefinito: 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

elimina_voto Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
editKeystringqueryNo

Risposta

Restituisce: DeleteCommentVote200Response

Esempio

Esempio di delete_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Rimuovere il commento dalla riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (valore predefinito 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

ottieni_voti Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdstringquery

Risposta

Restituisce: GetVotes200Response

Esempio

Esempio di get_votes
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite chiave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommentare la riga seguente per impostare un prefisso per la chiave API, es. 'Bearer' (predefinito 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

ottieni_voti_per_utente Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdstringquery
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: GetVotesForUser200Response

Esempio

Esempio get_votes_for_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# impostazione dell'autorizzazione
5FastCommentsClient.configure do |config|
6 # Configura l'autorizzazione tramite API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenta la riga seguente per impostare un prefisso per la API key, es. 'Bearer' (valore predefinito 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

Hai bisogno di aiuto?

Se riscontri problemi o hai domande sul SDK Ruby, per favore:

Contribuire

I contributi sono benvenuti! Visita il repository GitHub per le linee guida per i contributi.