FastComments Ruby SDK

To jest oficjalne SDK Ruby dla FastComments.

Oficjalne SDK Ruby dla API FastComments

Repozytorium

AI coding agents

Daj swojemu agentowi kodującemu kontekst FastComments, którego potrzebuje - widgety, konfiguracja, Secure SSO, REST API i SDK:

npx skills add fastcomments/skills

Działa z Claude Code, Codex, Cursor, Copilot, Gemini i każdym innym agentem, którego obsługuje skills CLI.

Installation

Dodaj tę linię do pliku Gemfile Twojej aplikacji:

gem 'fastcomments'

A następnie wykonaj:

bundle install

Lub zainstaluj ją samodzielnie jako:

gem install fastcomments

Zawartość biblioteki

Ta biblioteka zawiera wygenerowanego klienta API oraz narzędzia SSO, które ułatwiają pracę z API.

Dokumentacja biblioteki klienta API

Publiczne vs zabezpieczone API

Dla klienta API istnieją trzy klasy, DefaultApi, PublicApi i ModerationApi. DefaultApi zawiera metody wymagające klucza API, a PublicApi zawiera wywołania API, które mogą być wykonywane bezpośrednio z przeglądarki/urządzenia mobilnego itp. bez uwierzytelnienia. ModerationApi zawiera metody napędzające panel moderatora.

ModerationApi oferuje rozbudowany zestaw szybkich i bieżących API moderacji. Każda metoda ModerationApi przyjmuje parametr sso i może uwierzytelnić się za pomocą SSO lub ciasteczka sesji FastComments.com.

Quick Start

Korzystanie z uwierzytelnionych API (DefaultApi)

Ważne: Musisz ustawić swój klucz API w ApiClient przed wykonywaniem uwierzytelnionych żądań. Jeśli tego nie zrobisz, żądania zakończą się błędem 401.

require 'fastcomments'

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

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

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

# Now you can make authenticated API calls
begin
  # Example: Add an SSO user
  user_data = {
    id: 'user-123',
    email: 'user@example.com',
    displayName: 'John Doe'
  }

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

rescue FastCommentsClient::ApiError => e
  puts "Error: #{e.response_body}"
  # Common errors:
  # - 401: API key is missing or invalid
  # - 400: Request validation failed
end

Korzystanie z publicznych API (PublicApi)

Publiczne endpointy nie wymagają uwierzytelnienia:

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

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

Korzystanie z API moderacji (ModerationApi)

Metody moderacji napędzają panel moderatora. Przekaż token sso, aby żądanie było wykonywane w imieniu moderatora uwierzytelnionego przez SSO:

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # Example: List comments in the moderation queue
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Typowe problemy

Błąd 401 "missing-api-key": Upewnij się, że ustawiłeś config.api_key['x-api-key'] = 'YOUR_KEY' przed utworzeniem instancji DefaultApi.
Nieprawidłowa klasa API: Użyj DefaultApi dla serwerowych uwierzytelnionych żądań, PublicApi dla żądań po stronie klienta/publicznych oraz ModerationApi dla żądań panelu moderatora.
Nullowy klucz API: SDK cicho pominie uwierzytelnienie, jeśli klucz API jest null, co skutkuje błędami 401.

Notes

Identyfikatory transmisji

Zauważysz, że w niektórych wywołaniach API należy przekazać broadcastId. Gdy otrzymasz zdarzenia, otrzymasz z powrotem ten identyfikator, więc będziesz wiedzieć, aby zignorować zdarzenie, jeśli planujesz optymistycznie zastosować zmiany po stronie klienta (czego prawdopodobnie będziesz chciał zrobić, ponieważ daje to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, by nie wystąpić dwa razy w sesji przeglądarki.

SSO (Logowanie jednokrotne)

Przykłady SSO znajdziesz poniżej.

SSO Usage

Proste SSO

require 'fastcomments'

# Create Simple SSO token
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}"

# Use the SSO token to make an authenticated API call
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

Bezpieczne SSO

require 'fastcomments'

# Create Secure SSO token
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}"

# Use the SSO token to make an authenticated API call
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

aggregate

Agreguje dokumenty poprzez grupowanie ich (jeśli podano groupBy) i stosowanie wielu operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itd.).

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
parentTenantId	string	query	Nie
includeStats	boolean	query	Nie

Odpowiedź

Zwraca: AggregateResponse

Przykład

Przykład agregacji

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest | 
opts = {
  parent_tenant_id: 'parent_tenant_id_example', # String | 
  include_stats: true # Boolean | 
}
begin
  
  result = api_instance.aggregate(tenant_id, aggregation_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate: #{e}"
end

get_audit_logs

Parameters

Name	Type	Location	Required
tenantId	string	query	Tak
limit	number	query	Nie
skip	number	query	Nie
order	string	query	Nie
after	number	query	Nie
before	number	query	Nie

Response

Zwraca: GetAuditLogsResponse

Przykład

Przykład get_audit_logs

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  limit: 1.2, # Float | 
  skip: 1.2, # Float | 
  order: FastCommentsClient::SORTDIR::ASC, # SORTDIR | 
  after: 1.2, # Float | 
  before: 1.2 # Float | 
}
begin
  
  result = api_instance.get_audit_logs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_audit_logs: #{e}"
end

logout_public

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład logout_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
begin
  
  result = api_instance.logout_public
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->logout_public: #{e}"
end

block_from_comment_public

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
commentId	string	path	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: BlockSuccess

Przykład

block_from_comment_public Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->block_from_comment_public: #{e}"
end

un_block_comment_public

Parametry

Name	Type	Location	Required
tenantId	string	zapytanie	Tak
commentId	string	ścieżka	Tak
sso	string	zapytanie	Nie

Odpowiedź

Zwraca: UnblockSuccess

Przykład

un_block_comment_public Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_block_comment_public: #{e}"
end

checked_comments_for_blocked

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
commentIds	string	query	Tak	Lista identyfikatorów komentarzy rozdzielonych przecinkami.
sso	string	query	Nie

Odpowiedź

Zwraca: CheckBlockedCommentsResponse

Przykład

Przykład checked_comments_for_blocked

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_ids = 'comment_ids_example' # String | A comma separated list of comment ids.
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
end

block_user_from_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
userId	string	query	Nie
anonUserId	string	query	Nie

Odpowiedź

Zwraca: BlockSuccess

Przykład

Przykład block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# skonfiguruj autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj uwierzytelnianie kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
end

create_comment_public

Parametry

Name	Typ	Lokalizacja	Wymagane
tenantId	string	ścieżka	Tak
urlId	string	zapytanie	Tak
broadcastId	string	zapytanie	Tak
sessionId	string	zapytanie	Nie
sso	string	zapytanie	Nie

Odpowiedź

Zwraca: SaveCommentsResponseWithPresence

Przykład

Przykład create_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_comment_public: #{e}"
end

delete_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
contextUserId	string	query	Nie
isLive	boolean	query	Nie

Odpowiedź

Zwraca: DeleteCommentResult

Przykład

Przykład użycia delete_comment

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.delete_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_comment: #{e}"
end

delete_comment_public

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
commentId	string	path	Tak
broadcastId	string	query	Tak
editKey	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: PublicAPIDeleteCommentResponse

Przykład

delete_comment_public Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_public: #{e}"
end

delete_comment_vote

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
commentId	string	path	Tak
voteId	string	path	Tak
urlId	string	query	Tak
broadcastId	string	query	Tak
editKey	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: VoteDeleteResponse

Przykład

delete_comment_vote Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_vote: #{e}"
end

flag_comment

Parametry

Name	Type	Location	Required
tenantId	string	zapytanie	Tak
id	string	ścieżka	Tak
userId	string	zapytanie	Nie
anonUserId	string	zapytanie	Nie

Odpowiedź

Zwraca: FlagCommentResponse

Przykład

Przykład flag_comment

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->flag_comment: #{e}"
end

get_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	zapytanie	Tak
id	string	ścieżka	Tak

