FastComments.com

FastComments 루비 SDK

이것은 FastComments의 공식 Ruby SDK입니다.

FastComments API의 공식 Ruby SDK

리포지토리

GitHub에서 보기


설치 Internal Link

Add this line to your application's Gemfile:

gem 'fastcomments'

And then execute:

bundle install

Or install it yourself as:

gem install fastcomments

Library Contents

This library contains the generated API client and the SSO utilities to make working with the API easier.

Public vs Secured APIs

For the API client, there are three classes, DefaultApi, PublicApi, and ModerationApi. The DefaultApi contains methods that require your API key, and PublicApi contains api calls that can be made directly from a browser/mobile device/etc without authentication. The ModerationApi contains the methods that power the moderator dashboard.

The ModerationApi provides an extensive suite of live and fast moderation APIs. Every ModerationApi method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie.

빠른 시작 Internal Link


인​증​된​ API​ 사용 (DefaultApi)

중요: 인증된 요청을 만들기 전에 ApiClient에 API 키를 설정해야 합니다. 설정하지 않으면 요청이 401 오류와 함께 실패합니다.

require 'fastcomments'

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

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

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

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

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

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

공개​ API​ 사용 (PublicApi)

공개 엔드포인트는 인증이 필요하지 않습니다:

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

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

중재​ API​ 사용 (ModerationApi)

중재 메서드는 모더레이터 대시보드를 구동합니다. sso 토큰을 전달하면 요청이 SSO 인증된 모더레이터를 대신해 수행됩니다:

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

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

일반적인 문제

  1. 401 "missing-api-key" 오류: DefaultApi 인스턴스를 만들기 전에 config.api_key['x-api-key'] = 'YOUR_KEY'를 설정했는지 확인하십시오.
  2. 잘못된 API 클래스: 서버 측 인증 요청에는 DefaultApi를, 클라이언트 측/공개 요청에는 PublicApi를, 모더레이터 대시보드 요청에는 ModerationApi를 사용하세요.
  3. Null API 키: API 키가 null이면 SDK가 인증을 조용히 건너뛰게 되며, 이로 인해 401 오류가 발생합니다.

참고 Internal Link

브로드캐스트 ID

일부 API 호출에서는 broadcastId를 전달해야 한다는 것을 보게 될 것입니다. 이벤트를 수신하면 이 ID가 반환되므로, 클라이언트에서 변경을 낙관적으로 적용하려는 경우 해당 이벤트를 무시해야 하는지 알 수 있습니다 (이는 최상의 사용자 경험을 제공하므로 아마 그렇게 하고 싶을 것입니다). 여기에 UUID를 전달하세요. 이 ID는 브라우저 세션에서 두 번 발생하지 않을 만큼 충분히 고유해야 합니다.

SSO (싱글 사인온)

SSO 예제는 아래를 참조하세요.

SSO 사용법 Internal Link

간단한 SSO

require 'fastcomments'

# Simple SSO 토큰 생성
user = FastComments::SSO::SimpleSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  avatar: 'https://example.com/avatar.jpg'
)

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

puts "SSO Token: #{token}"

# 인증된 API 호출을 위해 SSO 토큰 사용
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

보안 SSO

require 'fastcomments'

# 보안 SSO 토큰 생성
user = FastComments::SSO::SecureSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  username: 'johndoe',
  avatar: 'https://example.com/avatar.jpg'
)

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

puts "Secure SSO Token: #{token}"

# 인증된 API 호출을 위해 SSO 토큰 사용
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}"

집계 Internal Link

문서를 그룹화(groupBy가 제공된 경우)하고 여러 연산을 적용하여 집계합니다. sum, countDistinct, avg 등 다양한 연산을 지원합니다.

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
parentTenantIdstringquery아니오
includeStatsbooleanquery아니오

응답

반환: AggregateResponse

예제

aggregate 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |
15opts = {
16 parent_tenant_id: 'parent_tenant_id_example', # String |
17 include_stats: true # Boolean |
18}
19
20begin
21
22 result = api_instance.aggregate(tenant_id, aggregation_request, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->aggregate: #{e}"
26end
27

감사 로그 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
limitnumberquery아니오
skipnumberquery아니오
orderstringquery아니오
afternumberquery아니오
beforenumberquery아니오

응답

반환: GetAuditLogsResponse

예제

get_audit_logs 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석 처리를 제거하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 limit: 1.2, # Float |
16 skip: 1.2, # Float |
17 order: FastCommentsClient::SORTDIR::ASC, # SORTDIR |
18 after: 1.2, # Float |
19 before: 1.2 # Float |
20}
21
22begin
23
24 result = api_instance.get_audit_logs(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_audit_logs: #{e}"
28end
29

공개 로그아웃 Internal Link

응답

반환: APIEmptyResponse

예제

logout_public 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6
7begin
8
9 result = api_instance.logout_public
10 p result
11rescue FastCommentsClient::ApiError => e
12 puts "Error when calling PublicApi->logout_public: #{e}"
13end
14

공개 댓글에서 차단 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
commentIdstringpath
ssostringquery아니요

응답

반환: BlockSuccess

예제

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

공개 댓글 차단 해제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstring쿼리
commentIdstring경로
ssostring쿼리아니오

응답

반환: UnblockSuccess

예제

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

차단된 댓글 확인 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdsstringquery쉼표로 구분된 댓글 ID 목록.
ssostringquery아니오

응답

반환: CheckBlockedCommentsResponse

예제

checked_comments_for_blocked 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_ids = 'comment_ids_example' # String | 쉼표로 구분된 댓글 ID 목록.
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
18end
19

댓글에서 사용자 차단 Internal Link


매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath
userIdstringquery아니오
anonUserIdstringquery아니오

응답

반환: BlockSuccess

예제

block_user_from_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 해제하여 API 키 접두사(예: 'Bearer')를 설정하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
27end
28

공개 댓글 생성 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringquery아니요
ssostringquery아니요

응답

반환: SaveCommentsResponseWithPresence

예제

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

댓글 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
isLivebooleanqueryNo

응답

반환: DeleteCommentResult

예제

delete_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 context_user_id: 'context_user_id_example', # String |
17 is_live: true # Boolean |
18}
19
20begin
21
22 result = api_instance.delete_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_comment: #{e}"
26end
27

공개 댓글 삭제 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringquery아니요
ssostringquery아니요

응답

반환: PublicAPIDeleteCommentResponse

예제

delete_comment_public 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8broadcast_id = 'broadcast_id_example' # 문자열 |
9opts = {
10 edit_key: 'edit_key_example', # 문자열 |
11 sso: 'sso_example' # 문자열 |
12}
13
14begin
15
16 result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->delete_comment_public: #{e}"
20end
21

댓글 투표 삭제 Internal Link


매개변수

이름유형위치필수설명
tenantIdstringpath
commentIdstringpath
voteIdstringpath
urlIdstringquery
broadcastIdstringquery
editKeystringquery아니요
ssostringquery아니요

응답

반환: VoteDeleteResponse

예제

