FastComments Nim SDK

• Nim >= 1.6.0
• nimcrypto >= 0.5.4

Nimble 사용

nimble install fastcomments

소스에서 빌드

nimble build

라이브러리 내용

이 라이브러리는 생성된 API 클라이언트와 API 사용을 쉽게 해주는 SSO 유틸리티를 포함하고 있습니다.

• API Client Library Docs

공개 API와 보안 API

API 클라이언트에는 api_default, api_public, api_moderation 세 가지 API 모듈이 있습니다. api_default는 API 키가 필요한 메서드를 포함하고, api_public은 인증 없이 브라우저/모바일 디바이스 등에서 직접 호출할 수 있는 API 호출을 포함합니다. api_moderation 모듈은 관리자 대시보드를 위한 메서드를 포함합니다.

api_moderation 모듈은 실시간 및 빠른 검토 API의 포괄적인 스위트를 제공합니다. 모든 api_moderation 메서드는 sso 매개변수를 받아들이며, SSO 또는 FastComments.com 세션 쿠키를 통해 인증할 수 있습니다.

Using Authenticated APIs (DefaultAPI)

중요: 인증된 엔드포인트는 API 키를 x-api-key 헤더에 설정해야 합니다.

import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

# 인증된 API 호출을 수행합니다.
# 필수 매개변수(및 요청 본문)는 위치 기반이며; 선택적
# 매개변수는 작업의 옵션 객체를 통해 전달됩니다.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

Using Public APIs (PublicAPI)

Public endpoints don't require authentication:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# 공개 API 호출을 수행합니다.
# tenantId와 urlId는 필수(위치 기반)이며; 나머지는 모두 선택 사항입니다.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

Using Moderation APIs (ModerationAPI)

Moderation endpoints power the moderator dashboard and are authenticated with an SSO token for the acting moderator:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# 조정 대시보드의 댓글을 나열합니다.
# 이 작업은 필수 매개변수가 없으므로 모든 것이 선택 사항입니다.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

if response.isSome:
  let resp = response.get()
  echo "Found ", resp.comments.len, " comments"

Common Issues

1. 401 인증 오류: DefaultAPI 요청을 하기 전에 HttpClient에 x-api-key 헤더를 설정했는지 확인하십시오: client.headers["x-api-key"] = "your-api-key"
2. 잘못된 API 클래스: 서버 측 인증 요청에는 api_default를, 클라이언트 측/공개 요청에는 api_public을, 관리자 대시보드 요청에는 api_moderation을 사용하십시오.

All API methods in this SDK return tuples of (Option[ResponseType], Response). 첫 번째 요소는 성공 시 파싱된 응답을 포함하고, 두 번째 요소는 원시 HTTP 응답입니다.

필수 매개변수와 요청 본문은 위치 기반으로 전달됩니다. 나머지 선택적 매개변수들은 단일 Api<Operation>Options 객체에 수집되며, 이는 마지막 인수입니다. 선택적 매개변수가 없는 작업은 옵션 객체를 사용하지 않습니다.

예제: 댓글 가져오기

import httpclient
import options
import fastcomments
import fastcomments/apis/api_default

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

if httpResponse.code == Http200:
  if response.isSome:
    let resp = response.get()
    if resp.comments.isSome:
      echo "Found ", resp.comments.get().len, " comments"

브로드캐스트 ID

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

SSO (싱글 사인온)

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

간단한 SSO

import fastcomments/sso

let user = newSimpleSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()

echo "SSO Token: ", token

보안 SSO

import fastcomments/sso

let user = newSecureSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  username = "johndoe",
  avatar = "https://example.com/avatar.jpg"
)

let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()

echo "Secure SSO Token: ", token

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

매개변수

응답

반환: Option[AggregateResponse]

예시

집계 예시

Copy

1

2let (aggResp, httpResp) = client.aggregate(tenantId = "my-tenant-123", aggregationRequest = AggregationRequest(), options = AggregateOptions())

3if aggResp.isSome:

4 let response = aggResp.get()

5 echo response

6echo httpResp

7

매개변수

응답

반환: Option[GetAuditLogsResponse]

예시

getAuditLogs 예시

Copy

1