Odpowiedź

Zwraca: APIGetCommentResponse

Przykład

Przykład get_comment

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji za pomocą klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_comment(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comment: #{e}"
end

get_comment_text

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
commentId	string	path	Tak
editKey	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: PublicAPIGetCommentTextResponse

Przykład

Przykład get_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_text: #{e}"
end

get_comment_vote_user_names

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
commentId	string	path	Tak
dir	integer	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: GetCommentVoteUserNamesSuccessResponse

Przykład

Przykład get_comment_vote_user_names

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
dir = 56 # Integer | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
end

get_comments

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
page	integer	query	Nie
limit	integer	query	Nie
skip	integer	query	Nie
asTree	boolean	query	Nie
skipChildren	integer	query	Nie
limitChildren	integer	query	Nie
maxTreeDepth	integer	query	Nie
urlId	string	query	Nie
userId	string	query	Nie
anonUserId	string	query	Nie
contextUserId	string	query	Nie
hashTag	string	query	Nie
parentId	string	query	Nie
direction	string	query	Nie
fromDate	integer	query	Nie
toDate	integer	query	Nie

Odpowiedź

Zwraca: APIGetCommentsResponse

Przykład

Przykład get_comments

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 56, # Integer | 
  limit: 56, # Integer | 
  skip: 56, # Integer | 
  as_tree: true, # Boolean | 
  skip_children: 56, # Integer | 
  limit_children: 56, # Integer | 
  max_tree_depth: 56, # Integer | 
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example', # String | 
  context_user_id: 'context_user_id_example', # String | 
  hash_tag: 'hash_tag_example', # String | 
  parent_id: 'parent_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  from_date: 789, # Integer | 
  to_date: 789 # Integer | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

get_comments_public

req tenantId urlId

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
urlId	string	query	Tak
page	integer	query	Nie
direction	string	query	Nie
sso	string	query	Nie
skip	integer	query	Nie
skipChildren	integer	query	Nie
limit	integer	query	Nie
limitChildren	integer	query	Nie
countChildren	boolean	query	Nie
fetchPageForCommentId	string	query	Nie
includeConfig	boolean	query	Nie
countAll	boolean	query	Nie
includei10n	boolean	query	Nie
locale	string	query	Nie
modules	string	query	Nie
isCrawler	boolean	query	Nie
includeNotificationCount	boolean	query	Nie
asTree	boolean	query	Nie
maxTreeDepth	integer	query	Nie
useFullTranslationIds	boolean	query	Nie
parentId	string	query	Nie
searchText	string	query	Nie
hashTags	array	query	Nie
userId	string	query	Nie
customConfigStr	string	query	Nie
afterCommentId	string	query	Nie
beforeCommentId	string	query	Nie

Odpowiedź

Zwraca: GetCommentsResponseWithPresencePublicComment

Przykład

Przykład get_comments_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  page: 56, # Integer | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  sso: 'sso_example', # String | 
  skip: 56, # Integer | 
  skip_children: 56, # Integer | 
  limit: 56, # Integer | 
  limit_children: 56, # Integer | 
  count_children: true, # Boolean | 
  fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String | 
  include_config: true, # Boolean | 
  count_all: true, # Boolean | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  modules: 'modules_example', # String | 
  is_crawler: true, # Boolean | 
  include_notification_count: true, # Boolean | 
  as_tree: true, # Boolean | 
  max_tree_depth: 56, # Integer | 
  use_full_translation_ids: true, # Boolean | 
  parent_id: 'parent_id_example', # String | 
  search_text: 'search_text_example', # String | 
  hash_tags: ['inner_example'], # Array<String> | 
  user_id: 'user_id_example', # String | 
  custom_config_str: 'custom_config_str_example', # String | 
  after_comment_id: 'after_comment_id_example', # String | 
  before_comment_id: 'before_comment_id_example' # String | 
}
begin
  
  result = api_instance.get_comments_public(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_public: #{e}"
end

lock_comment

Parametry

Name	Type	Location	Required
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład lock_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->lock_comment: #{e}"
end

pin_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
commentId	string	path	Tak
broadcastId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: ChangeCommentPinStatusResponse

Przykład

Przykład pin_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->pin_comment: #{e}"
end

save_comment

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
isLive	boolean	query	Nie
doSpamCheck	boolean	query	Nie
sendEmails	boolean	query	Nie
populateNotifications	boolean	query	Nie

Odpowiedź

Zwraca: APISaveCommentResponse

Przykład

Przykład save_comment

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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 | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comment(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comment: #{e}"
end

save_comments_bulk

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
isLive	boolean	query	Nie
doSpamCheck	boolean	query	Nie
sendEmails	boolean	query	Nie
populateNotifications	boolean	query	Nie

Odpowiedź

Zwraca: SaveCommentsBulkResponse

Przykład

Przykład użycia save_comments_bulk

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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> | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
end

set_comment_text

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	ścieżka	Tak
commentId	string	ścieżka	Tak
broadcastId	string	zapytanie	Tak
editKey	string	zapytanie	Nie
sso	string	zapytanie	Nie

Odpowiedź

Zwraca: PublicAPISetCommentTextResponse

Przykład

Przykład set_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->set_comment_text: #{e}"
end

un_block_user_from_comment

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
id	string	path	Tak
userId	string	query	Nie
anonUserId	string	query	Nie

Odpowiedź

Zwraca: UnblockSuccess

Przykład

Przykład un_block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
end

un_flag_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
userId	string	query	Nie
anonUserId	string	query	Nie

Odpowiedź

Zwraca: FlagCommentResponse

Przykład

un_flag_comment Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj uwierzytelnianie kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_flag_comment: #{e}"
end

un_lock_comment

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
commentId	string	path	Tak
broadcastId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład un_lock_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_lock_comment: #{e}"
end

un_pin_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	ścieżka	Tak
commentId	string	ścieżka	Tak
broadcastId	string	zapytanie	Tak
sso	string	zapytanie	Nie

Odpowiedź

Zwraca: ChangeCommentPinStatusResponse

Przykład

Przykład un_pin_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_pin_comment: #{e}"
end

update_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
contextUserId	string	query	Nie
doSpamCheck	boolean	query	Nie
isLive	boolean	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład update_comment

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  do_spam_check: true, # Boolean | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_comment: #{e}"
end

vote_comment

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
commentId	string	path	Tak
urlId	string	query	Tak
broadcastId	string	query	Tak
sessionId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: VoteResponse

Przykład

Przykład vote_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->vote_comment: #{e}"
end

get_comments_for_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
userId	string	query	Nie
direction	string	query	Nie
repliesToUserId	string	query	Nie
page	number	query	Nie
includei10n	boolean	query	Nie
locale	string	query	Nie
isCrawler	boolean	query	Nie

Odpowiedź

Zwraca: GetCommentsForUserResponse

Przykład

Przykład get_comments_for_user

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
opts = {
  user_id: 'user_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  replies_to_user_id: 'replies_to_user_id_example', # String | 
  page: 1.2, # Float | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  is_crawler: true # Boolean | 
}
begin
  
  result = api_instance.get_comments_for_user(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_for_user: #{e}"
end

add_domain_config

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: AddDomainConfigResponse

Przykład

Przykład add_domain_config

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 
begin
  
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_domain_config: #{e}"
end

delete_domain_config

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
domain	string	path	Tak

Odpowiedź

Zwraca: DeleteDomainConfigResponse

Przykład

Przykład delete_domain_config

Copy

require 'time'
require 'fastcomments-client'
# Konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

get_domain_config

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
domain	string	path	Tak

Odpowiedź

Zwraca: GetDomainConfigResponse

Przykład

Przykład get_domain_config

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj uwierzytelnianie kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.get_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_config: #{e}"
end

get_domain_configs

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: GetDomainConfigsResponse

Przykład

Przykład get_domain_configs

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_domain_configs(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_configs: #{e}"
end

patch_domain_config

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
domainToUpdate	string	path	Tak

Odpowiedź

Zwraca: PatchDomainConfigResponse

Przykład

Przykład patch_domain_config

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams | 
begin
  
  result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_domain_config: #{e}"
end

put_domain_config

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
domainToUpdate	string	path	Tak

Odpowiedź

Zwraca: PutDomainConfigResponse

Przykład

Przykład put_domain_config

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams | 
begin
  
  result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_domain_config: #{e}"
end

create_email_template

Parametry

Name	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Yes

Odpowiedź

Zwraca: CreateEmailTemplateResponse

Przykład

Przykład create_email_template

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody | 
begin
  
  result = api_instance.create_email_template(tenant_id, create_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_email_template: #{e}"
end

delete_email_template

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

delete_email_template Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

delete_email_template_render_error

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	zapytanie	Tak
id	string	ścieżka	Tak
errorId	string	ścieżka	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład delete_email_template_render_error

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
error_id = 'error_id_example' # String | 
begin
  
  result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
end

get_email_template

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetEmailTemplateResponse

Przykład

Przykład get_email_template

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

get_email_template_definitions

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak

Odpowiedź

Zwraca: GetEmailTemplateDefinitionsResponse

Przykład

Przykład get_email_template_definitions

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_email_template_definitions(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
end

get_email_template_render_errors

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
id	string	path	Tak
skip	number	query	Nie

Odpowiedź

Zwraca: GetEmailTemplateRenderErrorsResponse

Przykład

Przykład get_email_template_render_errors

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
end

get_email_templates

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
skip	number	query	Nie

Odpowiedź

Zwraca: GetEmailTemplatesResponse

Przykład

Przykład get_email_templates

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_templates(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_templates: #{e}"
end

render_email_template

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Yes
locale	string	query	No

Odpowiedź

Zwraca: RenderEmailTemplateResponse

Przykład

Przykład render_email_template

Copy

require 'time'
require 'fastcomments-client'
# ustaw autoryzację
FastCommentsClient.configure do |config|
  # Konfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody | 
opts = {
  locale: 'locale_example' # String | 
}
begin
  
  result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->render_email_template: #{e}"
end

update_email_template

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład update_email_template

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody | 
begin
  
  result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_email_template: #{e}"
end

get_event_log

req tenantId urlId userIdWS

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
urlId	string	query	Tak
userIdWS	string	query	Tak
startTime	integer	query	Tak
endTime	integer	query	Nie

Odpowiedź

Zwraca: GetEventLogResponse

Przykład

Przykład get_event_log

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_event_log: #{e}"
end

get_global_event_log

req tenantId urlId userIdWS

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
urlId	string	query	Tak
userIdWS	string	query	Tak
startTime	integer	query	Tak
endTime	integer	query	Nie

Odpowiedź

Zwraca: GetEventLogResponse

Przykład

Przykład get_global_event_log

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_global_event_log: #{e}"
end

create_feed_post

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
broadcastId	string	query	Nie
isLive	boolean	query	Nie
doSpamCheck	boolean	query	Nie
skipDupCheck	boolean	query	Nie

Odpowiedź

Zwraca: CreateFeedPostsResponse

Przykład

Przykład create_feed_post

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  skip_dup_check: true # Boolean | 
}
begin
  
  result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_feed_post: #{e}"
end

create_feed_post_public

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
broadcastId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: CreateFeedPostResponse

Przykład

Przykład create_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_feed_post_public: #{e}"
end

delete_feed_post_public

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
postId	string	path	Tak
broadcastId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: DeleteFeedPostPublicResponse

Przykład

delete_feed_post_public Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
end

get_feed_posts

req tenantId afterId

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
afterId	string	query	Nie
limit	integer	query	Nie
tags	array	query	Nie

Odpowiedź

Zwraca: GetFeedPostsResponse

Przykład

Przykład get_feed_posts

Copy

require 'time'
require 'fastcomments-client'
# Konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'] # Array<String> | 
}
begin
  
  result = api_instance.get_feed_posts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_feed_posts: #{e}"
end

get_feed_posts_public

req tenantId afterId

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
afterId	string	query	Nie
limit	integer	query	Nie
tags	array	query	Nie
sso	string	query	Nie
isCrawler	boolean	query	Nie
includeUserInfo	boolean	query	Nie

Odpowiedź

Zwraca: PublicFeedPostsResponse

Przykład

Przykład get_feed_posts_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  is_crawler: true, # Boolean | 
  include_user_info: true # Boolean | 
}
begin
  
  result = api_instance.get_feed_posts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
end

get_feed_posts_stats

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
postIds	array	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: FeedPostsStatsResponse

Przykład

get_feed_posts_stats Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_ids = ['inner_example'] # Array<String> | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
end

get_user_reacts_public

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
postIds	array	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: UserReactsResponse

Przykład

Przykład get_user_reacts_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  post_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_reacts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
end

react_feed_post_public

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
postId	string	path	Tak
isUndo	boolean	query	Nie
broadcastId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ReactFeedPostResponse

Przykład

Przykład react_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams | 
opts = {
  is_undo: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->react_feed_post_public: #{e}"
end

update_feed_post

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład update_feed_post

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost | 
begin
  
  result = api_instance.update_feed_post(tenant_id, id, feed_post)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_feed_post: #{e}"
end

update_feed_post_public

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
postId	string	path	Tak
broadcastId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: CreateFeedPostResponse

Przykład

Przykład update_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_feed_post_public: #{e}"
end

flag_comment_public

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
commentId	string	path	Tak
isFlagged	boolean	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład flag_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
is_flagged = true # Boolean | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->flag_comment_public: #{e}"
end

get_gif_large

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	path	Tak
largeInternalURLSanitized	string	query	Tak

Odpowiedź

Zwraca: GifGetLargeResponse

Przykład

Przykład get_gif_large

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
large_internal_url_sanitized = 'large_internal_url_sanitized_example' # String | 
begin
  
  result = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gif_large: #{e}"
end

get_gifs_search

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
search	string	query	Tak
locale	string	query	Nie
rating	string	query	Nie
page	number	query	Nie

Odpowiedź

Zwraca: GetGifsSearchResponse

Przykład

Przykład get_gifs_search

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
search = 'search_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_search(tenant_id, search, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_search: #{e}"
end

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
locale	string	query	Nie
rating	string	query	Nie
page	number	query	Nie

Odpowiedź

Zwraca: GetGifsTrendingResponse

Przykład

Przykład get_gifs_trending

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_trending(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_trending: #{e}"
end

add_hash_tag

Parameters

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Yes

Odpowiedź

Zwraca: CreateHashTagResponse

Przykład

add_hash_tag Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
begin
  
  result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

add_hash_tags_bulk

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Yes

Odpowiedź

Zwraca: BulkCreateHashTagsResponse

Przykład

add_hash_tags_bulk Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
begin
  
  result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

delete_hash_tag

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
tag	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

delete_hash_tag Przykład

Copy

require 'time'
require 'fastcomments-client'
# skonfiguruj autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody | 
begin
  
  result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Błąd podczas wywoływania DefaultApi->delete_hash_tag: #{e}"
end

get_hash_tags

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
page	number	query	Nie

Odpowiedź

Zwraca: GetHashTagsResponse

Przykład

Przykład get_hash_tags

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_hash_tags(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_hash_tags: #{e}"
end

patch_hash_tag

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Yes
tag	string	path	Yes

Odpowiedź

Zwraca: UpdateHashTagResponse

Przykład

patch_hash_tag Przykład

Copy

require 'time'
require 'fastcomments-client'
# skonfiguruj autoryzację
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
begin
  
  result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

delete_moderation_vote

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: VoteDeleteResponse

Przykład

delete_moderation_vote Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Błąd podczas wywoływania ModerationApi->delete_moderation_vote: #{e}"
end

get_api_comments

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

Odpowiedź

Returns: ModerationAPIGetCommentsResponse

Przykład

Przykład get_api_comments

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2, # Float | 
  count: 1.2, # Float | 
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_comments: #{e}"
end

get_api_export_status

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
batchJobId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationExportStatusResponse

Przykład

get_api_export_status Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  batch_job_id: 'batch_job_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_export_status(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_export_status: #{e}"
end

get_api_ids

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
afterId	string	query	No
demo	boolean	query	No
sso	string	query	No

Odpowiedź

Zwraca: ModerationAPIGetCommentIdsResponse

Przykład

get_api_ids Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  after_id: 'after_id_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_ids(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_ids: #{e}"
end

get_ban_users_from_comment

Parameters

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
sso	string	query	Nie

Response

Zwraca: GetBannedUsersFromCommentResponse

Przykład

get_ban_users_from_comment Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_ban_users_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_ban_users_from_comment: #{e}"
end

get_comment_ban_status

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
commentId	string	path	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: GetCommentBanStatusResponse

Przykład

get_comment_ban_status Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_ban_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_ban_status: #{e}"
end

get_comment_children

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationAPIChildCommentsResponse

Przykład

get_comment_children Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_children(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_children: #{e}"
end

get_count

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
text-search	string	query	Nie
byIPFromComment	string	query	Nie
filter	string	query	Nie
searchFilters	string	query	Nie
demo	boolean	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationAPICountCommentsResponse

Przykład

Przykład get_count

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filter: 'filter_example', # String | 
  search_filters: 'search_filters_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_count: #{e}"
end

get_counts

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: GetBannedUsersCountResponse

Przykład

Przykład get_counts

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_counts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_counts: #{e}"
end

get_logs

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationAPIGetLogsResponse

Przykład

Przykład get_logs

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_logs(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_logs: #{e}"
end

get_manual_badges

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: GetTenantManualBadgesResponse

Przykład

Przykład get_manual_badges

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_manual_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_manual_badges: #{e}"
end

get_manual_badges_for_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
badgesUserId	string	query	Nie
commentId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: GetUserManualBadgesResponse

Przykład

Przykład get_manual_badges_for_user

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  badges_user_id: 'badges_user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_manual_badges_for_user(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_manual_badges_for_user: #{e}"
end

get_moderation_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
includeEmail	boolean	query	Nie
includeIP	boolean	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationAPICommentResponse

Przykład

get_moderation_comment Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_email: true, # Boolean | 
  include_ip: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment: #{e}"
end

get_moderation_comment_text

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Odpowiedź

Zwraca: GetCommentTextResponse

Przykład

Przykład get_moderation_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Błąd przy wywoływaniu ModerationApi->get_moderation_comment_text: #{e}"
end

get_pre_ban_summary

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
includeByUserIdAndEmail	boolean	query	Nie
includeByIP	boolean	query	Nie
includeByEmailDomain	boolean	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: PreBanSummary

Przykład

get_pre_ban_summary Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_pre_ban_summary(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_pre_ban_summary: #{e}"
end

get_search_comments_summary

Parameters

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
value	string	query	Nie
filters	string	query	Nie
searchFilters	string	query	Nie
sso	string	query	Nie

Response

Zwraca: ModerationCommentSearchResponse

Example

Przykład get_search_comments_summary

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_comments_summary(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
end

get_search_pages

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
value	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationPageSearchResponse

Przykład

Przykład get_search_pages

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_pages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_pages: #{e}"
end

get_search_sites

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
value	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationSiteSearchResponse

Przykład

get_search_sites Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_sites(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_sites: #{e}"
end

get_search_suggest

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
text-search	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: ModerationSuggestResponse

Przykład

Przykład get_search_suggest

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_suggest(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_suggest: #{e}"
end

get_search_users

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
value	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationUserSearchResponse

Przykład

get_search_users Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_users: #{e}"
end

get_trust_factor

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
userId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: GetUserTrustFactorResponse

Przykład

get_trust_factor Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_trust_factor: #{e}"
end

get_user_ban_preference

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Yes
sso	string	query	No

Odpowiedź

Zwraca: APIModerateGetUserBanPreferencesResponse

Przykład

get_user_ban_preference Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_ban_preference(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_ban_preference: #{e}"
end

get_user_internal_profile

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: GetUserInternalProfileResponse

Przykład

get_user_internal_profile Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_internal_profile(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_internal_profile: #{e}"
end

post_adjust_comment_votes

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: AdjustVotesResponse

Przykład

post_adjust_comment_votes Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_adjust_comment_votes: #{e}"
end

post_api_export

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: ModerationExportResponse

Przykład

post_api_export Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_api_export(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_api_export: #{e}"
end

post_ban_user_from_comment

Parametry

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: BanUserFromCommentResult

Przykład

post_ban_user_from_comment Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  ban_email: true, # Boolean | 
  ban_email_domain: true, # Boolean | 
  ban_ip: true, # Boolean | 
  delete_all_users_comments: true, # Boolean | 
  banned_until: 'banned_until_example', # String | 
  is_shadow_ban: true, # Boolean | 
  update_id: 'update_id_example', # String | 
  ban_reason: 'ban_reason_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_from_comment: #{e}"
end

post_ban_user_undo

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

post_ban_user_undo Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
ban_user_undo_params = FastCommentsClient::BanUserUndoParams.new({changelog: FastCommentsClient::APIBanUserChangeLog.new}) # BanUserUndoParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_undo: #{e}"
end

post_bulk_pre_ban_summary

Parameters

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
includeByUserIdAndEmail	boolean	query	Nie
includeByIP	boolean	query	Nie
includeByEmailDomain	boolean	query	Nie
sso	string	query	Nie

Response

Zwraca: BulkPreBanSummary

Example

post_bulk_pre_ban_summary Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_pre_ban_params = FastCommentsClient::BulkPreBanParams.new({comment_ids: ['comment_ids_example']}) # BulkPreBanParams | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Błąd podczas wywoływania ModerationApi->post_bulk_pre_ban_summary: #{e}"
end

post_comments_by_ids

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: ModerationAPIChildCommentsResponse

Przykład

post_comments_by_ids Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comments_by_ids_params = FastCommentsClient::CommentsByIdsParams.new({ids: ['ids_example']}) # CommentsByIdsParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_comments_by_ids: #{e}"
end

post_flag_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład post_flag_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_flag_comment: #{e}"
end

post_remove_comment

Parametry

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: PostRemoveCommentApiResponse

Przykład

post_remove_comment Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_remove_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Błąd podczas wywoływania ModerationApi->post_remove_comment: #{e}"
end

post_restore_deleted_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

post_restore_deleted_comment Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_restore_deleted_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_restore_deleted_comment: #{e}"
end

post_set_comment_approval_status

Parametry

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
approved	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: SetCommentApprovedResponse

Przykład

post_set_comment_approval_status Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  approved: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_approval_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_approval_status: #{e}"
end

post_set_comment_review_status

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
commentId	string	path	Yes
reviewed	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

post_set_comment_review_status Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  reviewed: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_review_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_review_status: #{e}"
end

post_set_comment_spam_status

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
spam	boolean	query	Nie
permNotSpam	boolean	query	Nie
broadcastId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

post_set_comment_spam_status Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  spam: true, # Boolean | 
  perm_not_spam: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
end

post_set_comment_text

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: SetCommentTextResponse

Przykład

Przykład post_set_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
set_comment_text_params = FastCommentsClient::SetCommentTextParams.new({comment: 'comment_example'}) # SetCommentTextParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_text: #{e}"
end

post_un_flag_comment

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
broadcastId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

post_un_flag_comment Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_un_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_un_flag_comment: #{e}"
end

post_vote

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	path	Tak
direction	string	query	Nie
broadcastId	string	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: VoteResponse

Przykład

post_vote Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  direction: 'direction_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_vote(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_vote: #{e}"
end

put_award_badge

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: AwardUserBadgeResponse

Przykład

put_award_badge Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
badge_id = 'badge_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_award_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_award_badge: #{e}"
end

put_close_thread

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
urlId	string	query	Yes
sso	string	query	No

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

put_close_thread Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_close_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_close_thread: #{e}"
end

put_remove_badge

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: RemoveUserBadgeResponse

Przykład

put_remove_badge Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
badge_id = 'badge_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_remove_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_remove_badge: #{e}"
end

put_reopen_thread

Parametry

Name	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
urlId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

put_reopen_thread Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_reopen_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_reopen_thread: #{e}"
end

set_trust_factor

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

Odpowiedź

Zwraca: SetUserTrustFactorResponse

Przykład

set_trust_factor przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  trust_factor: 'trust_factor_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.set_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->set_trust_factor: #{e}"
end

create_moderator

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Tak

Odpowiedź

Zwraca: CreateModeratorResponse

Przykład

Przykład create_moderator

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody | 
begin
  
  result = api_instance.create_moderator(tenant_id, create_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_moderator: #{e}"
end

delete_moderator

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
sendEmail	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład delete_moderator

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  send_email: 'send_email_example' # String | 
}
begin
  
  result = api_instance.delete_moderator(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_moderator: #{e}"
end

get_moderator

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetModeratorResponse

Przykład

Przykład get_moderator

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

get_moderators

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
skip	number	query	Nie

Odpowiedź

Zwraca: GetModeratorsResponse

Przykład

Przykład get_moderators

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_moderators(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderators: #{e}"
end

send_invite

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
fromName	string	query	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład send_invite

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
from_name = 'from_name_example' # String | 
begin
  
  result = api_instance.send_invite(tenant_id, id, from_name)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_invite: #{e}"
end

update_moderator

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład update_moderator

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację za pomocą klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody | 
begin
  
  result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_moderator: #{e}"
end

delete_notification_count

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład użycia delete_notification_count

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

get_cached_notification_count

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetCachedNotificationCountResponse

Przykład

Przykład get_cached_notification_count

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (wartość domyślna: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_cached_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
end

get_notification_count

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
userId	string	query	Nie
urlId	string	query	Nie
fromCommentId	string	query	Nie
viewed	boolean	query	Nie
type	string	query	Nie

Odpowiedź

Zwraca: GetNotificationCountResponse

Przykład

Przykład get_notification_count

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example' # String | 
}
begin
  
  result = api_instance.get_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notification_count: #{e}"
end

get_notifications

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
userId	string	query	Nie
urlId	string	query	Nie
fromCommentId	string	query	Nie
viewed	boolean	query	Nie
type	string	query	Nie
skip	number	query	Nie

Odpowiedź

Zwraca: GetNotificationsResponse

Przykład

Przykład get_notifications

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notifications: #{e}"
end

update_notification

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
id	string	path	Tak
userId	string	query	Nie

Response

Zwraca: APIEmptyResponse

Przykład

Przykład update_notification

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_notification: #{e}"
end

create_v1_page_react

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
urlId	string	query	Tak
title	string	query	Nie

Odpowiedź

Zwraca: CreateV1PageReact

Przykład

Przykład create_v1_page_react

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v1_page_react(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v1_page_react: #{e}"
end

create_v2_page_react

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
urlId	string	query	Tak
id	string	query	Tak
title	string	query	Nie

Odpowiedź

Zwraca: CreateV1PageReact

Przykład

Przykład create_v2_page_react

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v2_page_react: #{e}"
end

delete_v1_page_react

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	path	Tak
urlId	string	query	Tak

Odpowiedź

Zwraca: CreateV1PageReact

Przykład

delete_v1_page_react Example

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.delete_v1_page_react(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v1_page_react: #{e}"
end

delete_v2_page_react

Parametry

Name	Type	Location	Required
tenantId	string	path	Tak
urlId	string	query	Tak
id	string	query	Tak

Odpowiedź

Zwraca: CreateV1PageReact

Przykład

Przykład delete_v2_page_react

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_v2_page_react(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v2_page_react: #{e}"
end

get_v1_page_likes

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak
urlId	string	zapytanie	Tak

Odpowiedź

Zwraca: GetV1PageLikes

Przykład

get_v1_page_likes Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v1_page_likes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v1_page_likes: #{e}"
end

get_v2_page_react_users

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	path	Tak
urlId	string	query	Tak
id	string	query	Tak

Odpowiedź

Zwraca: GetV2PageReactUsersResponse

Przykład

Przykład get_v2_page_react_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_react_users: #{e}"
end

get_v2_page_reacts

Parametry

Name	Type	Location	Required	Description
tenantId	string	path	Tak
urlId	string	query	Tak

Odpowiedź

Zwraca: GetV2PageReacts

Przykład

Przykład get_v2_page_reacts

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v2_page_reacts(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_reacts: #{e}"
end

add_page

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: AddPageAPIResponse

Przykład

Przykład add_page

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData | 
begin
  
  result = api_instance.add_page(tenant_id, create_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_page: #{e}"
end

delete_page

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: DeletePageAPIResponse

Przykład

Przykład delete_page

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_page(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_page: #{e}"
end

get_offline_users

Poprzedni komentujący na stronie, którzy NIE są obecnie online. Posortowane według displayName. Użyj tego po wyczerpaniu /users/online, aby wyrenderować sekcję "Członkowie". Paginacja kursorowa na commenterName: serwer przeszukuje częściowy {tenantId, urlId, commenterName} indeks od afterName w przód za pomocą $gt, bez kosztu $skip.

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	path	Tak
urlId	string	query	Tak	Identyfikator URL strony (oczyszczany po stronie serwera).
afterName	string	query	Nie	Kursor: przekaż nextAfterName z poprzedniej odpowiedzi.
afterUserId	string	query	Nie	Rozstrzygacz kursorów: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby remisy nazw nie powodowały pominięcia wpisów.

Odpowiedź

Zwraca: PageUsersOfflineResponse

Przykład

Przykład get_offline_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Identyfikator URL strony (oczyszczany po stronie serwera).
opts = {
  after_name: 'after_name_example', # String | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi.
  after_user_id: 'after_user_id_example' # String | Rozstrzygacz kursorów: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby remisy nazw nie powodowały pominięcia wpisów.
}
begin
  
  result = api_instance.get_offline_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_offline_users: #{e}"
end

get_online_users

Aktualnie online widzowie strony: osoby, których sesja websocket jest aktualnie subskrybowana dla tej strony. Zwraca anonCount + totalCount (subskrybenci w pokoju, włącznie z anonimowymi widzami, których nie enumerujemy).

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	path	Tak
urlId	string	query	Tak	Identyfikator URL strony (oczyszczany po stronie serwera).
afterName	string	query	Nie	Kursor: przekaż nextAfterName z poprzedniej odpowiedzi.
afterUserId	string	query	Nie	Rozstrzygacz kursora: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby remisy nazw nie powodowały pominięcia wpisów.

Odpowiedź

Zwraca: PageUsersOnlineResponse

Przykład

Przykład użycia get_online_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Identyfikator URL strony (oczyszczany po stronie serwera).
opts = {
  after_name: 'after_name_example', # String | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi.
  after_user_id: 'after_user_id_example' # String | Rozstrzygacz kursora: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby remisy nazw nie powodowały pominięcia wpisów.
}
begin
  
  result = api_instance.get_online_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_online_users: #{e}"
end

get_page_by_urlid

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
urlId	string	query	Tak

Odpowiedź

Zwraca: GetPageByURLIdAPIResponse

Przykład

Przykład get_page_by_urlid

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_page_by_urlid(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
end

get_pages

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: GetPagesAPIResponse

Przykład

get_pages Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_pages(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pages: #{e}"
end

get_pages_public

Zwraca listę stron dla najemcy. Używane przez desktopowego klienta FChat do wypełnienia jego listy pokoi. Wymaga, aby enableFChat było ustawione na true w ostatecznej niestandardowej konfiguracji dla każdej strony. Strony wymagające SSO są filtrowane pod kątem dostępu grupowego użytkownika wysyłającego żądanie.

Parametry

Name	Type	Location	Required	Description
tenantId	string	path	Yes
cursor	string	query	No	Niejawny kursor paginacji zwrócony jako `nextCursor` z wcześniejszego żądania. Powiązany z tym samym `sortBy`.
limit	integer	query	No	1..200, domyślnie 50
q	string	query	No	Opcjonalny filtr prefiksowy tytułu ignorujący wielkość liter.
sortBy	string	query	No	Kolejność sortowania. `updatedAt` (domyślnie, najnowsze najpierw), `commentCount` (najwięcej komentarzy najpierw), lub `title` (alfabetycznie).
hasComments	boolean	query	No	Jeśli true, zwróć tylko strony mające co najmniej jeden komentarz.

Odpowiedź

Zwraca: GetPublicPagesResponse

Przykład

Przykład get_pages_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  cursor: 'cursor_example', # String | Niejawny kursor paginacji zwrócony jako `nextCursor` z wcześniejszego żądania. Powiązany z tym samym `sortBy`.
  limit: 56, # Integer | 1..200, domyślnie 50
  q: 'q_example', # String | Opcjonalny filtr prefiksowy tytułu ignorujący wielkość liter.
  sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Kolejność sortowania. `updatedAt` (domyślnie, najnowsze najpierw), `commentCount` (najwięcej komentarzy najpierw), lub `title` (alfabetycznie).
  has_comments: true # Boolean | Jeśli true, zwróć tylko strony mające co najmniej jeden komentarz.
}
begin
  
  result = api_instance.get_pages_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_pages_public: #{e}"
end

get_users_info

Zbiorcze informacje o użytkownikach dla najemcy. Dla podanych userIds zwraca informacje wyświetlane z User / SSOUser. Używane przez widżet komentarzy do wzbogacania informacji o użytkownikach, którzy właśnie pojawili się poprzez zdarzenie obecności. Brak kontekstu strony: prywatność jest egzekwowana jednolicie (profile prywatne są maskowane).

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	path	Tak
ids	string	query	Tak	Identyfikatory userIds rozdzielone przecinkami.

Odpowiedź

Zwraca: PageUsersInfoResponse

Przykład

Przykład get_users_info

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
ids = 'ids_example' # String | Identyfikatory userIds rozdzielone przecinkami.
begin
  
  result = api_instance.get_users_info(tenant_id, ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_users_info: #{e}"
end

patch_page

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: PatchPageAPIResponse

Przykład

Przykład patch_page

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData | 
begin
  
  result = api_instance.patch_page(tenant_id, id, update_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_page: #{e}"
end

delete_pending_webhook_event

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład delete_pending_webhook_event

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_pending_webhook_event(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
end

get_pending_webhook_event_count

Parametry

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

Odpowiedź

Zwraca: GetPendingWebhookEventCountResponse

Przykład

Przykład get_pending_webhook_event_count

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
end

get_pending_webhook_events

Parametry

Name	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
commentId	string	query	Nie
externalId	string	query	Nie
eventType	string	query	Nie
type	string	query	Nie
domain	string	query	Nie
attemptCountGT	number	query	Nie
skip	number	query	Nie

Odpowiedź

Zwraca: GetPendingWebhookEventsResponse

Przykład

Przykład get_pending_webhook_events

Copy

require 'time'
require 'fastcomments-client'
# skonfiguruj autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_events(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
end

create_question_config

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: CreateQuestionConfigResponse

Przykład

Przykład create_question_config

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody | 
begin
  
  result = api_instance.create_question_config(tenant_id, create_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_config: #{e}"
end

delete_question_config

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład delete_question_config

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_config: #{e}"
end

get_question_config

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetQuestionConfigResponse

Przykład

Przykład get_question_config

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

get_question_configs

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
skip	number	query	Nie

Odpowiedź

Zwraca: GetQuestionConfigsResponse

Przykład

Przykład get_question_configs

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_configs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_configs: #{e}"
end

update_question_config

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład update_question_config

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody | 
begin
  
  result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_config: #{e}"
end

create_question_result

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak

Odpowiedź

Zwraca: CreateQuestionResultResponse

Przykład

create_question_result Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody | 
begin
  
  result = api_instance.create_question_result(tenant_id, create_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_result: #{e}"
end

delete_question_result

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład delete_question_result

Copy

require 'time'
require 'fastcomments-client'
# Konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

get_question_result

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetQuestionResultResponse

Przykład

Przykład get_question_result

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

get_question_results

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
urlId	string	query	Nie
userId	string	query	Nie
startDate	string	query	Nie
questionId	string	query	Nie
questionIds	string	query	Nie
skip	number	query	Nie

Odpowiedź

Zwraca: GetQuestionResultsResponse

Przykład

Przykład get_question_results

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  start_date: 'start_date_example', # String | 
  question_id: 'question_id_example', # String | 
  question_ids: 'question_ids_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_results: #{e}"
end

update_question_result

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

update_question_result Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody | 
begin
  
  result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_result: #{e}"
end

aggregate_question_results

Parametry

Name	Type	Location	Required
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

Odpowiedź

Zwraca: AggregateQuestionResultsResponse

Przykład

Przykład aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# ustaw autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.aggregate_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
end

bulk_aggregate_question_results

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
forceRecalculate	boolean	query	Nie

Odpowiedź

Zwraca: BulkAggregateQuestionResultsResponse

Przykład

bulk_aggregate_question_results Przykład

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest | 
opts = {
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
end

combine_comments_with_question_results

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
questionId	string	query	Nie
questionIds	array	query	Nie
urlId	string	query	Nie
startDate	string	query	Nie
forceRecalculate	boolean	query	Nie
minValue	number	query	Nie
maxValue	number	query	Nie
limit	number	query	Nie

Odpowiedź

Zwraca: CombineQuestionResultsWithCommentsResponse

Przykład

Przykład combine_comments_with_question_results

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true, # Boolean | 
  min_value: 1.2, # Float | 
  max_value: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.combine_comments_with_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
end

add_sso_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: AddSSOUserAPIResponse

Przykład

Przykład add_sso_user

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData | 
begin
  
  result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_sso_user: #{e}"
end

delete_sso_user

Parametry

Name	Type	Lokalizacja	Wymagane
tenantId	string	zapytanie	Tak
id	string	ścieżka	Tak
deleteComments	boolean	zapytanie	Nie
commentDeleteMode	string	zapytanie	Nie

Odpowiedź

Zwraca: DeleteSSOUserAPIResponse

Przykład

Przykład delete_sso_user

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: true, # Boolean | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_sso_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_sso_user: #{e}"
end

get_sso_user_by_email

Parametry

Nazwa	Typ	Location	Wymagane	Opis
tenantId	string	query	Tak
email	string	path	Tak

Odpowiedź

Zwraca: GetSSOUserByEmailAPIResponse

Przykład

Przykład get_sso_user_by_email

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
email = 'email_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_email(tenant_id, email)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
end

get_sso_user_by_id

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	zapytanie	Tak
id	string	ścieżka	Tak

Odpowiedź

Zwraca: GetSSOUserByIdAPIResponse

Przykład

Przykład get_sso_user_by_id

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
end

get_sso_users

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
skip	integer	query	Nie

Odpowiedź

Zwraca: GetSSOUsersResponse

Przykład

Przykład użycia get_sso_users

Copy

require 'time'
require 'fastcomments-client'
# Konfiguracja uwierzytelniania
FastCommentsClient.configure do |config|
  # Skonfiguruj uwierzytelnianie klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (wartość domyślna to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 56 # Integer | 
}
begin
  
  result = api_instance.get_sso_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_users: #{e}"
end

patch_sso_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
updateComments	boolean	query	Nie

Odpowiedź

Zwraca: PatchSSOUserAPIResponse

Przykład

patch_sso_user Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_sso_user: #{e}"
end

put_sso_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	zapytanie	Tak
id	string	ścieżka	Tak
updateComments	boolean	zapytanie	Nie

Odpowiedź

Zwraca: PutSSOUserAPIResponse

Przykład

Przykład put_sso_user

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_sso_user: #{e}"
end

create_subscription

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak

Response

Zwraca: CreateSubscriptionAPIResponse

Przykład

Przykład create_subscription

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData | 
begin
  
  result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_subscription: #{e}"
end

delete_subscription

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
id	string	path	Tak
userId	string	query	Nie

Odpowiedź

Zwraca: DeleteSubscriptionAPIResponse

Przykład

Przykład delete_subscription

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.delete_subscription(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_subscription: #{e}"
end

get_subscriptions

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
userId	string	query	Nie

Odpowiedź

Zwraca: GetSubscriptionsAPIResponse

Przykład

get_subscriptions Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_subscriptions(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_subscriptions: #{e}"
end

update_subscription

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
userId	string	query	Nie

Odpowiedź

Zwraca: UpdateSubscriptionAPIResponse

Przykład

Przykład update_subscription

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_subscription: #{e}"
end

get_tenant_daily_usages

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
yearNumber	number	query	Nie
monthNumber	number	query	Nie
dayNumber	number	query	Nie
skip	number	query	Nie

Odpowiedź

Zwraca: GetTenantDailyUsagesResponse

Przykład

Przykład get_tenant_daily_usages

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  year_number: 1.2, # Float | 
  month_number: 1.2, # Float | 
  day_number: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_daily_usages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
end

create_tenant_package

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: CreateTenantPackageResponse

Przykład

Przykład create_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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 | 
begin
  
  result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_package: #{e}"
end

delete_tenant_package

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład delete_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# skonfiguruj autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
end

get_tenant_package

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetTenantPackageResponse

Przykład

Przykład get_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

get_tenant_packages

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
skip	number	query	Nie

Odpowiedź

Zwraca: GetTenantPackagesResponse

Przykład

Przykład get_tenant_packages

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_packages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
end

replace_tenant_package

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Yes
id	string	path	Yes

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

replace_tenant_package Przykład

Copy

require 'time'
require 'fastcomments-client'
# ustaw autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_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 | 
begin
  
  result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
end

update_tenant_package

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

update_tenant_package Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody | 
begin
  
  result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_package: #{e}"
end

create_tenant_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: CreateTenantUserResponse

Przykład

create_tenant_user Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody | 
begin
  
  result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_user: #{e}"
end

delete_tenant_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład delete_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: 'delete_comments_example', # String | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_tenant_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
end

get_tenant_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetTenantUserResponse

Przykład

Przykład get_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

get_tenant_users

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
skip	number	query	Nie

Odpowiedź

Zwraca: GetTenantUsersResponse

Przykład

Przykład get_tenant_users

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_users: #{e}"
end

replace_tenant_user

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
id	string	path	Tak
updateComments	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład replace_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# Konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
end

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
redirectURL	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład send_login_link

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  redirect_url: 'redirect_url_example' # String | 
}
begin
  
  result = api_instance.send_login_link(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_login_link: #{e}"
end

update_tenant_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
updateComments	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład update_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_user: #{e}"
end

create_tenant

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: CreateTenantResponse

Przykład

Przykład create_tenant

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody | 
begin
  
  result = api_instance.create_tenant(tenant_id, create_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant: #{e}"
end

delete_tenant

Parametry

Name	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
sure	string	query	Nie

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład użycia delete_tenant

Copy

require 'time'
require 'fastcomments-client'
# ustawienie autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  sure: 'sure_example' # String | 
}
begin
  
  result = api_instance.delete_tenant(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant: #{e}"
end

get_tenant

Parametry

Name	Type	Location	Wymagane	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetTenantResponse

Przykład

Przykład get_tenant

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

get_tenants

Parametry

Name	Type	Lokalizacja	Wymagane
tenantId	string	query	Tak
meta	string	query	Nie
skip	number	query	Nie

Odpowiedź

Zwraca: GetTenantsResponse

Przykład

get_tenants Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (wartość domyślna: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  meta: 'meta_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenants(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenants: #{e}"
end

update_tenant

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptyResponse

Przykład

Przykład update_tenant

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody | 
begin
  
  result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant: #{e}"
end

change_ticket_state

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
userId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: ChangeTicketStateResponse

Przykład

Przykład change_ticket_state

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
id = 'id_example' # String | 
change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody | 
begin
  
  result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->change_ticket_state: #{e}"
end

create_ticket

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
userId	string	query	Tak

Odpowiedź

Zwraca: CreateTicketResponse

Przykład

Przykład create_ticket

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody | 
begin
  
  result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_ticket: #{e}"
end

get_ticket

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
id	string	path	Tak
userId	string	query	Nie

Odpowiedź

Zwraca: GetTicketResponse

Przykład

Przykład get_ticket

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_ticket(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_ticket: #{e}"
end

get_tickets

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
userId	string	query	Nie
state	number	query	Nie
skip	number	query	Nie
limit	number	query	Nie

Odpowiedź

Zwraca: GetTicketsResponse

Przykład

Przykład get_tickets

Copy

require 'time'
require 'fastcomments-client'
# skonfiguruj autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  state: 1.2, # Float | 
  skip: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tickets(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tickets: #{e}"
end

get_translations

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
namespace	string	path	Tak
component	string	path	Tak
locale	string	query	Nie
useFullTranslationIds	boolean	query	Nie

Odpowiedź

Zwraca: GetTranslationsResponse

Przykład

Przykład użycia get_translations

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
namespace = 'namespace_example' # String | 
component = 'component_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  use_full_translation_ids: true # Boolean | 
}
begin
  
  result = api_instance.get_translations(namespace, component, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_translations: #{e}"
end

upload_image

Prześlij i zmień rozmiar obrazu

Parametry

Name	Type	Location	Required	Description
tenantId	string	path	Yes
sizePreset	string	query	No	Predefiniowany rozmiar: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń)
urlId	string	query	No	Id strony, z której odbywa się przesyłanie, używany do konfiguracji

Odpowiedź

Zwraca: UploadImageResponse

Przykład

Przykład upload_image

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
file = File.new('/path/to/some/file') # File | 
opts = {
  size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Predefiniowany rozmiar: \"Default\" (1000x1000px) lub \"CrossPlatform\" (tworzy rozmiary dla popularnych urządzeń)
  url_id: 'url_id_example' # String | Id strony, z której odbywa się przesyłanie, używany do konfiguracji
}
begin
  
  result = api_instance.upload_image(tenant_id, file, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->upload_image: #{e}"
end

get_user_badge_progress_by_id

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIGetUserBadgeProgressResponse

Przykład

Przykład get_user_badge_progress_by_id

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
end

get_user_badge_progress_by_user_id

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
userId	string	path	Tak

Odpowiedź

Zwraca: APIGetUserBadgeProgressResponse

Przykład

Przykład get_user_badge_progress_by_user_id

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
end

get_user_badge_progress_list

Parametry

Name	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
userId	string	query	Nie
limit	number	query	Nie
skip	number	query	Nie

Odpowiedź

Zwraca: APIGetUserBadgeProgressListResponse

Przykład

Przykład get_user_badge_progress_list

Copy

require 'time'
require 'fastcomments-client'
# skonfiguruj autoryzację
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badge_progress_list(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
end

create_user_badge

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak

Odpowiedź

Zwraca: APICreateUserBadgeResponse

Przykład

Przykład create_user_badge

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams | 
begin
  
  result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_user_badge: #{e}"
end

delete_user_badge

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptySuccessResponse

Przykład

delete_user_badge Przykład

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_user_badge: #{e}"
end

get_user_badge

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIGetUserBadgeResponse

Przykład

Przykład użycia get_user_badge

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację kluczem API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

get_user_badges

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
userId	string	query	Nie
badgeId	string	query	Nie
type	number	query	Nie
displayedOnComments	boolean	query	Nie
limit	number	query	Nie
skip	number	query	Nie

Odpowiedź

Zwraca: APIGetUserBadgesResponse

Przykład

Przykład get_user_badges

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  badge_id: 'badge_id_example', # String | 
  type: 1.2, # Float | 
  displayed_on_comments: true, # Boolean | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badges: #{e}"
end

update_user_badge

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: APIEmptySuccessResponse

Przykład

Przykład update_user_badge

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams | 
begin
  
  result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_user_badge: #{e}"
end

get_user_notification_count

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: GetUserNotificationCountResponse

Przykład

Przykład get_user_notification_count

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notification_count: #{e}"
end

get_user_notifications

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
urlId	string	query	Nie	Używane do ustalenia, czy bieżąca strona jest subskrybowana.
pageSize	integer	query	Nie
afterId	string	query	Nie
includeContext	boolean	query	Nie
afterCreatedAt	integer	query	Nie
unreadOnly	boolean	query	Nie
dmOnly	boolean	query	Nie
noDm	boolean	query	Nie
includeTranslations	boolean	query	Nie
includeTenantNotifications	boolean	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: GetMyNotificationsResponse

Przykład

Przykład get_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | Używane do ustalenia, czy bieżąca strona jest subskrybowana.
  page_size: 56, # Integer | 
  after_id: 'after_id_example', # String | 
  include_context: true, # Boolean | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  include_translations: true, # Boolean | 
  include_tenant_notifications: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notifications: #{e}"
end

reset_user_notification_count

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: ResetUserNotificationsResponse

Przykład

Przykład reset_user_notification_count

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
end

reset_user_notifications

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
afterId	string	query	Nie
afterCreatedAt	integer	query	Nie
unreadOnly	boolean	query	Nie
dmOnly	boolean	query	Nie
noDm	boolean	query	Nie
sso	string	query	Nie

Odpowiedź

Zwraca: ResetUserNotificationsResponse

Przykład

Przykład reset_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notifications: #{e}"
end

update_user_notification_comment_subscription_status

Włącz lub wyłącz powiadomienia dla konkretnego komentarza.

Parametry

Name	Type	Location	Required
tenantId	string	query	Yes
notificationId	string	path	Yes
optedInOrOut	string	path	Yes
commentId	string	query	Yes
sso	string	query	No

Odpowiedź

Zwraca: UpdateUserNotificationCommentSubscriptionStatusResponse

Przykład

update_user_notification_comment_subscription_status Przykład

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
opted_in_or_out = 'in' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
end

update_user_notification_page_subscription_status

Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy subskrybują stronę, tworzone są powiadomienia dla nowych komentarzy głównych, i także

Parameters

Name	Type	Location	Required
tenantId	string	query	Tak
urlId	string	query	Tak
url	string	query	Tak
pageTitle	string	query	Tak
subscribedOrUnsubscribed	string	path	Tak
sso	string	query	Nie

Response

Zwraca: UpdateUserNotificationPageSubscriptionStatusResponse

Przykład

Przykład update_user_notification_page_subscription_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
url = 'url_example' # String | 
page_title = 'page_title_example' # String | 
subscribed_or_unsubscribed = 'subscribe' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
end

update_user_notification_status

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
notificationId	string	path	Tak
newStatus	string	path	Tak
sso	string	query	Nie

Odpowiedź

Zwraca: UpdateUserNotificationStatusResponse

Przykład

Przykład update_user_notification_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
new_status = 'read' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_status: #{e}"
end

get_user_presence_statuses

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
urlIdWS	string	query	Tak
userIds	string	query	Tak

Odpowiedź

Zwraca: GetUserPresenceStatusesResponse

Przykład

Przykład get_user_presence_statuses

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id_ws = 'url_id_ws_example' # String | 
user_ids = 'user_ids_example' # String | 
begin
  
  result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
end

search_users

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	ścieżka	Tak
urlId	string	zapytanie	Tak
usernameStartsWith	string	zapytanie	Nie
mentionGroupIds	array	zapytanie	Nie
sso	string	zapytanie	Nie
searchSection	string	zapytanie	Nie

Odpowiedź

Zwraca: SearchUsersResult

Przykład

Przykład użycia search_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  username_starts_with: 'username_starts_with_example', # String | 
  mention_group_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  search_section: 'fast' # String | 
}
begin
  
  result = api_instance.search_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->search_users: #{e}"
end

get_user

Parametry

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	query	Tak
id	string	path	Tak

Odpowiedź

Zwraca: GetUserResponse

Przykład

Przykład get_user

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następną linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

create_vote

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
commentId	string	query	Tak
direction	string	query	Tak
userId	string	query	Nie
anonUserId	string	query	Nie

Odpowiedź

Zwraca: VoteResponse

Przykład

Przykład create_vote

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
direction = 'up' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_vote: #{e}"
end

delete_vote

Parametry

Nazwa	Typ	Lokalizacja	Wymagane
tenantId	string	query	Tak
id	string	path	Tak
editKey	string	query	Nie

Odpowiedź

Zwraca: VoteDeleteResponse

Przykład

Przykład delete_vote

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Skonfiguruj autoryzację klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  edit_key: 'edit_key_example' # String | 
}
begin
  
  result = api_instance.delete_vote(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_vote: #{e}"
end

get_votes

Parametry

Name	Type	Location	Required	Description
tenantId	string	query	Tak
urlId	string	query	Tak

Odpowiedź

Zwraca: GetVotesResponse

Przykład

Przykład get_votes

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj poniższą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_votes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes: #{e}"
end

get_votes_for_user

Parametry

Name	Type	Location	Required
tenantId	string	query	Tak
urlId	string	query	Tak
userId	string	query	Nie
anonUserId	string	query	Nie

Odpowiedź

Zwraca: GetVotesForUserResponse

Przykład

Przykład get_votes_for_user

Copy

require 'time'
require 'fastcomments-client'
# konfiguracja autoryzacji
FastCommentsClient.configure do |config|
  # Konfiguracja autoryzacji klucza API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Odkomentuj następującą linię, aby ustawić prefiks dla klucza API, np. 'Bearer' (domyślnie nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
end

Potrzebujesz pomocy?

Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące Ruby SDK, prosimy:

Współtworzenie

Wkład jest mile widziany! Prosimy odwiedzić repozytorium GitHub po wytyczne dotyczące kontrybucji.

Język 🇵🇱 Polski

Dokumentacja

Rozpoczęcie

Użycie

Agregacja

Logi audytu

Uwierzytelnianie

Blokowanie z komentarza

Sprawdź zablokowane komentarze

Komentarze

Komentarze For User

Konfiguracje domen

Szablony e-mail

Log zdarzeń

Posty w kanale

Zgłoś komentarz

Gify

Hashtagi

Moderacja

Moderatorzy

Liczba powiadomień

Powiadomienia

Reakcje na stronie

Strony

Oczekujące zdarzenia webhook

Konfiguracje pytań

Wyniki pytań

Agregacja wyników pytań

Użytkownicy SSO

Subskrypcje

Użycie dzienne najemcy

Pakiety najemcy

Użytkownicy najemcy

Najemcy

Zgłoszenia

Tłumaczenia

Prześlij obraz

Postęp odznak użytkownika

Odznaki użytkownika

Powiadomienia użytkownika

Status obecności użytkownika

Wyszukiwanie użytkowników

Użytkownicy

Głosy

FastComments Ruby SDK

Repozytorium

AI coding agents

Installation

Zawartość biblioteki

Publiczne vs zabezpieczone API

Quick Start

Korzystanie z uwierzytelnionych API (DefaultApi)

Korzystanie z publicznych API (PublicApi)

Korzystanie z API moderacji (ModerationApi)

Typowe problemy

Notes

Identyfikatory transmisji

SSO (Logowanie jednokrotne)

SSO Usage

Proste SSO

Bezpieczne SSO

aggregate

Parametry

Odpowiedź

Przykład

get_audit_logs

Parameters

Response

Przykład

logout_public

Odpowiedź

Przykład

block_from_comment_public

Parametry

Odpowiedź

Przykład

un_block_comment_public

Parametry

Odpowiedź

Przykład