SDK Ruby de FastComments

Ajoutez cette ligne au Gemfile de votre application :

gem 'fastcomments'

Et ensuite exécutez :

bundle install

Ou installez-le vous-même comme suit :

gem install fastcomments

Contenu de la bibliothèque

Cette bibliothèque contient le client d'API généré et les utilitaires SSO pour faciliter l'utilisation de l'API.

• Documentation de la bibliothèque cliente de l'API

API publiques vs sécurisées

Pour le client API, il existe deux classes, DefaultApi et PublicApi. La DefaultApi contient des méthodes qui requièrent votre clé API, et PublicApi contient des appels d'API qui peuvent être effectués directement depuis un navigateur, un appareil mobile, etc., sans authentification.

Utilisation des API authentifiées (DefaultApi)

Important : Vous devez définir votre clé API sur l'ApiClient avant d'effectuer des requêtes authentifiées. Si vous ne le faites pas, les requêtes échoueront avec une erreur 401.

require 'fastcomments-client'

# Créez et configurez le client API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# OBLIGATOIRE : Définissez votre clé API (obtenez-la depuis votre tableau de bord FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Créez l'instance de l'API avec le client configuré
api = FastCommentsClient::DefaultApi.new(api_client)

# Vous pouvez maintenant effectuer des appels API authentifiés
begin
  # Exemple : Ajouter un utilisateur 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}"
  # Erreurs courantes :
  # - 401 : la clé API est manquante ou invalide
  # - 400 : la validation de la requête a échoué
end

Utilisation des API publiques (PublicApi)

Les points de terminaison publics ne requièrent pas d'authentification :

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

Problèmes courants

1. Erreur 401 «missing-api-key» : Assurez-vous de définir config.api_key['x-api-key'] = 'YOUR_KEY' avant de créer l'instance DefaultApi.
2. Mauvaise classe API : Utilisez DefaultApi pour les requêtes authentifiées côté serveur, PublicApi pour les requêtes côté client/public.
3. Clé API nulle : Le SDK ignorera silencieusement l'authentification si la clé API est nulle, ce qui entraînera des erreurs 401.

Identifiants de diffusion

Vous verrez que vous devez passer un broadcastId dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permet d'ignorer l'événement si vous envisagez d'appliquer de manière optimiste des modifications côté client (ce que vous voudrez probablement faire puisque cela offre la meilleure expérience). Fournissez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une session de navigateur.

SSO (Authentification unique)

Pour des exemples de SSO, voir ci-dessous.

SSO simple

require 'fastcomments'
require 'fastcomments-client'

# Créer un jeton SSO simple
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}"

# Utiliser le jeton SSO pour effectuer un appel d'API authentifié
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 sécurisé

require 'fastcomments'
require 'fastcomments-client'

# Créer un jeton SSO sécurisé
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}"

# Utiliser le jeton SSO pour effectuer un appel d'API authentifié
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}"

Agrège des documents en les regroupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (p. ex. sum, countDistinct, avg, etc.) sont prises en charge.

Paramètres

Réponse

Renvoie : AggregationResponse

Exemple