2let (auditOpt, httpResp) = client.getAuditLogs(tenantId = "my-tenant-123", options = GetAuditLogsOptions())

3if auditOpt.isSome:

4 let audit = auditOpt.get()

5 echo audit

6

응답

반환: Option[APIEmptyResponse]

예시

logoutPublic 예제

Copy

1

2let (responseOpt, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", userId = "user-456")

3if responseOpt.isSome:

4 let emptyResponse = responseOpt.get()

5

매개변수

응답

반환: Option[BlockSuccess]

예시

blockFromCommentPublic 예시

Copy

1

2let (blockOpt, httpResp) = client.blockFromCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams(),

6 sso = ""

7)

8

9if blockOpt.isSome:

10 let block = blockOpt.get()

11

매개변수

응답

반환: Option[UnblockSuccess]

예시

unBlockCommentPublic 예제

Copy

1

2let (unblockResult, httpResp) = client.unBlockCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "comment-7890",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams(),

6 sso = ""

7)

8

9if unblockResult.isSome:

10 let result = unblockResult.get()

11

매개변수

응답

반환: Option[CheckBlockedCommentsResponse]

예시

checkedCommentsForBlocked 예시

Copy

1

2let (maybeResponse, httpResponse) = client.checkedCommentsForBlocked(

3 tenantId = "my-tenant-123",

4 commentIds = "cmt-1,cmt-2",

5 sso = ""

6)

7

8if maybeResponse.isSome:

9 let response = maybeResponse.get()

10 discard response

11

Parameters

Response

반환: Option[BlockSuccess]

Example

blockUserFromComment 예시

Copy

1

2let params = BlockFromCommentParams()

3let opts = BlockUserFromCommentOptions()

4let (blockResult, httpResp) = client.blockUserFromComment(

5 tenantId = "my-tenant-123",

6 id = "comment-456",

7 blockFromCommentParams = params,

8 options = opts

9)

10if blockResult.isSome:

11 let success = blockResult.get()

12 discard success

13

Parameters

Response

반환: Option[SaveCommentsResponseWithPresence]

Example

createCommentPublic 예시

Copy

1

2let

3 tenantId = "my-tenant-123"

4 urlId = "news/article-title"

5 broadcastId = "broadcast-456"

6 commentData = CommentData()

7 options = CreateCommentPublicOptions()

8let (maybeResp, httpResp) = client.createCommentPublic(

9 tenantId = tenantId,

10 urlId = urlId,

11 broadcastId = broadcastId,

12 commentData = commentData,

13 options = options)

14

15if maybeResp.isSome:

16 let resp = maybeResp.get()

17 echo resp

18

매개변수

응답

반환: Option[DeleteCommentResult]

예시

deleteComment 예시

Copy

1

2let (delResult, httpResponse) = client.deleteComment(

3 tenantId = "my-tenant-123",

4 id = "comment-456",

5 options = DeleteCommentOptions()

6)

7

8if delResult.isSome:

9 let result = delResult.get()

10 echo result

11

매개변수

응답

반환: Option[PublicAPIDeleteCommentResponse]

예시

deleteCommentPublic 예시

Copy

1

2let (responseOpt, httpResp) = client.deleteCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "",

6 options = DeleteCommentPublicOptions())

7if responseOpt.isSome:

8 let resp = responseOpt.get()

9 echo resp

10

매개변수

응답

Returns: Option[VoteDeleteResponse]

예시

deleteCommentVote 예시

Copy

1

2let (response, httpResponse) = client.deleteCommentVote(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456",

5 voteId = "vote-789",

6 urlId = "news/article-title",

7 broadcastId = "broadcast-001",

8 options = DeleteCommentVoteOptions()

9)

10

11if response.isSome:

12 let voteDelete = response.get()

13

매개변수

응답

반환: Option[FlagCommentResponse]

예시

flagComment 예시

Copy

1

2let options = FlagCommentOptions(reason: "spam content", note: "Automated posting detected", isSpam: true, categories: @["spam"])

3let (flagRes, httpRes) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-789", options = options)

4if flagRes.isSome:

5 let res = flagRes.get()

6 discard res

7

매개변수

응답

반환: Option[APIGetCommentResponse]

예시