delete_comment_vote 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8vote_id = 'vote_id_example' # String |
9url_id = 'url_id_example' # String |
10broadcast_id = 'broadcast_id_example' # String |
11opts = {
12 edit_key: 'edit_key_example', # String |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->delete_comment_vote: #{e}"
22end
23

댓글 신고 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath
userIdstringquery아니오
anonUserIdstringquery아니오

응답

반환: FlagCommentResponse

예제

flag_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석 처리를 해제하세요 (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15opts = {
16 user_id: 'user_id_example', # 문자열 |
17 anon_user_id: 'anon_user_id_example' # 문자열 |
18}
19
20begin
21
22 result = api_instance.flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->flag_comment: #{e}"
26end
27

댓글 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIGetCommentResponse

예제

get_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키 접두사를 설정하려면 다음 줄의 주석을 해제하세요(예: 'Bearer') (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_comment(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_comment: #{e}"
22end
23

댓글 텍스트 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
commentIdstringpath
editKeystringquery아니오
ssostringquery아니오

응답

반환: PublicAPIGetCommentTextResponse

예제

get_comment_text 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 edit_key: 'edit_key_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.get_comment_text(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_text: #{e}"
19end
20

댓글 투표 사용자 이름 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringpath
commentIdstringpath
dirintegerquery
ssostringquery아니오

응답

반환: GetCommentVoteUserNamesSuccessResponse

예제

get_comment_vote_user_names 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8dir = 56 # 정수 |
9opts = {
10 sso: 'sso_example' # 문자열 |
11}
12
13begin
14
15 result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
19end
20

댓글 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo
fromDateintegerqueryNo
toDateintegerqueryNo

응답

반환: APIGetCommentsResponse

예제

get_comments 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14opts = {
15 page: 56, # 정수 |
16 limit: 56, # 정수 |
17 skip: 56, # 정수 |
18 as_tree: true, # 부울 |
19 skip_children: 56, # 정수 |
20 limit_children: 56, # 정수 |
21 max_tree_depth: 56, # 정수 |
22 url_id: 'url_id_example', # 문자열 |
23 user_id: 'user_id_example', # 문자열 |
24 anon_user_id: 'anon_user_id_example', # 문자열 |
25 context_user_id: 'context_user_id_example', # 문자열 |
26 hash_tag: 'hash_tag_example', # 문자열 |
27 parent_id: 'parent_id_example', # 문자열 |
28 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
29 from_date: 789, # 정수 |
30 to_date: 789 # 정수 |
31}
32
33begin
34
35 result = api_instance.get_comments(tenant_id, opts)
36 p result
37rescue FastCommentsClient::ApiError => e
38 puts "Error when calling DefaultApi->get_comments: #{e}"
39end
40

공개 댓글 가져오기 Internal Link

요청 tenantId urlId

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
pageintegerquery아니오
directionstringquery아니오
ssostringquery아니오
skipintegerquery아니오
skipChildrenintegerquery아니오
limitintegerquery아니오
limitChildrenintegerquery아니오
countChildrenbooleanquery아니오
fetchPageForCommentIdstringquery아니오
includeConfigbooleanquery아니오
countAllbooleanquery아니오
includei10nbooleanquery아니오
localestringquery아니오
modulesstringquery아니오
isCrawlerbooleanquery아니오
includeNotificationCountbooleanquery아니오
asTreebooleanquery아니오
maxTreeDepthintegerquery아니오
useFullTranslationIdsbooleanquery아니오
parentIdstringquery아니오
searchTextstringquery아니오
hashTagsarrayquery아니오
userIdstringquery아니오
customConfigStrstringquery아니오
afterCommentIdstringquery아니오
beforeCommentIdstringquery아니오

응답

반환: GetCommentsResponseWithPresencePublicComment

예제

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

댓글 잠금 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringquery아니요

응답

반환값: APIEmptyResponse

예제

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

댓글 고정 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringquery아니요

응답

반환: ChangeCommentPinStatusResponse

예제

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

댓글 저장 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery
isLivebooleanquery아니오
doSpamCheckbooleanquery아니오
sendEmailsbooleanquery아니오
populateNotificationsbooleanquery아니오

응답

반환: APISaveCommentResponse

예제

save_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석 처리를 해 API 키 접두사를 설정하세요. 예: 'Bearer' (기본값 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comment(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comment: #{e}"
28end
29

댓글 일괄 저장 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
isLivebooleanquery아니오
doSpamCheckbooleanquery아니오
sendEmailsbooleanquery아니오
populateNotificationsbooleanquery아니오

응답

반환: SaveCommentsBulkResponse

예제

save_comments_bulk 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
28end
29

댓글 텍스트 설정 Internal Link

매개변수

이름타입Location필수설명
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringquery아니요
ssostringquery아니요

응답

반환: PublicAPISetCommentTextResponse

예제

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

댓글에서 사용자 차단 해제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath
userIdstringquery아니요
anonUserIdstringquery아니요

응답

반환: UnblockSuccess

예제

un_block_user_from_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
27end
28

댓글 신고 취소 Internal Link


매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath
userIdstringquery아니요
anonUserIdstringquery아니요

응답

반환: FlagCommentResponse

예제

un_flag_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 해제하여 API 키에 대한 접두사를 설정하십시오. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15opts = {
16 user_id: 'user_id_example', # 문자열 |
17 anon_user_id: 'anon_user_id_example' # 문자열 |
18}
19
20begin
21
22 result = api_instance.un_flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->un_flag_comment: #{e}"
26end
27

댓글 잠금 해제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringquery아니요

응답

반환: APIEmptyResponse

예제

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

댓글 고정 해제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringquery아니요

응답

반환: ChangeCommentPinStatusResponse

예제

un_pin_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8broadcast_id = 'broadcast_id_example' # 문자열 |
9opts = {
10 sso: 'sso_example' # 문자열 |
11}
12
13begin
14
15 result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_pin_comment: #{e}"
19end
20

댓글 업데이트 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath
contextUserIdstringquery아니요
doSpamCheckbooleanquery아니요
isLivebooleanquery아니요

응답

반환: APIEmptyResponse

예제

update_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사(예: 'Bearer', 기본값: nil)를 설정하려면 다음 줄의 주석 처리를 해제하세요
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams |
16opts = {
17 context_user_id: 'context_user_id_example', # String |
18 do_spam_check: true, # Boolean |
19 is_live: true # Boolean |
20}
21
22begin
23
24 result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->update_comment: #{e}"
28end
29

댓글 투표 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
commentIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringquery아니오
ssostringquery아니오

응답

반환: VoteResponse

예제

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

사용자용 댓글 가져오기 Internal Link

매개변수

이름유형위치필수설명
userIdstringquery아니오
directionstringquery아니오
repliesToUserIdstringquery아니오
pagenumberquery아니오
includei10nbooleanquery아니오
localestringquery아니오
isCrawlerbooleanquery아니오

응답

반환: GetCommentsForUserResponse

예제

get_comments_for_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6opts = {
7 user_id: 'user_id_example', # 문자열(String) |
8 direction: FastCommentsClient::SortDirections::OF, # SortDirections(정렬 방향) |
9 replies_to_user_id: 'replies_to_user_id_example', # 문자열(String) |
10 page: 1.2, # 실수(Float) |
11 includei10n: true, # 불리언(Boolean) |
12 locale: 'locale_example', # 문자열(String) |
13 is_crawler: true # 불리언(Boolean) |
14}
15
16begin
17
18 result = api_instance.get_comments_for_user(opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->get_comments_for_user: #{e}"
22end
23

도메인 구성 추가 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery

응답

반환: AddDomainConfigResponse

예제

add_domain_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |
15
16begin
17
18 result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_domain_config: #{e}"
22end
23

도메인 구성 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
domainstringpath

응답

반환: DeleteDomainConfigResponse

예제

delete_domain_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.delete_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_domain_config: #{e}"
22end
23

도메인 구성 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
domainstringpath

응답

반환: GetDomainConfigResponse

예제

get_domain_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.get_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_domain_config: #{e}"
22end
23

도메인 구성 목록 가져오기 Internal Link


매개변수

이름형식위치필수설명
tenantIdstringquery

응답

반환: GetDomainConfigsResponse

예제

get_domain_configs 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14
15begin
16
17 result = api_instance.get_domain_configs(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_domain_configs: #{e}"
21end
22

도메인 구성 부분 업데이트 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
domainToUpdatestringpath

응답

반환: PatchDomainConfigResponse

예제

patch_domain_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams |
16
17begin
18
19 result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_domain_config: #{e}"
23end
24

도메인 구성 전체 업데이트 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
domainToUpdatestringpath

응답

반환: PutDomainConfigResponse

예제

put_domain_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams |
16
17begin
18
19 result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->put_domain_config: #{e}"
23end
24

이메일 템플릿 생성 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery

응답

반환: CreateEmailTemplateResponse

예제

create_email_template 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody |
15
16begin
17
18 result = api_instance.create_email_template(tenant_id, create_email_template_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_email_template: #{e}"
22end
23

이메일 템플릿 삭제 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

delete_email_template 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_email_template: #{e}"
22end
23

이메일 템플릿 렌더링 오류 삭제 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath
errorIdstringpath

응답

반환: APIEmptyResponse

예제

delete_email_template_render_error 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15error_id = 'error_id_example' # String |
16
17begin
18
19 result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
23end
24

이메일 템플릿 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath

응답

반환: GetEmailTemplateResponse

예제

get_email_template 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15
16begin
17
18 result = api_instance.get_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_email_template: #{e}"
22end
23

이메일 템플릿 정의 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery

응답

반환: GetEmailTemplateDefinitionsResponse

예제

get_email_template_definitions 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_email_template_definitions(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
21end
22

이메일 템플릿 렌더링 오류 가져오기 Internal Link


매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
skipnumberquery아니오

응답

반환: GetEmailTemplateRenderErrorsResponse

예제

get_email_template_render_errors 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
25end
26

이메일 템플릿 목록 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
skipnumberquery아니오

응답

반환: GetEmailTemplatesResponse

예제

get_email_templates 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_email_templates(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_email_templates: #{e}"
24end
25

이메일 템플릿 렌더링 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery
localestringquery아니오

응답

반환: RenderEmailTemplateResponse

예제

render_email_template 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody |
15opts = {
16 locale: 'locale_example' # String |
17}
18
19begin
20
21 result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->render_email_template: #{e}"
25end
26

이메일 템플릿 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

update_email_template 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody |
16
17begin
18
19 result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_email_template: #{e}"
23end
24

이벤트 로그 가져오기 Internal Link

req tenantId urlId userIdWS

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery아니오

응답

반환: GetEventLogResponse

예제

get_event_log 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id = 'url_id_example' # 문자열 |
8user_id_ws = 'user_id_ws_example' # 문자열 |
9start_time = 789 # 정수 |
10opts = {
11 end_time: 789 # 정수 |
12}
13
14begin
15
16 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_event_log: #{e}"
20end
21

글로벌 이벤트 로그 가져오기 Internal Link

req tenantId urlId userIdWS

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery아니오

응답

반환: GetEventLogResponse

예제

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

피드 게시물 생성 Internal Link

매개변수

이름타입Location필수설명
tenantIdstringquery
broadcastIdstringquery아니요
isLivebooleanquery아니요
doSpamCheckbooleanquery아니요
skipDupCheckbooleanquery아니요

응답

반환: CreateFeedPostsResponse

예제

create_feed_post 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
15opts = {
16 broadcast_id: 'broadcast_id_example', # String |
17 is_live: true, # Boolean |
18 do_spam_check: true, # Boolean |
19 skip_dup_check: true # Boolean |
20}
21
22begin
23
24 result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->create_feed_post: #{e}"
28end
29

공개 피드 게시물 생성 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
broadcastIdstringquery아니요
ssostringquery아니요

응답

반환: CreateFeedPostResponse

예제

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

공개 피드 게시물 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
postIdstringpath
broadcastIdstringquery아니오
ssostringquery아니오

응답

반환: DeleteFeedPostPublicResponse

예제

delete_feed_post_public 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7post_id = 'post_id_example' # 문자열 |
8opts = {
9 broadcast_id: 'broadcast_id_example', # 문자열 |
10 sso: 'sso_example' # 문자열 |
11}
12
13begin
14
15 result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
19end
20

피드 게시물 가져오기 Internal Link

req tenantId afterId

매개변수

이름타입위치필수설명
tenantIdstringquery
afterIdstringquery아니오
limitintegerquery아니오
tagsarrayquery아니오

응답

반환: GetFeedPostsResponse

예제

get_feed_posts 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 after_id: 'after_id_example', # String |
16 limit: 56, # Integer |
17 tags: ['inner_example'] # Array<String> |
18}
19
20begin
21
22 result = api_instance.get_feed_posts(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_feed_posts: #{e}"
26end
27

공개 피드 게시물 가져오기 Internal Link

req tenantId afterId

매개변수

NameTypeLocationRequiredDescription
tenantIdstringpath
afterIdstringquery아니오
limitintegerquery아니오
tagsarrayquery아니오
ssostringquery아니오
isCrawlerbooleanquery아니오
includeUserInfobooleanquery아니오

응답

반환: PublicFeedPostsResponse

예제

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

피드 게시물 통계 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
postIdsarrayquery
ssostringquery아니요

응답

반환: FeedPostsStatsResponse

예제

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

공개 사용자 리액션 가져오기 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringpath
postIdsarrayquery아니요
ssostringquery아니요

응답

반환: UserReactsResponse

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

공개 피드 게시물에 리액트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringpath
postIdstringpath
isUndobooleanquery아니요
broadcastIdstringquery아니요
ssostringquery아니요

응답

반환: ReactFeedPostResponse

예제

react_feed_post_public 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams |
9opts = {
10 is_undo: true, # Boolean |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->react_feed_post_public: #{e}"
21end
22

피드 게시물 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

update_feed_post 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 해제하여 API 키의 접두사를 설정합니다. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost |
16
17begin
18
19 result = api_instance.update_feed_post(tenant_id, id, feed_post)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_feed_post: #{e}"
23end
24

공개 피드 게시물 업데이트 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringpath
postIdstringpath
broadcastIdstringquery아니오
ssostringquery아니오

응답

반환: CreateFeedPostResponse

예제

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

공개 댓글 신고 Internal Link


매개변수

이름형식위치필수설명
tenantIdstringquery
commentIdstringpath
isFlaggedbooleanquery
ssostringquery아니요

응답

반환: APIEmptyResponse

예제

flag_comment_public 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8is_flagged = true # 불리언 |
9opts = {
10 sso: 'sso_example' # 문자열 |
11}
12
13begin
14
15 result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->flag_comment_public: #{e}"
19end
20

큰 GIF 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringpath
largeInternalURLSanitizedstringquery

응답

반환: GifGetLargeResponse

예제

get_gif_large 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7large_internal_url_sanitized = 'large_internal_url_sanitized_example' # 문자열 |
8
9begin
10
11 result = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_gif_large: #{e}"
15end
16

GIF 검색 Internal Link


매개변수

이름형식위치필수설명
tenantIdstringpath
searchstringquery
localestringquery아니오
ratingstringquery아니오
pagenumberquery아니오

응답

반환: GetGifsSearchResponse

예제

get_gifs_search 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7search = 'search_example' # String |
8opts = {
9 locale: 'locale_example', # String |
10 rating: 'rating_example', # String |
11 page: 1.2 # Float |
12}
13
14begin
15
16 result = api_instance.get_gifs_search(tenant_id, search, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_gifs_search: #{e}"
20end
21

매개변수

이름형식위치필수설명
tenantIdstring경로
localestring쿼리아니오
ratingstring쿼리아니오
pagenumber쿼리아니오

응답

반환: GetGifsTrendingResponse

예제

get_gifs_trending 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7opts = {
8 locale: 'locale_example', # 문자열 |
9 rating: 'rating_example', # 문자열 |
10 page: 1.2 # 실수 |
11}
12
13begin
14
15 result = api_instance.get_gifs_trending(tenant_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_gifs_trending: #{e}"
19end
20

해시태그 추가 Internal Link

매개변수

이름유형위치필요설명
tenantIdstringqueryYes

응답

반환: CreateHashTagResponse

예제

add_hash_tag 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 권한 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 아래 줄의 주석을 해제하십시오, 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
15
16begin
17
18 result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
22end
23

해시태그 일괄 추가 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes

응답

반환: BulkCreateHashTagsResponse

예시

add_hash_tags_bulk 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석을 해제하세요, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
15
16begin
17
18 result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
22end
23

해시태그 삭제 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
tagstringpath

응답

반환: APIEmptyResponse

예시

delete_hash_tag 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 아래 라인의 주석을 해제하십시오, 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14tag = 'tag_example' # String |
15delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody |
16
17begin
18
19 result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
23end
24

해시태그 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
pagenumberquery아니오

응답

반환: GetHashTagsResponse

예제

get_hash_tags 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_hash_tags(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_hash_tags: #{e}"
24end
25

해시태그 부분 업데이트 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
tagstringpath

응답

반환: UpdateHashTagResponse

예시

patch_hash_tag 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석을 해제하세요, 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14tag = 'tag_example' # String |
15update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
16
17begin
18
19 result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
23end
24

모더레이션 투표 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
voteIdstringpath
broadcastIdstringquery아니오
ssostringquery아니오

응답

반환: VoteDeleteResponse

예시

delete_moderation_vote 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8vote_id = 'vote_id_example' # String |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->delete_moderation_vote: #{e}"
20end
21

API 댓글 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
pagenumberqueryNo
countnumberqueryNo
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
demobooleanqueryNo
ssostringqueryNo

응답

반환: ModerationAPIGetCommentsResponse

예제

get_api_comments 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 page: 1.2, # Float |
9 count: 1.2, # Float |
10 text_search: 'text_search_example', # String |
11 by_ip_from_comment: 'by_ip_from_comment_example', # String |
12 filters: 'filters_example', # String |
13 search_filters: 'search_filters_example', # String |
14 sorts: 'sorts_example', # String |
15 demo: true, # Boolean |
16 sso: 'sso_example' # String |
17}
18
19begin
20
21 result = api_instance.get_api_comments(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling ModerationApi->get_api_comments: #{e}"
25end
26

API 내보내기 상태 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringqueryYes
batchJobIdstringqueryNo
ssostringqueryNo

응답

반환: ModerationExportStatusResponse

예제

get_api_export_status 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 batch_job_id: 'batch_job_id_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_api_export_status(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_api_export_status: #{e}"
18end
19

API ID 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
text-searchstringquery아니오
byIPFromCommentstringquery아니오
filtersstringquery아니오
searchFiltersstringquery아니오
afterIdstringquery아니오
demobooleanquery아니오
ssostringquery아니오

응답

반환: ModerationAPIGetCommentIdsResponse

예시

get_api_ids 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # 문자열 |
9 by_ip_from_comment: 'by_ip_from_comment_example', # 문자열 |
10 filters: 'filters_example', # 문자열 |
11 search_filters: 'search_filters_example', # 문자열 |
12 after_id: 'after_id_example', # 문자열 |
13 demo: true, # 부울 |
14 sso: 'sso_example' # 문자열 |
15}
16
17begin
18
19 result = api_instance.get_api_ids(tenant_id, opts)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling ModerationApi->get_api_ids: #{e}"
23end
24

댓글에서 차단된 사용자 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
ssostringquery아니오

응답

반환: GetBannedUsersFromCommentResponse

예시

get_ban_users_from_comment 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8opts = {
9 sso: 'sso_example' # 문자열 |
10}
11
12begin
13
14 result = api_instance.get_ban_users_from_comment(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_ban_users_from_comment: #{e}"
18end
19

댓글 차단 상태 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
ssostringquery아니오

응답

반환: GetCommentBanStatusResponse

예제

get_comment_ban_status 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_comment_ban_status(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_comment_ban_status: #{e}"
18end
19

댓글 하위 항목 가져오기 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
ssostringquery아니오

Response

반환: ModerationAPIChildCommentsResponse

Example

get_comment_children 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8opts = {
9 sso: 'sso_example' # 문자열 |
10}
11
12begin
13
14 result = api_instance.get_comment_children(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_comment_children: #{e}"
18end
19

카운트 가져오기 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Response

반환: ModerationAPICountCommentsResponse

예시

get_count 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filter: 'filter_example', # String |
11 search_filters: 'search_filters_example', # String |
12 demo: true, # Boolean |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.get_count(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling ModerationApi->get_count: #{e}"
22end
23

카운트 목록 가져오기 Internal Link

Parameters

이름타입위치필수설명
tenantIdstringquery
ssostringquery아니오

Response

반환: GetBannedUsersCountResponse

Example

get_counts 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.get_counts(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling ModerationApi->get_counts: #{e}"
17end
18

로그 가져오기 Internal Link

Parameters

이름타입위치필수설명
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

반환: ModerationAPIGetLogsResponse

Example

get_logs 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8opts = {
9 sso: 'sso_example' # 문자열 |
10}
11
12begin
13
14 result = api_instance.get_logs(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_logs: #{e}"
18end
19

수동 배지 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
ssostringqueryNo

응답

반환: GetTenantManualBadgesResponse

예시

get_manual_badges 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7opts = {
8 sso: 'sso_example' # 문자열 |
9}
10
11begin
12
13 result = api_instance.get_manual_badges(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling ModerationApi->get_manual_badges: #{e}"
17end
18

사용자용 수동 배지 가져오기 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

Response

반환: GetUserManualBadgesResponse

Example

get_manual_badges_for_user 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7opts = {
8 badges_user_id: 'badges_user_id_example', # 문자열 |
9 comment_id: 'comment_id_example', # 문자열 |
10 sso: 'sso_example' # 문자열 |
11}
12
13begin
14
15 result = api_instance.get_manual_badges_for_user(tenant_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->get_manual_badges_for_user: #{e}"
19end
20

모더레이션 댓글 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
includeEmailbooleanquery아니오
includeIPbooleanquery아니오
ssostringquery아니오

응답

반환: ModerationAPICommentResponse

예시

get_moderation_comment 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8opts = {
9 include_email: true, # 부울 |
10 include_ip: true, # 부울 |
11 sso: 'sso_example' # 문자열 |
12}
13
14begin
15
16 result = api_instance.get_moderation_comment(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->get_moderation_comment: #{e}"
20end
21

모더레이션 댓글 텍스트 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
ssostringquery아니오

응답

반환: GetCommentTextResponse

예시

get_moderation_comment_text 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_moderation_comment_text(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_moderation_comment_text: #{e}"
18end
19

사전 차단 요약 가져오기 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
includeByUserIdAndEmailbooleanquery아니오
includeByIPbooleanquery아니오
includeByEmailDomainbooleanquery아니오
ssostringquery아니오

응답

반환: PreBanSummary

예시

get_pre_ban_summary 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 include_by_user_id_and_email: true, # Boolean |
10 include_by_ip: true, # Boolean |
11 include_by_email_domain: true, # Boolean |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.get_pre_ban_summary(tenant_id, comment_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->get_pre_ban_summary: #{e}"
21end
22

댓글 검색 요약 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
valuestringquery아니오
filtersstringquery아니오
searchFiltersstringquery아니오
ssostringquery아니오

응답

반환: ModerationCommentSearchResponse

예시

get_search_comments_summary 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 value: 'value_example', # String |
9 filters: 'filters_example', # String |
10 search_filters: 'search_filters_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.get_search_comments_summary(tenant_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
20end
21

페이지 검색 결과 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
valuestringquery아니오
ssostringquery아니오

응답

반환: ModerationPageSearchResponse

예시

get_search_pages 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7opts = {
8 value: 'value_example', # 문자열 |
9 sso: 'sso_example' # 문자열 |
10}
11
12begin
13
14 result = api_instance.get_search_pages(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_pages: #{e}"
18end
19

사이트 검색 결과 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

응답

반환: ModerationSiteSearchResponse

예시

get_search_sites 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 value: 'value_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_search_sites(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_sites: #{e}"
18end
19

검색 제안 가져오기 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringquery
text-searchstringquery아니오
ssostringquery아니오

Response

반환: ModerationSuggestResponse

Example

get_search_suggest 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_search_suggest(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_suggest: #{e}"
18end
19

사용자 검색 결과 가져오기 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

Response

반환: ModerationUserSearchResponse

Example

get_search_users 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 value: 'value_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_search_users(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_search_users: #{e}"
18end
19

신뢰 점수 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
userIdstringquery아니오
ssostringquery아니오

응답

반환: GetUserTrustFactorResponse

예제

get_trust_factor 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 user_id: 'user_id_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_trust_factor(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_trust_factor: #{e}"
18end
19

사용자 차단 환경설정 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
ssostringqueryNo

응답

Returns: APIModerateGetUserBanPreferencesResponse

예시

get_user_ban_preference 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7opts = {
8 sso: 'sso_example' # 문자열 |
9}
10
11begin
12
13 result = api_instance.get_user_ban_preference(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling ModerationApi->get_user_ban_preference: #{e}"
17end
18

사용자 내부 프로필 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
commentIdstringquery아니오
ssostringquery아니오

응답

반환: GetUserInternalProfileResponse

예시

get_user_internal_profile 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 comment_id: 'comment_id_example', # String |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_user_internal_profile(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_user_internal_profile: #{e}"
18end
19

댓글 투표 조정 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
broadcastIdstringquery아니오
ssostringquery아니오

응답

Returns: AdjustVotesResponse

예시

post_adjust_comment_votes 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # 문자열 |
11 sso: 'sso_example' # 문자열 |
12}
13
14begin
15
16 result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_adjust_comment_votes: #{e}"
20end
21

API 내보내기 요청 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

응답

반환: ModerationExportResponse

예시

post_api_export 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filters: 'filters_example', # String |
11 search_filters: 'search_filters_example', # String |
12 sorts: 'sorts_example', # String |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.post_api_export(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling ModerationApi->post_api_export: #{e}"
22end
23

댓글에서 사용자 차단 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

응답

반환: BanUserFromCommentResult

예시

post_ban_user_from_comment 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 ban_email: true, # Boolean |
10 ban_email_domain: true, # Boolean |
11 ban_ip: true, # Boolean |
12 delete_all_users_comments: true, # Boolean |
13 banned_until: 'banned_until_example', # String |
14 is_shadow_ban: true, # Boolean |
15 update_id: 'update_id_example', # String |
16 ban_reason: 'ban_reason_example', # String |
17 sso: 'sso_example' # String |
18}
19
20begin
21
22 result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling ModerationApi->post_ban_user_from_comment: #{e}"
26end
27

사용자 차단 취소 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringqueryYes
ssostringqueryNo

Response

반환: APIEmptyResponse

Example

post_ban_user_undo 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7ban_user_undo_params = FastCommentsClient::BanUserUndoParams.new({changelog: FastCommentsClient::APIBanUserChangeLog.new}) # BanUserUndoParams |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->post_ban_user_undo: #{e}"
18end
19

대량 사전 차단 요약 요청 Internal Link

Parameters

이름유형위치필수설명
tenantIdstringquery
includeByUserIdAndEmailbooleanquery아니오
includeByIPbooleanquery아니오
includeByEmailDomainbooleanquery아니오
ssostringquery아니오

Response

반환: BulkPreBanSummary

예시

post_bulk_pre_ban_summary 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7bulk_pre_ban_params = FastCommentsClient::BulkPreBanParams.new({comment_ids: ['comment_ids_example']}) # BulkPreBanParams |
8opts = {
9 include_by_user_id_and_email: true, # 불리언 |
10 include_by_ip: true, # 불리언 |
11 include_by_email_domain: true, # 불리언 |
12 sso: 'sso_example' # 문자열 |
13}
14
15begin
16
17 result = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->post_bulk_pre_ban_summary: #{e}"
21end
22

ID로 댓글 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
ssostringquery아니오

응답

반환: ModerationAPIChildCommentsResponse

예시

post_comments_by_ids 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comments_by_ids_params = FastCommentsClient::CommentsByIdsParams.new({ids: ['ids_example']}) # CommentsByIdsParams |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "ModerationApi->post_comments_by_ids 호출 시 오류 발생: #{e}"
18end
19

댓글 신고 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
broadcastIdstringquery아니오
ssostringquery아니오

응답

반환: APIEmptyResponse

예시

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

댓글 제거 Internal Link

Parameters

이름타입위치필수설명
tenantIdstringquery
commentIdstringpath
broadcastIdstringquery아니요
ssostringquery아니요

Response

반환: PostRemoveCommentApiResponse

Example

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

삭제된 댓글 복원 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

응답

반환: APIEmptyResponse

예시

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

댓글 승인 상태 설정 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
commentIdstringpathYes
approvedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

응답

반환: SetCommentApprovedResponse

예시

post_set_comment_approval_status 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 approved: true, # Boolean |
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_set_comment_approval_status(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_set_comment_approval_status: #{e}"
20end
21

댓글 검토 상태 설정 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringqueryYes
commentIdstringpathYes
reviewedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

응답

Returns: APIEmptyResponse

예시

post_set_comment_review_status 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 reviewed: true, # Boolean |
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_set_comment_review_status(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_set_comment_review_status: #{e}"
20end
21

댓글 스팸 상태 설정 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
commentIdstringpath
spambooleanquery아니오
permNotSpambooleanquery아니오
broadcastIdstringquery아니오
ssostringquery아니오

응답

반환: APIEmptyResponse

예시

post_set_comment_spam_status 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 spam: true, # Boolean |
10 perm_not_spam: true, # Boolean |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
21end
22

댓글 텍스트 설정 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

응답

Returns: SetCommentTextResponse

예시

post_set_comment_text 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8set_comment_text_params = FastCommentsClient::SetCommentTextParams.new({comment: 'comment_example'}) # SetCommentTextParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_set_comment_text: #{e}"
20end
21

댓글 신고 취소 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
commentIdstringpath
broadcastIdstringquery아니오
ssostringquery아니오

응답

반환: APIEmptyResponse

예시

post_un_flag_comment 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7comment_id = 'comment_id_example' # 문자열 |
8opts = {
9 broadcast_id: 'broadcast_id_example', # 문자열 |
10 sso: 'sso_example' # 문자열 |
11}
12
13begin
14
15 result = api_instance.post_un_flag_comment(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->post_un_flag_comment: #{e}"
19end
20

투표 제출 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
commentIdstringpathYes
directionstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

응답

반환: VoteResponse

예시

post_vote 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 direction: 'direction_example', # String |
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_vote(tenant_id, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_vote: #{e}"
20end
21

배지 수여 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
badgeIdstringquery
userIdstringquery아니오
commentIdstringquery아니오
broadcastIdstringquery아니오
ssostringquery아니오

응답

반환: AwardUserBadgeResponse

예시

put_award_badge 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7badge_id = 'badge_id_example' # String |
8opts = {
9 user_id: 'user_id_example', # String |
10 comment_id: 'comment_id_example', # String |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.put_award_badge(tenant_id, badge_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->put_award_badge: #{e}"
21end
22

스레드 닫기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

응답

반환: APIEmptyResponse

예시

put_close_thread 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.put_close_thread(tenant_id, url_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->put_close_thread: #{e}"
18end
19

배지 제거 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

응답

반환: RemoveUserBadgeResponse

예시

put_remove_badge 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7badge_id = 'badge_id_example' # 문자열 |
8opts = {
9 user_id: 'user_id_example', # 문자열 |
10 comment_id: 'comment_id_example', # 문자열 |
11 broadcast_id: 'broadcast_id_example', # 문자열 |
12 sso: 'sso_example' # 문자열 |
13}
14
15begin
16
17 result = api_instance.put_remove_badge(tenant_id, badge_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->put_remove_badge: #{e}"
21end
22

스레드 재열기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
urlIdstringquery
ssostringquery아니오

응답

반환: APIEmptyResponse

예시

put_reopen_thread 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id = 'url_id_example' # 문자열 |
8opts = {
9 sso: 'sso_example' # 문자열 |
10}
11
12begin
13
14 result = api_instance.put_reopen_thread(tenant_id, url_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->put_reopen_thread: #{e}"
18end
19

신뢰 점수 설정 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
userIdstringquery아니오
trustFactorstringquery아니오
ssostringquery아니오

응답

반환: SetUserTrustFactorResponse

예시

set_trust_factor 예시
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 user_id: 'user_id_example', # String |
9 trust_factor: 'trust_factor_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.set_trust_factor(tenant_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling ModerationApi->set_trust_factor: #{e}"
19end
20

모더레이터 생성 Internal Link


매개변수

이름형식위치필수설명
tenantIdstringquery

응답

반환: CreateModeratorResponse

예제

create_moderator 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody |
15
16begin
17
18 result = api_instance.create_moderator(tenant_id, create_moderator_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_moderator: #{e}"
22end
23

모더레이터 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
sendEmailstringquery아니오

응답

반환: APIEmptyResponse

예제

delete_moderator 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요(기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 send_email: 'send_email_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_moderator(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_moderator: #{e}"
25end
26

모더레이터 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: GetModeratorResponse

예제

get_moderator 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요(예: 'Bearer') (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_moderator(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_moderator: #{e}"
22end
23

모더레이터 목록 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
skipnumberquery아니오

응답

반환: GetModeratorsResponse

예제

get_moderators 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_moderators(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_moderators: #{e}"
24end
25

초대 전송 Internal Link


매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath
fromNamestringquery

응답

반환: APIEmptyResponse

예제

send_invite 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 제거하세요 (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15from_name = 'from_name_example' # String |
16
17begin
18
19 result = api_instance.send_invite(tenant_id, id, from_name)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->send_invite: #{e}"
23end
24

모더레이터 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

응답

반환: APIEmptyResponse

예제

update_moderator 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody |
16
17begin
18
19 result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_moderator: #{e}"
23end
24

알림 수 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

delete_notification_count 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_notification_count: #{e}"
22end
23

캐시된 알림 수 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringqueryYes
idstringpathYes

응답

반환: GetCachedNotificationCountResponse

예제

get_cached_notification_count 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_cached_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
22end
23

알림 수 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
userIdstringquery아니오
urlIdstringquery아니오
fromCommentIdstringquery아니오
viewedbooleanquery아니오
typestringquery아니오

응답

반환: GetNotificationCountResponse

예제

get_notification_count 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example' # String |
20}
21
22begin
23
24 result = api_instance.get_notification_count(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_notification_count: #{e}"
28end
29

알림 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
userIdstringquery아니오
urlIdstringquery아니오
fromCommentIdstringquery아니오
viewedbooleanquery아니오
typestringquery아니오
skipnumberquery아니오

응답

반환: GetNotificationsResponse

예제

get_notifications 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_notifications(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_notifications: #{e}"
29end
30

알림 업데이트 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery
idstringpath
userIdstringquery아니요

응답

반환: APIEmptyResponse

예제

update_notification 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_notification: #{e}"
26end
27

v1 페이지 반응 생성 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
titlestringquery아니오

응답

반환: CreateV1PageReact

예제

create_v1_page_react 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id = 'url_id_example' # 문자열 |
8opts = {
9 title: 'title_example' # 문자열 |
10}
11
12begin
13
14 result = api_instance.create_v1_page_react(tenant_id, url_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->create_v1_page_react: #{e}"
18end
19

v2 페이지 반응 생성 Internal Link


매개변수

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery
idstringquery
titlestringquery아니오

응답

반환: CreateV1PageReact

예제

create_v2_page_react 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id = 'url_id_example' # 문자열 |
8id = 'id_example' # 문자열 |
9opts = {
10 title: 'title_example' # 문자열 |
11}
12
13begin
14
15 result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->create_v2_page_react: #{e}"
19end
20

v1 페이지 반응 삭제 Internal Link


매개변수

이름타입위치필수설명
tenantIdstringpath
urlIdstringquery

응답

반환: CreateV1PageReact

예제

delete_v1_page_react 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id = 'url_id_example' # 문자열 |
8
9begin
10
11 result = api_instance.delete_v1_page_react(tenant_id, url_id)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->delete_v1_page_react: #{e}"
15end
16

v2 페이지 반응 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
idstringquery

응답

반환: CreateV1PageReact

예제

delete_v2_page_react 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id = 'url_id_example' # 문자열 |
8id = 'id_example' # 문자열 |
9
10begin
11
12 result = api_instance.delete_v2_page_react(tenant_id, url_id, id)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->delete_v2_page_react: #{e}"
16end
17

v1 페이지 좋아요 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringpath
urlIdstringquery

응답

반환: GetV1PageLikes

예제

get_v1_page_likes 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id = 'url_id_example' # 문자열 |
8
9begin
10
11 result = api_instance.get_v1_page_likes(tenant_id, url_id)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_v1_page_likes: #{e}"
15end
16

v2 페이지 반응 사용자 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
idstringquery

응답

반환: GetV2PageReactUsersResponse

예제

get_v2_page_react_users 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8id = 'id_example' # String |
9
10begin
11
12 result = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->get_v2_page_react_users: #{e}"
16end
17

v2 페이지 반응 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringpath
urlIdstringquery

응답

반환: GetV2PageReacts

예제

get_v2_page_reacts 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8
9begin
10
11 result = api_instance.get_v2_page_reacts(tenant_id, url_id)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_v2_page_reacts: #{e}"
15end
16

페이지 추가 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery

응답

반환: AddPageAPIResponse

예제

add_page 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData |
15
16begin
17
18 result = api_instance.add_page(tenant_id, create_api_page_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_page: #{e}"
22end
23

페이지 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: DeletePageAPIResponse

예제

delete_page 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_page(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_page: #{e}"
22end
23

오프라인 사용자 가져오기 Internal Link


현재 온라인 상태가 아닌 해당 페이지의 이전 댓글 작성자들입니다. displayName으로 정렬됩니다. "/users/online"을 모두 사용한 후 "구성원" 섹션을 렌더링하기 위해 이것을 사용하세요. commenterName에 대한 커서 페이지네이션: 서버는 부분 {tenantId, urlId, commenterName} 인덱스를 afterName부터 $gt로 앞으로 탐색하며 $skip 비용이 없습니다.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes페이지 URL 식별자 (서버 측에서 정리됨).
afterNamestringqueryNo커서: 이전 응답의 nextAfterName을 전달하세요.
afterUserIdstringqueryNo커서 타이브레이커: 이전 응답의 nextAfterUserId를 전달하세요. afterName이 설정된 경우 이름이 같은 항목이 누락되지 않도록 필요합니다.

Response

반환: PageUsersOfflineResponse

Example

get_offline_users 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String | 페이지 URL 식별자(서버 측에서 정리됨).
8opts = {
9 after_name: 'after_name_example', # String | 커서: 이전 응답의 nextAfterName을 전달하세요.
10 after_user_id: 'after_user_id_example' # String | 커서 타이브레이커: 이전 응답의 nextAfterUserId를 전달하세요. afterName이 설정된 경우 이름이 동일한 항목이 누락되지 않도록 필요합니다.
11}
12
13begin
14
15 result = api_instance.get_offline_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_offline_users: #{e}"
19end
20

온라인 사용자 가져오기 Internal Link

현재 페이지에 온라인 상태인 뷰어: 웹소켓 세션이 현재 해당 페이지에 구독된 사람들. anonCount + totalCount를 반환합니다 (room-wide 구독자, 익명 뷰어는 개별 열거하지 않음).

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery페이지 URL 식별자 (서버 측에서 정리됨).
afterNamestringquery아니요커서: 이전 응답에서 nextAfterName을 전달하세요.
afterUserIdstringquery아니요커서 티브레이커: 이전 응답에서 nextAfterUserId를 전달하세요. afterName이 설정된 경우, 이름 동명이인으로 항목이 누락되지 않도록 필요합니다.

Response

반환: PageUsersOnlineResponse

Example

get_online_users 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String | 페이지 URL 식별자 (서버 측에서 정리됨).
8opts = {
9 after_name: 'after_name_example', # String | 커서: 이전 응답에서 nextAfterName을 전달하세요.
10 after_user_id: 'after_user_id_example' # String | 커서 티브레이커: 이전 응답에서 nextAfterUserId를 전달하세요. afterName이 설정된 경우, 이름 동명이인으로 항목이 누락되지 않도록 필요합니다.
11}
12
13begin
14
15 result = api_instance.get_online_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_online_users: #{e}"
19end
20

URL ID로 페이지 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
urlIdstringquery

응답

반환: GetPageByURLIdAPIResponse

예제

get_page_by_urlid 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 제거하여 API 키 접두사 설정, 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14url_id = 'url_id_example' # 문자열 |
15
16begin
17
18 result = api_instance.get_page_by_urlid(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
22end
23

페이지 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery

응답

반환: GetPagesAPIResponse

예제

get_pages 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_pages(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_pages: #{e}"
21end
22

공개 페이지 가져오기 Internal Link

테넌트의 페이지를 나열합니다. FChat 데스크톱 클라이언트가 룸 목록을 채우기 위해 사용합니다. 각 페이지에 대해 해석된 커스텀 구성에서 enableFChat이 true여야 합니다. SSO가 필요한 페이지는 요청하는 사용자의 그룹 접근 권한과 비교하여 필터링됩니다.

매개변수

이름유형위치필수설명
tenantIdstringpathYes
cursorstringqueryNo이전 요청에서 nextCursor로 반환된 불투명한 페이지네이션 커서입니다. 동일한 sortBy에 묶여 있습니다.
limitintegerqueryNo1..200, 기본값 50
qstringqueryNo선택적(대소문자 구분 없음) 제목 접두사 필터입니다.
sortBystringqueryNo정렬 순서. updatedAt (기본값, 최신 순), commentCount (댓글 수 많은 순), 또는 title (알파벳순).
hasCommentsbooleanqueryNotrue인 경우, 댓글이 하나 이상 있는 페이지만 반환합니다.

응답

반환: GetPublicPagesResponse

예제

get_pages_public 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 cursor: 'cursor_example', # String | 이전 요청에서 `nextCursor`로 반환된 불투명한 페이지네이션 커서입니다. 동일한 `sortBy`에 묶여 있습니다.
9 limit: 56, # Integer | 1..200, 기본값 50
10 q: 'q_example', # String | 선택적(대소문자 구분 없음) 제목 접두사 필터입니다.
11 sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | 정렬 순서. `updatedAt` (기본값, 최신 순), `commentCount` (댓글 수 많은 순), 또는 `title` (알파벳순).
12 has_comments: true # Boolean | true인 경우, 댓글이 하나 이상 있는 페이지만 반환합니다.
13}
14
15begin
16
17 result = api_instance.get_pages_public(tenant_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->get_pages_public: #{e}"
21end
22

사용자 정보 가져오기 Internal Link

테넌트의 대량 사용자 정보. userIds를 받아 User / SSOUser의 표시 정보를 반환합니다. 댓글 위젯에서 presence 이벤트로 새로 나타난 사용자를 보강하는 데 사용됩니다. 페이지 컨텍스트 없음: 개인정보 보호가 일괄적으로 적용됩니다(비공개 프로필은 마스킹됩니다).

매개변수

이름형식위치필수설명
tenantIdstringpath
idsstringquery쉼표로 구분된 userIds.

응답

반환: PageUsersInfoResponse

예제

get_users_info 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7ids = 'ids_example' # String | 쉼표로 구분된 userIds.
8
9begin
10
11 result = api_instance.get_users_info(tenant_id, ids)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_users_info: #{e}"
15end
16

페이지 부분 업데이트 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath

응답

반환: PatchPageAPIResponse

예제

patch_page 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData |
16
17begin
18
19 result = api_instance.patch_page(tenant_id, id, update_api_page_data)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_page: #{e}"
23end
24

대기 중인 웹훅 이벤트 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

delete_pending_webhook_event 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 해제하여 API 키에 접두사를 설정합니다. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15
16begin
17
18 result = api_instance.delete_pending_webhook_event(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
22end
23

대기 중인 웹훅 이벤트 수 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringquery아니오
externalIdstringquery아니오
eventTypestringquery아니오
typestringquery아니오
domainstringquery아니오
attemptCountGTnumberquery아니오

응답

반환: GetPendingWebhookEventCountResponse

예제

get_pending_webhook_event_count 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
29end
30

대기 중인 웹훅 이벤트 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
commentIdstringquery아니오
externalIdstringquery아니오
eventTypestringquery아니오
typestringquery아니오
domainstringquery아니오
attemptCountGTnumberquery아니오
skipnumberquery아니오

응답

반환: GetPendingWebhookEventsResponse

예제

get_pending_webhook_events 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석 처리를 해제하세요 (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2, # Float |
21 skip: 1.2 # Float |
22}
23
24begin
25
26 result = api_instance.get_pending_webhook_events(tenant_id, opts)
27 p result
28rescue FastCommentsClient::ApiError => e
29 puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
30end
31

질문 구성 생성 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery

응답

반환: CreateQuestionConfigResponse

예제

create_question_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석 처리를 제거하세요(기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody |
15
16begin
17
18 result = api_instance.create_question_config(tenant_id, create_question_config_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_config: #{e}"
22end
23

질문 구성 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

delete_question_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_config: #{e}"
22end
23

질문 구성 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

응답

반환: GetQuestionConfigResponse

예제

get_question_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_config: #{e}"
22end
23

질문 구성 목록 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberquery아니오

응답

반환: GetQuestionConfigsResponse

예제

get_question_configs 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_question_configs(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_question_configs: #{e}"
24end
25

질문 구성 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

update_question_config 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두어를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody |
16
17begin
18
19 result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_config: #{e}"
23end
24

질문 결과 생성 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery

응답

반환: CreateQuestionResultResponse

예제

create_question_result 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody |
15
16begin
17
18 result = api_instance.create_question_result(tenant_id, create_question_result_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_result: #{e}"
22end
23

질문 결과 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

응답

반환: APIEmptyResponse

예제

delete_question_result 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23

질문 결과 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstring쿼리
idstring경로

응답

반환: GetQuestionResultResponse

예제

get_question_result 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15
16begin
17
18 result = api_instance.get_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_result: #{e}"
22end
23

질문 결과 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
urlIdstringquery아니요
userIdstringquery아니요
startDatestringquery아니요
questionIdstringquery아니요
questionIdsstringquery아니요
skipnumberquery아니요

응답

반환: GetQuestionResultsResponse

예제

get_question_results 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 url_id: 'url_id_example', # String |
16 user_id: 'user_id_example', # String |
17 start_date: 'start_date_example', # String |
18 question_id: 'question_id_example', # String |
19 question_ids: 'question_ids_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_question_results: #{e}"
29end
30

질문 결과 업데이트 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

update_question_result 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 제거하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody |
16
17begin
18
19 result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_result: #{e}"
23end
24

질문 결과 집계 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
questionIdstringquery아니오
questionIdsarrayquery아니오
urlIdstringquery아니오
timeBucketstringquery아니오
startDatestringquery아니오
forceRecalculatebooleanquery아니오

응답

반환: AggregateQuestionResultsResponse

예제

aggregate_question_results 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket |
19 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
20 force_recalculate: true # Boolean |
21}
22
23begin
24
25 result = api_instance.aggregate_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
29end
30

질문 결과 일괄 집계 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
forceRecalculatebooleanquery아니요

응답

반환: BulkAggregateQuestionResultsResponse

예제

bulk_aggregate_question_results 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest |
15opts = {
16 force_recalculate: true # Boolean |
17}
18
19begin
20
21 result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
25end
26

댓글과 질문 결과 결합 Internal Link


매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
questionIdstringquery아니요
questionIdsarrayquery아니요
urlIdstringquery아니요
startDatestringquery아니요
forceRecalculatebooleanquery아니요
minValuenumberquery아니요
maxValuenumberquery아니요
limitnumberquery아니요

응답

반환: CombineQuestionResultsWithCommentsResponse

예제

combine_comments_with_question_results 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
19 force_recalculate: true, # Boolean |
20 min_value: 1.2, # Float |
21 max_value: 1.2, # Float |
22 limit: 1.2 # Float |
23}
24
25begin
26
27 result = api_instance.combine_comments_with_question_results(tenant_id, opts)
28 p result
29rescue FastCommentsClient::ApiError => e
30 puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
31end
32

SSO 사용자 추가 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery

응답

반환: AddSSOUserAPIResponse

예제

add_sso_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData |
15
16begin
17
18 result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_sso_user: #{e}"
22end
23

SSO 사용자 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
deleteCommentsbooleanquery아니오
commentDeleteModestringquery아니오

응답

반환: DeleteSSOUserAPIResponse

예제

delete_sso_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 제거하세요. (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: true, # Boolean |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_sso_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_sso_user: #{e}"
26end
27

이메일로 SSO 사용자 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
emailstringpath

응답

반환: GetSSOUserByEmailAPIResponse

예제

get_sso_user_by_email 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14email = 'email_example' # 문자열 |
15
16begin
17
18 result = api_instance.get_sso_user_by_email(tenant_id, email)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
22end
23

ID로 SSO 사용자 가져오기 Internal Link


매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: GetSSOUserByIdAPIResponse

예제

get_sso_user_by_id 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하십시오. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
22end
23

SSO 사용자 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
skipintegerquery아니오

응답

반환: GetSSOUsersResponse

예제

get_sso_users 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 56 # Integer |
16}
17
18begin
19
20 result = api_instance.get_sso_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_sso_users: #{e}"
24end
25

SSO 사용자 부분 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
updateCommentsbooleanquery아니오

응답

반환: PatchSSOUserAPIResponse

예제

patch_sso_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 해제하여 API 키 접두사를 설정하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->patch_sso_user: #{e}"
26end
27

SSO 사용자 전체 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
updateCommentsbooleanquery아니오

응답

반환: PutSSOUserAPIResponse

예제

put_sso_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요. (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->put_sso_user: #{e}"
26end
27

구독 생성 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery

응답

반환: CreateSubscriptionAPIResponse

예제

create_subscription 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData |
15
16begin
17
18 result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_subscription: #{e}"
22end
23

구독 삭제 Internal Link


매개변수

이름타입위치필수설명
tenantIdstringquery
idstringpath
userIdstringquery아니오

응답

반환: DeleteSubscriptionAPIResponse

예제

delete_subscription 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15opts = {
16 user_id: 'user_id_example' # 문자열 |
17}
18
19begin
20
21 result = api_instance.delete_subscription(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_subscription: #{e}"
25end
26

구독 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery아니오

응답

반환: GetSubscriptionsAPIResponse

예제

get_subscriptions 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example' # String |
16}
17
18begin
19
20 result = api_instance.get_subscriptions(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_subscriptions: #{e}"
24end
25

구독 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringquery아니오

응답

반환: UpdateSubscriptionAPIResponse

예제

update_subscription 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_subscription: #{e}"
26end
27

테넌트 일별 사용량 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
yearNumbernumberquery아니오
monthNumbernumberquery아니오
dayNumbernumberquery아니오
skipnumberquery아니오

응답

반환: GetTenantDailyUsagesResponse

예제

get_tenant_daily_usages 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 year_number: 1.2, # Float |
16 month_number: 1.2, # Float |
17 day_number: 1.2, # Float |
18 skip: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tenant_daily_usages(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
27end
28

테넌트 패키지 생성 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery

반환

반환: CreateTenantPackageResponse

예제

create_tenant_package 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두어를 설정하려면 다음 줄의 주석을 제거하십시오. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody |
15
16begin
17
18 result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_package: #{e}"
22end
23

테넌트 패키지 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

delete_tenant_package 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
22end
23

테넌트 패키지 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: GetTenantPackageResponse

예제

get_tenant_package 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_package: #{e}"
22end
23

테넌트 패키지 목록 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
skipnumberquery아니요

응답

반환: GetTenantPackagesResponse

예제

get_tenant_packages 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_packages(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
24end
25

테넌트 패키지 교체 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

replace_tenant_package 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody |
16
17begin
18
19 result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "DefaultApi->replace_tenant_package 호출 시 오류: #{e}"
23end
24

테넌트 패키지 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

update_tenant_package 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody |
16
17begin
18
19 result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant_package: #{e}"
23end
24

테넌트 사용자 생성 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery

응답

반환: CreateTenantUserResponse

예제

create_tenant_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 아래 줄의 주석을 해제하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody |
15
16begin
17
18 result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_user: #{e}"
22end
23

테넌트 사용자 삭제 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath
deleteCommentsstringquery아니요
commentDeleteModestringquery아니요

응답

반환: APIEmptyResponse

예제

delete_tenant_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15opts = {
16 delete_comments: 'delete_comments_example', # 문자열 |
17 comment_delete_mode: 'comment_delete_mode_example' # 문자열 |
18}
19
20begin
21
22 result = api_instance.delete_tenant_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
26end
27

테넌트 사용자 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath

응답

반환: GetTenantUserResponse

예제

get_tenant_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_user: #{e}"
22end
23

테넌트 사용자 목록 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
skipnumberquery아니오

응답

반환: GetTenantUsersResponse

예제

get_tenant_users 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_users: #{e}"
24end
25

테넌트 사용자 교체 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath
updateCommentsstringquery아니오

응답

반환: APIEmptyResponse

예제

replace_tenant_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
26end
27

매개변수

이름유형위치필수설명
tenantIdstring쿼리
idstring경로
redirectURLstring쿼리아니오

응답

반환: APIEmptyResponse

예제

send_login_link 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 제거하세요 (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14id = 'id_example' # 문자열 |
15opts = {
16 redirect_url: 'redirect_url_example' # 문자열 |
17}
18
19begin
20
21 result = api_instance.send_login_link(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->send_login_link: #{e}"
25end
26

테넌트 사용자 업데이트 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath
updateCommentsstringquery아니오

응답

반환: APIEmptyResponse

예제

update_tenant_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두어를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_tenant_user: #{e}"
26end
27

테넌트 생성 Internal Link


매개변수

이름유형위치필수설명
tenantIdstring쿼리

응답

반환: CreateTenantResponse

예제

create_tenant 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 제거하여 API 키에 접두사(예: 'Bearer')를 설정하세요(기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody |
15
16begin
17
18 result = api_instance.create_tenant(tenant_id, create_tenant_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant: #{e}"
22end
23

테넌트 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
surestringquery아니오

응답

반환: APIEmptyResponse

예제

delete_tenant 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 sure: 'sure_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_tenant(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_tenant: #{e}"
25end
26

테넌트 가져오기 Internal Link


매개변수

이름유형위치필수설명
tenantIdstringquery
idstringpath

응답

반환: GetTenantResponse

예제

get_tenant 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant: #{e}"
22end
23

테넌트 목록 가져오기 Internal Link


매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
metastringquery아니오
skipnumberquery아니오

응답

반환: GetTenantsResponse

예제

get_tenants 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요 (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 meta: 'meta_example', # String |
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_tenants(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_tenants: #{e}"
25end
26

테넌트 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptyResponse

예제

update_tenant 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody |
16
17begin
18
19 result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant: #{e}"
23end
24

티켓 상태 변경 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery
idstringpath

응답

반환: ChangeTicketStateResponse

예제

change_ticket_state 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키의 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15id = 'id_example' # String |
16change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody |
17
18begin
19
20 result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->change_ticket_state: #{e}"
24end
25

티켓 생성 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringquery

응답

반환: CreateTicketResponse

예제

create_ticket 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키용 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요 (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody |
16
17begin
18
19 result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->create_ticket: #{e}"
23end
24

티켓 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

응답

반환: GetTicketResponse

예제

get_ticket 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 제거하면 API 키 접두사를 설정할 수 있습니다. 예: 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.get_ticket(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_ticket: #{e}"
25end
26

티켓 목록 가져오기 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery
userIdstringquery아니요
statenumberquery아니요
skipnumberquery아니요
limitnumberquery아니요

응답

반환값: GetTicketsResponse

예제

get_tickets 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 state: 1.2, # Float |
17 skip: 1.2, # Float |
18 limit: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tickets(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tickets: #{e}"
27end
28

번역 가져오기 Internal Link

매개변수

이름유형위치필수설명
namespacestringpath
componentstringpath
localestringquery아니요
useFullTranslationIdsbooleanquery아니요

응답

반환: GetTranslationsResponse

예제

get_translations 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6namespace = 'namespace_example' # String |
7component = 'component_example' # String |
8opts = {
9 locale: 'locale_example', # String |
10 use_full_translation_ids: true # Boolean |
11}
12
13begin
14
15 result = api_instance.get_translations(namespace, component, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_translations: #{e}"
19end
20

이미지 업로드 Internal Link

이미지 업로드 및 크기 조정

매개변수

이름유형위치필수설명
tenantIdstringpath
sizePresetstringquery아니오크기 프리셋: "Default" (1000x1000px) 또는 "CrossPlatform" (인기 있는 기기용 크기를 생성합니다)
urlIdstringquery아니오업로드가 발생하는 페이지 ID(구성용)

응답

반환: UploadImageResponse

예제

upload_image 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7file = File.new('/path/to/some/file') # File |
8opts = {
9 size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | 크기 프리셋: \"Default\" (1000x1000px) 또는 \"CrossPlatform\" (인기 있는 기기용 크기를 생성합니다)
10 url_id: 'url_id_example' # String | 업로드가 발생하는 페이지 ID(구성용)
11}
12
13begin
14
15 result = api_instance.upload_image(tenant_id, file, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->upload_image: #{e}"
19end
20

ID로 사용자 배지 진행률 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIGetUserBadgeProgressResponse

예제

get_user_badge_progress_by_id 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석 처리를 해제하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
22end
23

사용자 ID로 배지 진행률 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringpath

응답

반환: APIGetUserBadgeProgressResponse

예제

get_user_badge_progress_by_user_id 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 제거하여 API 키 접두사(예: 'Bearer')를 설정합니다 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14user_id = 'user_id_example' # 문자열 |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
22end
23

사용자 배지 진행률 목록 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
userIdstringquery아니오
limitnumberquery아니오
skipnumberquery아니오

응답

반환: APIGetUserBadgeProgressListResponse

예제

get_user_badge_progress_list 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14opts = {
15 user_id: 'user_id_example', # 문자열 |
16 limit: 1.2, # 부동 소수점 |
17 skip: 1.2 # 부동 소수점 |
18}
19
20begin
21
22 result = api_instance.get_user_badge_progress_list(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
26end
27

사용자 배지 생성 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery

응답

반환: APICreateUserBadgeResponse

예제

create_user_badge 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams |
15
16begin
17
18 result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_user_badge: #{e}"
22end
23

사용자 배지 삭제 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
idstringpath

응답

반환: APIEmptySuccessResponse

예제

delete_user_badge 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 제거하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_user_badge: #{e}"
22end
23

사용자 배지 가져오기 Internal Link


매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIGetUserBadgeResponse

예제

get_user_badge 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23

사용자 배지 목록 가져오기 Internal Link

매개변수

이름형식위치필수설명
tenantIdstringquery
userIdstringquery아니오
badgeIdstringquery아니오
typenumberquery아니오
displayedOnCommentsbooleanquery아니오
limitnumberquery아니오
skipnumberquery아니오

응답

반환: APIGetUserBadgesResponse

예제

get_user_badges 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 문자열 |
14opts = {
15 user_id: 'user_id_example', # 문자열 |
16 badge_id: 'badge_id_example', # 문자열 |
17 type: 1.2, # 실수 |
18 displayed_on_comments: true, # 불리언 |
19 limit: 1.2, # 실수 |
20 skip: 1.2 # 실수 |
21}
22
23begin
24
25 result = api_instance.get_user_badges(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_user_badges: #{e}"
29end
30

사용자 배지 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

응답

반환: APIEmptySuccessResponse

예제

update_user_badge 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사(예: 'Bearer')를 설정하려면 다음 줄의 주석을 해제하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams |
16
17begin
18
19 result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_user_badge: #{e}"
23end
24

사용자 알림 수 가져오기 Internal Link

매개변수

이름타입위치필수설명
tenantIdstringquery
ssostringquery아니오

응답

반환: GetUserNotificationCountResponse

예제

get_user_notification_count 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7opts = {
8 sso: 'sso_example' # 문자열 |
9}
10
11begin
12
13 result = api_instance.get_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->get_user_notification_count: #{e}"
17end
18

사용자 알림 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdstringquery아니요현재 페이지가 구독되어 있는지 확인하는 데 사용됩니다.
pageSizeintegerquery아니요
afterIdstringquery아니요
includeContextbooleanquery아니요
afterCreatedAtintegerquery아니요
unreadOnlybooleanquery아니요
dmOnlybooleanquery아니요
noDmbooleanquery아니요
includeTranslationsbooleanquery아니요
includeTenantNotificationsbooleanquery아니요
ssostringquery아니요

응답

반환: GetMyNotificationsResponse

예제

get_user_notifications 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 url_id: 'url_id_example', # String | 현재 페이지가 구독되어 있는지 확인하는 데 사용됩니다.
9 page_size: 56, # Integer |
10 after_id: 'after_id_example', # String |
11 include_context: true, # Boolean |
12 after_created_at: 789, # Integer |
13 unread_only: true, # Boolean |
14 dm_only: true, # Boolean |
15 no_dm: true, # Boolean |
16 include_translations: true, # Boolean |
17 include_tenant_notifications: true, # Boolean |
18 sso: 'sso_example' # String |
19}
20
21begin
22
23 result = api_instance.get_user_notifications(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling PublicApi->get_user_notifications: #{e}"
27end
28

사용자 알림 수 초기화 Internal Link


매개변수

이름유형위치필수설명
tenantIdstringquery
ssostringquery아니요

응답

반환: ResetUserNotificationsResponse

예제

reset_user_notification_count 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.reset_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
17end
18

사용자 알림 초기화 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
afterIdstringquery아니오
afterCreatedAtintegerquery아니오
unreadOnlybooleanquery아니오
dmOnlybooleanquery아니오
noDmbooleanquery아니오
ssostringquery아니오

응답

반환: ResetUserNotificationsResponse

예제

reset_user_notifications 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7opts = {
8 after_id: 'after_id_example', # 문자열 |
9 after_created_at: 789, # 정수 |
10 unread_only: true, # 부울 |
11 dm_only: true, # 부울 |
12 no_dm: true, # 부울 |
13 sso: 'sso_example' # 문자열 |
14}
15
16begin
17
18 result = api_instance.reset_user_notifications(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->reset_user_notifications: #{e}"
22end
23

사용자 댓글 구독 상태 업데이트 Internal Link

특정 댓글에 대한 알림을 활성화하거나 비활성화합니다.

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
notificationIdstringpath
optedInOrOutstringpath
commentIdstringquery
ssostringquery아니오

응답

반환: UpdateUserNotificationCommentSubscriptionStatusResponse

예제

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

사용자 페이지 구독 상태 업데이트 Internal Link


페이지에 대한 알림을 활성화하거나 비활성화합니다. 사용자가 페이지를 구독하면 새 루트 댓글에 대해 알림이 생성되고, 또한

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdstringquery
urlstringquery
pageTitlestringquery
subscribedOrUnsubscribedstringpath
ssostringquery아니요

응답

반환: UpdateUserNotificationPageSubscriptionStatusResponse

예제

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

사용자 알림 상태 업데이트 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
notificationIdstringpath
newStatusstringpath
ssostringquery아니오

응답

반환: UpdateUserNotificationStatusResponse

예제

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

사용자 접속 상태 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstring쿼리
urlIdWSstring쿼리
userIdsstring쿼리

응답

반환: GetUserPresenceStatusesResponse

예제

get_user_presence_statuses 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 문자열 |
7url_id_ws = 'url_id_ws_example' # 문자열 |
8user_ids = 'user_ids_example' # 문자열 |
9
10begin
11
12 result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
16end
17

사용자 검색 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringpath
urlIdstringquery
usernameStartsWithstringquery아니요
mentionGroupIdsarrayquery아니요
ssostringquery아니요
searchSectionstringquery아니요

응답

반환: SearchUsersResult

예제

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

사용자 가져오기 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

응답

반환: GetUserResponse

예제

get_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석을 해제하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user: #{e}"
22end
23

투표 생성 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringquery
directionstringquery
userIdstringquery아니오
anonUserIdstringquery아니오

응답

반환: VoteResponse

예제

create_vote 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14comment_id = 'comment_id_example' # String |
15direction = 'up' # String |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->create_vote: #{e}"
27end
28

투표 삭제 Internal Link

매개변수

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
editKeystringquery아니요

응답

반환: VoteDeleteResponse

예제

delete_vote 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 다음 줄의 주석을 해제하여 API 키의 접두사를 설정하세요. 예: 'Bearer' (기본값은 nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 edit_key: 'edit_key_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_vote(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_vote: #{e}"
25end
26

투표 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
urlIdstringquery

응답

반환: GetVotesResponse

예제

get_votes 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 아래 줄의 주석을 해제하여 API 키의 접두사(예: 'Bearer')를 설정하세요 (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_votes(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_votes: #{e}"
22end
23

사용자 투표 가져오기 Internal Link

매개변수

이름유형위치필수설명
tenantIdstringquery
urlIdstringquery
userIdstringquery아니요
anonUserIdstringquery아니요

응답

반환: GetVotesForUserResponse

예제

get_votes_for_user 예제
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# 인증 설정
5FastCommentsClient.configure do |config|
6 # API 키 인증 구성: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # API 키에 대한 접두사를 설정하려면 다음 줄의 주석 처리를 해제하세요. 예: 'Bearer' (기본값: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
26end
27

도움이 필요하신가요?

Ruby SDK에 문제가 발생하거나 질문이 있는 경우, 다음을 이용해 주세요:

기여

기여를 환영합니다! 기여 지침은 GitHub 저장소를 방문해 주세요.