Exemple d’agrégation

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (valeur par défaut : 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

Parameters

Réponse

Renvoie: GetAuditLogs200Response

Exemple

Exemple de get_audit_logs

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configuration de l'authentification

5FastCommentsClient.configure do |config|

6 # Configurer l'authentification par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie: BlockFromCommentPublic200Response

Exemple

Exemple de block_from_comment_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7comment_id = 'comment_id_example' # Chaîne |

8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |

9opts = {

10 sso: 'sso_example' # Chaîne |

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

Paramètres

Réponse

Renvoie: UnBlockCommentPublic200Response

Exemple

Exemple de un_block_comment_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7comment_id = 'comment_id_example' # String |

8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |

9opts = {

10 sso: 'sso_example' # String |

11}

12

13begin

14

15 result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)

16 p result

17rescue FastCommentsClient::ApiError => e

18 puts "Error when calling PublicApi->un_block_comment_public: #{e}"

19end

20

Paramètres

Réponse

Retourne: CheckedCommentsForBlocked200Response

Exemple

Exemple de checked_comments_for_blocked

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7comment_ids = 'comment_ids_example' # String | Une liste d'identifiants de commentaires séparés par des virgules.

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

Paramètres

Réponse

Renvoie: BlockFromCommentPublic200Response

Exemple

Exemple de block_user_from_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configurer l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : CreateCommentPublic200Response

Exemple

Exemple de create_comment_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7url_id = 'url_id_example' # String |

8broadcast_id = 'broadcast_id_example' # String |

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

10opts = {

11 session_id: 'session_id_example', # String |

12 sso: 'sso_example' # String |

13}

14

15begin

16

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

18 p result

19rescue FastCommentsClient::ApiError => e

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

21end

22

Paramètres

Réponse

Retourne : DeleteComment200Response

Exemple

Exemple de delete_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : DeleteCommentPublic200Response

Exemple

Exemple de delete_comment_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7comment_id = 'comment_id_example' # Chaîne |

8broadcast_id = 'broadcast_id_example' # Chaîne |

9opts = {

10 edit_key: 'edit_key_example', # Chaîne |

11 sso: 'sso_example' # Chaîne |

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

Paramètres

Réponse

Renvoie: DeleteCommentVote200Response

Exemple

Exemple de delete_comment_vote

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7comment_id = 'comment_id_example' # Chaîne |

8vote_id = 'vote_id_example' # Chaîne |

9url_id = 'url_id_example' # Chaîne |

10broadcast_id = 'broadcast_id_example' # Chaîne |

11opts = {

12 edit_key: 'edit_key_example', # Chaîne |

13 sso: 'sso_example' # Chaîne |

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

Paramètres

Réponse

Retourne : FlagComment200Response

Exemple

Exemple de flag_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie: GetComment200Response

Exemple

Exemple de get_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API : api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (valeur par défaut : nil)

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

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # Chaîne |

14id = 'id_example' # Chaîne |

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

Paramètres

Réponse

Retourne: GetCommentText200Response

Exemple

Exemple de get_comment_text

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7comment_id = 'comment_id_example' # Chaîne |

8opts = {

9 edit_key: 'edit_key_example', # Chaîne |

10 sso: 'sso_example' # Chaîne |

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

Paramètres

Réponse

Retourne : GetCommentVoteUserNames200Response

Exemple

Exemple de get_comment_vote_user_names

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

Paramètres

Réponse

Renvoie: GetComments200Response

Exemple

Exemple de get_comments

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut nil)

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

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # String |

14opts = {

15 page: 56, # Integer |

16 limit: 56, # Integer |

17 skip: 56, # Integer |

18 as_tree: true, # Boolean |

19 skip_children: 56, # Integer |

20 limit_children: 56, # Integer |

21 max_tree_depth: 56, # Integer |

22 url_id: 'url_id_example', # String |

23 user_id: 'user_id_example', # String |

24 anon_user_id: 'anon_user_id_example', # String |

25 context_user_id: 'context_user_id_example', # String |

26 hash_tag: 'hash_tag_example', # String |

27 parent_id: 'parent_id_example', # String |

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

29}

30

31begin

32

33 result = api_instance.get_comments(tenant_id, opts)

34 p result

35rescue FastCommentsClient::ApiError => e

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

37end

38

req tenantId urlId

Paramètres

Réponse

Retourne: GetCommentsPublic200Response

Exemple

Exemple de get_comments_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7url_id = 'url_id_example' # Chaîne |

8opts = {

9 page: 56, # Entier |

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

11 sso: 'sso_example', # Chaîne |

12 skip: 56, # Entier |

13 skip_children: 56, # Entier |

14 limit: 56, # Entier |

15 limit_children: 56, # Entier |

16 count_children: true, # Booléen |

17 fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # Chaîne |

18 include_config: true, # Booléen |

19 count_all: true, # Booléen |

20 includei10n: true, # Booléen |

21 locale: 'locale_example', # Chaîne |

22 modules: 'modules_example', # Chaîne |

23 is_crawler: true, # Booléen |

24 include_notification_count: true, # Booléen |

25 as_tree: true, # Booléen |

26 max_tree_depth: 56, # Entier |

27 use_full_translation_ids: true, # Booléen |

28 parent_id: 'parent_id_example', # Chaîne |

29 search_text: 'search_text_example', # Chaîne |

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

31 user_id: 'user_id_example', # Chaîne |

32 custom_config_str: 'custom_config_str_example', # Chaîne |

33 after_comment_id: 'after_comment_id_example', # Chaîne |

34 before_comment_id: 'before_comment_id_example' # Chaîne |

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

Paramètres

Réponse

Renvoie: LockComment200Response

Exemple

Exemple de lock_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7comment_id = 'comment_id_example' # Chaîne |

8broadcast_id = 'broadcast_id_example' # Chaîne |

9opts = {

10 sso: 'sso_example' # Chaîne |

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

Paramètres

Réponse

Renvoie : PinComment200Response

Exemple

Exemple de pin_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7comment_id = 'comment_id_example' # String |

8broadcast_id = 'broadcast_id_example' # String |

9opts = {

10 sso: 'sso_example' # String |

11}

12

13begin

14

15 result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)

16 p result

17rescue FastCommentsClient::ApiError => e

18 puts "Error when calling PublicApi->pin_comment: #{e}"

19end

20

Paramètres

Réponse

Renvoie: SaveComment200Response

Exemple

Exemple de save_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configurer l'autorisation

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut : 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

Paramètres

Réponse

Retourne: Array<SaveComment200Response>

Exemple

Exemple de save_comments_bulk

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : SetCommentText200Response

Exemple

Exemple set_comment_text

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7comment_id = 'comment_id_example' # Chaîne |

8broadcast_id = 'broadcast_id_example' # Chaîne |

9comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest |

10opts = {

11 edit_key: 'edit_key_example', # Chaîne |

12 sso: 'sso_example' # Chaîne |

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

Paramètres

Réponse

Renvoie : UnBlockCommentPublic200Response

Exemple

Exemple de un_block_user_from_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Retourne : FlagComment200Response

Exemple

Exemple de un_flag_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configuration de l'authentification

5FastCommentsClient.configure do |config|

6 # Configurer l'authentification par clé API : api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : LockComment200Response

Exemple

Exemple de un_lock_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7comment_id = 'comment_id_example' # Chaîne |

8broadcast_id = 'broadcast_id_example' # Chaîne |

9opts = {

10 sso: 'sso_example' # Chaîne |

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

Paramètres

Réponse

Renvoie: PinComment200Response

Exemple

Exemple de un_pin_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7comment_id = 'comment_id_example' # String |

8broadcast_id = 'broadcast_id_example' # String |

9opts = {

10 sso: 'sso_example' # String |

11}

12

13begin

14

15 result = api_instance.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

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de update_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : VoteComment200Response

Exemple

Exemple de vote_comment

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7comment_id = 'comment_id_example' # String |

8url_id = 'url_id_example' # String |

9broadcast_id = 'broadcast_id_example' # String |

10vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams |

11opts = {

12 session_id: 'session_id_example', # String |

13 sso: 'sso_example' # String |

14}

15

16begin

17

18 result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)

19 p result

20rescue FastCommentsClient::ApiError => e

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

22end

23

Paramètres

Réponse

Renvoie: AddDomainConfig200Response

Exemple

Exemple de add_domain_config

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : DeleteDomainConfig200Response

Exemple

Exemple delete_domain_config

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Retourne: GetDomainConfig200Response

Exemple

Exemple de get_domain_config

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (valeur par défaut : 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

Paramètres

Réponse

Renvoie: GetDomainConfigs200Response

Exemple

Exemple get_domain_configs

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut nil)

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

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # Chaîne |

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

Paramètres

Réponse

Retourne: GetDomainConfig200Response

Exemple

Exemple de patch_domain_config

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configurer l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : GetDomainConfig200Response

Exemple

Exemple de put_domain_config

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'authentification par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (valeur par défaut : 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

Paramètres

Réponse

Retourne: CreateEmailTemplate200Response

Exemple

Exemple de create_email_template

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de delete_email_template

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configurer l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut nil)

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

10end

11

12api_instance = FastCommentsClient::DefaultApi.new

13tenant_id = 'tenant_id_example' # Chaîne |

14id = 'id_example' # Chaîne |

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

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de delete_email_template_render_error

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'authentification

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie: GetEmailTemplate200Response

Exemple

Exemple de get_email_template

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Retourne: GetEmailTemplateDefinitions200Response

Exemple

Exemple de get_email_template_definitions

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé d'API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé d'API, par ex. '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 |

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

Paramètres

Réponse

Retourne: GetEmailTemplateRenderErrors200Response

Exemple

Exemple de get_email_template_render_errors

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'authentification

5FastCommentsClient.configure do |config|

6 # Configure API key authorization: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie: GetEmailTemplates200Response

Exemple

Exemple de get_email_templates

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie : RenderEmailTemplate200Response

Exemple

Exemple de render_email_template

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de update_email_template

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

requis tenantId urlId userIdWS

Paramètres

Réponse

Retourne : GetEventLog200Response

Exemple

Exemple de get_event_log

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7url_id = 'url_id_example' # Chaîne |

8user_id_ws = 'user_id_ws_example' # Chaîne |

9start_time = 789 # Entier |

10end_time = 789 # Entier |

11

12begin

13

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

15 p result

16rescue FastCommentsClient::ApiError => e

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

18end

19

req tenantId urlId userIdWS

Paramètres

Réponse

Retourne: GetEventLog200Response

Exemple

get_global_event_log Exemple

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # Chaîne |

7url_id = 'url_id_example' # Chaîne |

8user_id_ws = 'user_id_ws_example' # Chaîne |

9start_time = 789 # Entier |

10end_time = 789 # Entier |

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

Paramètres

Réponse

Retourne: CreateFeedPost200Response

Exemple

Exemple de create_feed_post

Copy

1

2require 'time'

3require 'fastcomments-client'

4# Configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

Paramètres

Réponse

Retourne : CreateFeedPostPublic200Response

Exemple

Exemple de create_feed_post_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

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

8opts = {

9 broadcast_id: 'broadcast_id_example', # String |

10 sso: 'sso_example' # String |

11}

12

13begin

14

15 result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)

16 p result

17rescue FastCommentsClient::ApiError => e

18 puts "Error when calling PublicApi->create_feed_post_public: #{e}"

19end

20

Paramètres

Réponse

Renvoie: DeleteFeedPostPublic200Response

Exemple

Exemple de delete_feed_post_public

Copy

1

2require 'time'

3require 'fastcomments-client'

4

5api_instance = FastCommentsClient::PublicApi.new

6tenant_id = 'tenant_id_example' # String |

7post_id = 'post_id_example' # String |

8opts = {

9 broadcast_id: 'broadcast_id_example', # String |

10 sso: 'sso_example' # String |

11}

12

13begin

14

15 result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)

16 p result

17rescue FastCommentsClient::ApiError => e

18 puts "Error when calling PublicApi->delete_feed_post_public: #{e}"

19end

20

req tenantId afterId

Paramètres

Réponse

Renvoie: GetFeedPosts200Response

Exemple

Exemple de get_feed_posts

Copy

1

2require 'time'

3require 'fastcomments-client'

4# configuration de l'autorisation

5FastCommentsClient.configure do |config|

6 # Configurer l'autorisation par clé API: api_key

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

8 # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (valeur par défaut : 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