getComment 예시

Copy

1

2let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-789")

3if response.isSome:

4 let comment = response.get()

5 discard comment

6

매개변수

응답

반환: Option[APIGetCommentsResponse]

예시

getComments 예시

Copy

1

2let options = GetCommentsOptions(

3 urlId = "news/article-title",

4 page = 0,

5 pageSize = 20,

6 sort = "newest",

7 includeDeleted = false,

8 includeReplies = true,

9 userIds = @[],

10 tags = @[]

11)

12

13let (response, httpResponse) = client.getComments(tenantId = "my-tenant-123", options = options)

14

15if response.isSome:

16 let comments = response.get()

17 discard comments

18

req tenantId urlId

매개변수

응답

반환: Option[GetCommentsResponseWithPresencePublicComment]

예시

getCommentsPublic 예제

Copy

1

2let (optResp, httpResp) = client.getCommentsPublic(

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 options = GetCommentsPublicOptions(

6 page = 0,

7 pageSize = 10,

8 includeDeleted = false,

9 tags = @[]

10 )

11)

12

13if optResp.isSome:

14 let resp = optResp.get()

15 echo resp

16

매개변수

응답

반환: Option[PublicAPIGetCommentTextResponse]

예시

getCommentText 예시

Copy

1

2let (maybeResponse, httpResponse) = client.getCommentText(

3 tenantId = "my-tenant-123",

4 commentId = "comment-456",

5 options = GetCommentTextOptions()

6)

7

8if maybeResponse.isSome:

9 let response = maybeResponse.get()

10

매개변수

응답

반환: Option[GetCommentVoteUserNamesSuccessResponse]

예시

getCommentVoteUserNames 예시

Copy

1

2let (voteNamesOpt, httpRes) = client.getCommentVoteUserNames(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-987654321",

5 dir = 0,

6 sso = ""

7)

8

9if voteNamesOpt.isSome:

10 let voteNames = voteNamesOpt.get()

11 echo voteNames

12

매개변수

응답

반환: Option[APIEmptyResponse]

예시

lockComment 예제

Copy

1

2let (lockResult, httpRes) = client.lockComment(

3 tenantId = "my-tenant-123",

4 commentId = "comment-456",

5 broadcastId = "",

6 sso = "")

7

8if lockResult.isSome:

9 let resp = lockResult.get()

10 discard resp

11

매개변수

응답

반환: Option[ChangeCommentPinStatusResponse]

예시

pinComment 예시

Copy

1

2let (pinResult, httpResp) = client.pinComment(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "broadcast-001",

6 sso = "",

7)

8

9if pinResult.isSome:

10 let response = pinResult.get()

11 echo response

12

매개변수

응답

반환: Option[APISaveCommentResponse]

예시

saveComment 예시

Copy

1

2let commentParams = CreateCommentParams(

3 body: "Great read, thanks!",

4 name: "Alice Smith",

5 email: "alice@example.com",

6 parentId: ""

7)

8

9let saveOpts = SaveCommentOptions(

10 isPreview: false,

11 isApproved: true,

12 skipSpamCheck: false

13)

14

15let (apiResponse, httpResponse) = client.saveComment(

16 tenantId = "my-tenant-123",

17 createCommentParams = commentParams,

18 options = saveOpts

19)

20

21if apiResponse.isSome:

22 let saved = apiResponse.get()

23 echo saved

24

매개변수

응답

반환값: Option[APIEmptyResponse]

예제

saveCommentsBulk 예제

Copy

1

2let (response, httpResponse) = client.saveCommentsBulk(

3 tenantId = "my-tenant-123",

4 createCommentParams = @[],

5 options = SaveCommentsBulkOptions(),

6 id = "",

7 fromName = ""

8)

9

10if response.isSome:

11 let result = response.get()

12

매개변수

응답

반환: Option[PublicAPISetCommentTextResponse]

예제

setCommentText 예제

Copy

1

2let commentUpdate = CommentTextUpdateRequest(text: "Updated comment text")

3let opts = SetCommentTextOptions()

4let (response, httpResponse) = client.setCommentText(

5 tenantId = "my-tenant-123",

6 commentId = "cmt-456",

7 broadcastId = "broadcast-789",

8 commentTextUpdateRequest = commentUpdate,

9 options = opts)

10if response.isSome:

11 let result = response.get()

12

매개변수

응답

반환: Option[UnblockSuccess]

예시

unBlockUserFromComment 예시

Copy

1

2let (response, httpResponse) = client.unBlockUserFromComment(

3 tenantId = "my-tenant-123",

4 id = "comment-456",

5 unBlockFromCommentParams = UnBlockFromCommentParams(userId = "user-789", commentId = "cmt-321"),

6 options = UnBlockUserFromCommentOptions(),

7)

8

9if response.isSome:

10 let unblockSuccess = response.get()

11

Parameters

응답

반환: Option[FlagCommentResponse]

예시

unFlagComment 예시

Copy

1

2let (flagRespOpt, httpResp) = client.unFlagComment(tenantId = "my-tenant-123", id = "comment-456", options = UnFlagCommentOptions())

3if flagRespOpt.isSome:

4 let flagResp = flagRespOpt.get()

5

매개변수

응답

반환: Option[APIEmptyResponse]

예시

unLockComment 예시

Copy

1

2let (maybeEmpty, httpResp) = client.unLockComment(tenantId = "my-tenant-123", commentId = "comment-456", broadcastId = "", sso = "")

3if maybeEmpty.isSome:

4 let emptyResp = maybeEmpty.get()

5 echo "Comment unlocked"

6else:

7 echo "Failed to unlock comment"

8

매개변수

응답

반환: Option[ChangeCommentPinStatusResponse]

예시

unPinComment 예시

Copy

1

2let (responseOpt, httpResponse) = client.unPinComment(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "broadcast-001",

6 sso = ""

7)

8

9if responseOpt.isSome:

10 let resp = responseOpt.get()

11 echo resp

12

매개변수

응답

반환: Option[APIEmptyResponse]

예시

updateComment 예제

Copy

1

2let commentParams = UpdatableCommentParams(content: "Updated comment content")

3let updateOpts = UpdateCommentOptions(force: false)

4

5let (respOpt, httpResp) = client.updateComment(

6 tenantId = "my-tenant-123",

7 id = "comment-456",

8 updatableCommentParams = commentParams,

9 options = updateOpts

10)

11

12if respOpt.isSome:

13 let resp = respOpt.get()

14

매개변수

응답

반환: Option[VoteResponse]

예시

voteComment 예시

Copy

1

2let (voteRespOpt, httpResp) = client.voteComment(

3 tenantId = "my-tenant-123",

4 commentId = "comment-98765",

5 urlId = "blog/how-to-code",

6 broadcastId = "",

7 voteBodyParams = VoteBodyParams(),

8 options = VoteCommentOptions()

9)

10

11if voteRespOpt.isSome:

12 let voteResp = voteRespOpt.get()

13

매개변수

응답

반환: Option[GetCommentsForUserResponse]

예시

getCommentsForUser 예시

Copy

1

2let (maybeResp, httpResp) = client.getCommentsForUser(options = GetCommentsForUserOptions(

3 tenantId = "my-tenant-123",

4 userId = "user-456",

5 page = 0,

6 pageSize = 20,

7 includeDeleted = false,

8 commentIds = @[]

9))

10

11if maybeResp.isSome:

12 let resp = maybeResp.get()

13 discard resp

14

매개변수

응답

반환: Option[AddDomainConfigResponse]

예시

addDomainConfig 예제

Copy

1

2let (respOpt, httpResp) = client.addDomainConfig(

3 tenantId = "my-tenant-123",

4 addDomainConfigParams = default(AddDomainConfigParams)

5)

6

7if respOpt.isSome:

8 let cfg = respOpt.get()

9

매개변수

응답

반환: Option[DeleteDomainConfigResponse]

예시

deleteDomainConfig 예시

Copy

1

2let (optResp, httpResp) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")

3if optResp.isSome:

4 let resp = optResp.get()

5 echo resp

6

매개변수

응답

반환: Option[GetDomainConfigResponse]

예시

getDomainConfig 예시

Copy

1

2let (configOpt, httpResp) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")

3if configOpt.isSome:

4 let cfg = configOpt.get()

5 discard cfg

6

매개변수

응답

반환: Option[GetDomainConfigsResponse]

예시

getDomainConfigs 예시

Copy

1

2let (domainConfigsOpt, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")

3if domainConfigsOpt.isSome:

4 let domainConfigs = domainConfigsOpt.get()

5 echo domainConfigs

6

매개변수

응답

반환: Option[PatchDomainConfigResponse]

예시

patchDomainConfig 예시

Copy

1

2let (optResp, httpResp) = client.patchDomainConfig(

3 tenantId = "my-tenant-123",

4 domainToUpdate = "news.mywebsite.com",

5 patchDomainConfigParams = PatchDomainConfigParams()

6)

7

8if optResp.isSome:

9 let resp = optResp.get()

10 echo resp

11

매개변수

응답

반환: Option[PutDomainConfigResponse]

예시

putDomainConfig 예시

Copy

1

2let (optResp, httpResp) = client.putDomainConfig(

3 tenantId = "my-tenant-123",

4 domainToUpdate = "example.com",

5 updateDomainConfigParams = UpdateDomainConfigParams()

6)

7

8if optResp.isSome:

9 let resp = optResp.get()

10 echo resp

11

매개변수

응답

반환: Option[CreateEmailTemplateResponse]

예시

createEmailTemplate 예시

Copy

1

2let createBody = CreateEmailTemplateBody(

3 name: "Welcome Email",

4 subject: "Welcome to FastComments",

5 htmlBody: "<p>Hello, thank you for joining us!</p>",

6 isActive: true,

7 tags: @[]

8)

9

10let (optResp, httpResp) = client.createEmailTemplate(

11 tenantId = "my-tenant-123",

12 createEmailTemplateBody = createBody

13)

14

15if optResp.isSome:

16 let emailTemplate = optResp.get()

17

매개변수

응답

반환: Option[APIEmptyResponse]

예시

deleteEmailTemplate 예제

Copy

1

2let (respOpt, httpResp) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")

3if respOpt.isSome:

4 let emptyResp = respOpt.get()

5 echo "Email template deleted"

6else:

7 echo "Failed to delete email template"

8

매개변수

응답

반환: Option[APIEmptyResponse]

예시

deleteEmailTemplateRenderError 예시

Copy

1

2let (apiRes, httpRes) = client.deleteEmailTemplateRenderError(

3 tenantId = "my-tenant-123",

4 id = "welcome-email",

5 errorId = "render-err-456"

6)

7

8if apiRes.isSome:

9 let empty = apiRes.get()

10

매개변수

응답

반환: Option[GetEmailTemplateResponse]

예시

getEmailTemplate 예시

Copy

1

2let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")

3if response.isSome:

4 let tmpl = response.get()

5

매개변수

응답

반환: Option[GetEmailTemplateDefinitionsResponse]

예시

getEmailTemplateDefinitions 예시

Copy

1

2let (responseOpt, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")

3if responseOpt.isSome:

4 let definitions = responseOpt.get()

5 echo definitions

6

매개변수

응답

반환: Option[GetEmailTemplateRenderErrorsResponse]

예시

getEmailTemplateRenderErrors 예시

Copy

1

2let (optResp, httpResp) = client.getEmailTemplateRenderErrors(

3 tenantId = "my-tenant-123",

4 id = "welcome-template",

5 skip = 0.0

6)

7

8if optResp.isSome:

9 let resp = optResp.get()

10 # 필요에 따라 resp 사용

11else:

12 # 누락된 응답 처리

13 discard

14

매개변수

응답

반환: Option[GetEmailTemplatesResponse]

예시

getEmailTemplates 예시

Copy

1

2let (emailTemplatesOpt, httpResp) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)

3if emailTemplatesOpt.isSome:

4 let templates = emailTemplatesOpt.get()

5 echo templates

6

매개변수

응답

Returns: Option[RenderEmailTemplateResponse]

예시

renderEmailTemplate 예제

Copy

1

2let body = RenderEmailTemplateBody()

3let (responseOpt, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = body, locale = "en-US")

4if responseOpt.isSome:

5 let response = responseOpt.get()

6 discard response

7discard httpResponse

8

매개변수

응답

반환: Option[APIEmptyResponse]

예시

updateEmailTemplate 예시

Copy

1

2let updateBody = UpdateEmailTemplateBody(

3 subject: "Welcome to FastComments",

4 body: "Hello \{{user_name}}, thanks for joining!",

5 enabled: true,

6)

7

8let (maybeResp, httpResp) = client.updateEmailTemplate(

9 tenantId = "my-tenant-123",

10 id = "welcome-email",

11 updateEmailTemplateBody = updateBody,

12)

13

14if maybeResp.isSome:

15 let resp = maybeResp.get()

16

req tenantId urlId userIdWS

매개변수

응답

반환: Option[GetEventLogResponse]

예시

getEventLog 예제

Copy

1

2let (eventLogOpt, httpResp) = client.getEventLog(

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 userIdWS = "",

6 startTime = 0'i64,

7 endTime = 0'i64,

8)

9

10if eventLogOpt.isSome:

11 let eventLog = eventLogOpt.get()

12 echo eventLog

13

req tenantId urlId userIdWS

매개변수

응답

반환: Option[GetEventLogResponse]

예제

getGlobalEventLog 예제

Copy

1

2let (eventLogOpt, httpResp) = client.getGlobalEventLog(

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 userIdWS = "user-456",

6 startTime = 1700000000'i64,

7 endTime = 1700003600'i64,

8)

9

10if eventLogOpt.isSome:

11 let eventLog = eventLogOpt.get()

12 echo eventLog

13

매개변수

응답

반환: Option[CreateFeedPostsResponse]

예시

createFeedPost 예시

Copy

1

2let (respOpt, httpResp) = client.createFeedPost(

3 tenantId = "my-tenant-123",

4 createFeedPostParams = CreateFeedPostParams(),

5 options = CreateFeedPostOptions()

6)

7

8if respOpt.isSome:

9 let feedPost = respOpt.get()

10

매개변수

응답

반환: Option[CreateFeedPostResponse]

예제

createFeedPostPublic 예제

Copy

1

2let params = CreateFeedPostParams(

3 urlId: "news/big-event",

4 title: "Big Event Happened",

5 content: "Full article content goes here.",

6 tags: @["news", "event"]

7)

8

9let opts = CreateFeedPostPublicOptions(

10 sendNotifications: false,

11 allowComments: true

12)

13

14let (response, httpResponse) = client.createFeedPostPublic(

15 tenantId = "my-tenant-123",

16 createFeedPostParams = params,

17 options = opts

18)

19

20if response.isSome:

21 let post = response.get()

22 echo post

23

매개변수

응답

반환: Option[DeleteFeedPostPublicResponse]

예시

deleteFeedPostPublic 예시

Copy

1

2let (response, httpResponse) = client.deleteFeedPostPublic(

3 tenantId = "my-tenant-123",

4 postId = "news/article-42",

5 options = DeleteFeedPostPublicOptions()

6)

7

8if response.isSome:

9 let deleteResp = response.get()

10

req tenantId afterId

Parameters

Response

반환: Option[GetFeedPostsResponse]

예시

getFeedPosts 예시

Copy

1

2let (feedResponseOpt, httpResp) = client.getFeedPosts(tenantId = "my-tenant-123", options = GetFeedPostsOptions())

3if feedResponseOpt.isSome:

4 let feedResponse = feedResponseOpt.get()

5 echo feedResponse

6

req tenantId afterId

매개변수

응답

반환: Option[PublicFeedPostsResponse]

예시

getFeedPostsPublic 예시

Copy

1

2let (feedResponseOpt, httpResponse) = client.getFeedPostsPublic(tenantId = "my-tenant-123", options = GetFeedPostsPublicOptions())

3if feedResponseOpt.isSome:

4 let feedResponse = feedResponseOpt.get()

5

매개변수

응답

반환: Option[FeedPostsStatsResponse]

예시

getFeedPostsStats 예시

Copy

1

2let (statsOpt, httpResponse) = client.getFeedPostsStats(

3 tenantId = "my-tenant-123",

4 postIds = @["post-abc", "post-def"],

5 sso = "sso-token",

6)

7

8if statsOpt.isSome:

9 let stats = statsOpt.get()

10 # 필요에 따라 stats 사용

11

12

13

매개변수

응답

반환: Option[UserReactsResponse]

예시

getUserReactsPublic 예시

Copy

1

2let opts = GetUserReactsPublicOptions(

3 limit = 20,

4 offset = 0,

5 includeDeleted = false

6)

7

8let (response, httpResponse) = client.getUserReactsPublic(

9 tenantId = "my-tenant-123",

10 options = opts

11)

12

13if response.isSome:

14 let userReacts = response.get()

15

매개변수

응답

반환: Option[ReactFeedPostResponse]

예시

reactFeedPostPublic 예시

Copy

1

2let reactParams = ReactBodyParams()

3let (optResp, httpResp) = client.reactFeedPostPublic(

4 tenantId = "my-tenant-123",

5 postId = "post-456",

6 reactBodyParams = reactParams,

7 options = ReactFeedPostPublicOptions()

8)

9if optResp.isSome:

10 let resp = optResp.get()

11 echo resp

12

매개변수

응답

반환: Option[APIEmptyResponse]

예시

updateFeedPost 예시

Copy

1

2let feedPost = FeedPost(

3 title: "Breaking News",

4 content: "Updated story content",

5 tags: @["news", "update"]

6)

7

8let (apiRes, httpRes) = client.updateFeedPost(

9 tenantId = "my-tenant-123",

10 id = "post-456",

11 feedPost = feedPost

12)

13

14if apiRes.isSome:

15 let res = apiRes.get()

16

매개변수

응답

반환: Option[CreateFeedPostResponse]

예시

updateFeedPostPublic 예시

Copy

1

2let (response, httpResponse) = client.updateFeedPostPublic(

3 tenantId = "my-tenant-123",

4 postId = "post-789",

5 updateFeedPostParams = UpdateFeedPostParams(),

6 options = UpdateFeedPostPublicOptions()

7)

8

9if response.isSome:

10 let post = response.get()

11

Parameters

Response

반환: Option[APIEmptyResponse]

Example

flagCommentPublic 예시

Copy

1

2let (optResp, httpResp) = client.flagCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 isFlagged = true,

6 sso = ""

7)

8

9if optResp.isSome:

10 let empty = optResp.get()

11 discard empty

12

매개변수

응답

Returns: Option[GifGetLargeResponse]

예시

getGifLarge 예시

Copy

1

2let (gifOpt, httpResp) = client.getGifLarge(

3 tenantId = "my-tenant-123",

4 largeInternalURLSanitized = "https://cdn.example.com/gifs/large123.gif")

5if gifOpt.isSome:

6 let gif = gifOpt.get()

7 echo gif

8

매개변수

응답

Returns: Option[GetGifsSearchResponse]

예시

getGifsSearch 예시

Copy

1

2let opts = GetGifsSearchOptions(limit = 10, rating = "g")

3let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)

4if responseOpt.isSome:

5 let resp = responseOpt.get()

6 # resp를 필요에 따라 사용

7

매개변수

응답

반환: Option[GetGifsTrendingResponse]

예제

getGifsTrending 예제

Copy

1

2let (maybeResponse, httpResponse) = client.getGifsTrending(

3 tenantId = "my-tenant-123",

4 options = GetGifsTrendingOptions()

5)

6

7if maybeResponse.isSome:

8 let gifs = maybeResponse.get()

9 echo gifs

10

매개변수

응답

반환: Option[CreateHashTagResponse]

예시

addHashTag 예시

Copy

1

2let (hashTagOpt, httpResp) = client.addHashTag(

3 tenantId = "my-tenant-123",

4 createHashTagBody = CreateHashTagBody(),

5)

6

7if hashTagOpt.isSome:

8 let tag = hashTagOpt.get()

9

매개변수

응답

반환: Option[BulkCreateHashTagsResponse]

예시

addHashTagsBulk 예시

Copy

1

2let (optResp, httpResp) = client.addHashTagsBulk(

3 tenantId = "my-tenant-123",

4 bulkCreateHashTagsBody = BulkCreateHashTagsBody(

5 hashTags = @["news", "technology"]

6 )

7)

8

9if optResp.isSome:

10 let resp = optResp.get()

11

Parameters