SDK de FastComments para Nim

• Nim >= 1.6.0
• nimcrypto >= 0.5.4

Usando Nimble

nimble install fastcomments

Compilando desde el código fuente

nimble build

Contenido de la biblioteca

Esta biblioteca contiene el cliente API generado y las utilidades SSO para facilitar el trabajo con la API.

• API Client Library Docs

APIs públicas vs seguras

Para el cliente API, existen tres módulos API, api_default, api_public y api_moderation. El módulo api_default contiene métodos que requieren tu clave API, y api_public contiene llamadas API que pueden realizarse directamente desde un navegador/dispositivo móvil/etc. sin autenticación. El módulo api_moderation contiene métodos para el panel de moderador.

El módulo api_moderation ofrece una amplia suite de APIs de moderación en tiempo real y rápidas. Cada método api_moderation acepta un parámetro sso y puede autenticarse mediante SSO o una cookie de sesión de FastComments.com.

Uso de APIs autenticadas (DefaultAPI)

Importante: Los puntos finales autenticados requieren que tu clave API se establezca en el encabezado 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"

# Realizar llamadas a la API autenticada.
# Los parámetros requeridos (y el cuerpo de la solicitud) son posicionales; los opcionales
# los parámetros se pasan mediante el objeto de opciones de la operación.
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"

Uso de APIs públicas (PublicAPI)

Los puntos finales públicos no requieren autenticación:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Realizar llamadas a la API pública.
# tenantId y urlId son requeridos (posicionales); todo lo demás es opcional.
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"

Uso de APIs de moderación (ModerationAPI)

Los puntos finales de moderación impulsan el panel de moderador y se autentican con un token SSO para el moderador activo:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Listar comentarios en el panel de moderación.
# Esta operación no tiene parámetros requeridos, por lo que todo es opcional.
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"

Problemas comunes

1. Error de autenticación 401: Asegúrate de establecer el encabezado x-api-key en tu HttpClient antes de realizar solicitudes a DefaultAPI: client.headers["x-api-key"] = "your-api-key"
2. Clase API incorrecta: Usa api_default para solicitudes autenticadas del lado del servidor, api_public para solicitudes del lado del cliente/públicas, y api_moderation para solicitudes del panel de moderador.

Todos los métodos API en este SDK devuelven tuplas de (Option[ResponseType], Response). El primer elemento contiene la respuesta analizada si tiene éxito, y el segundo elemento es la respuesta HTTP cruda.

Los parámetros obligatorios y el cuerpo de la solicitud se pasan posicionalmente. Los parámetros opcionales restantes se recopilan en un único objeto Api<Operation>Options, que es el último argumento. Las operaciones sin parámetros opcionales no usan objeto de opciones.

Ejemplo: Obtención de Comentarios

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"

IDs de transmisión

Verás que debes pasar un broadcastId en algunas llamadas a la API. Cuando recibas eventos, obtendrás este ID de vuelta, para que sepas ignorar el evento si planeas aplicar cambios optimistamente en el cliente (lo cual probablemente querrás hacer ya que ofrece la mejor experiencia). Pasa un UUID aquí. El ID debe ser lo suficientemente único como para no ocurrir dos veces en una sesión del navegador.

SSO (Inicio de sesión único)

Para ejemplos de SSO, consulta más abajo.

SSO simple

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 seguro

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

Aggrega documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones.
Se admiten diferentes operaciones (p. ej., sum, countDistinct, avg, etc.).

Parámetros

Respuesta

Devuelve: Option[AggregateResponse]

Ejemplo

Ejemplo de agregación

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

Parámetros

Respuesta

Devuelve: Option[GetAuditLogsResponse]

Ejemplo

Ejemplo 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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

logoutPublic Ejemplo

Copy

1

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

3if responseOpt.isSome:

4 let emptyResponse = responseOpt.get()

5

Parámetros

Respuesta

Devuelve: Option[BlockSuccess]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[UnblockSuccess]

Ejemplo

unBlockCommentPublic Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[CheckBlockedCommentsResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[BlockSuccess]

Ejemplo

Ejemplo 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

Devuelve: Option[SaveCommentsResponseWithPresence]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[DeleteCommentResult]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[PublicAPIDeleteCommentResponse]

Ejemplo

deleteCommentPublic Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[VoteDeleteResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[FlagCommentResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[APIGetCommentResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[APIGetCommentsResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[GetCommentsResponseWithPresencePublicComment]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[PublicAPIGetCommentTextResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[GetCommentVoteUserNamesSuccessResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[ChangeCommentPinStatusResponse]

Ejemplo

Ejemplo de 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

Parameters

Response

Devuelve: Option[APISaveCommentResponse]

Example

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Returns: Option[PublicAPISetCommentTextResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[UnblockSuccess]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[FlagCommentResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Returns: Option[APIEmptyResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[ChangeCommentPinStatusResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[VoteResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[GetCommentsForUserResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[AddDomainConfigResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[DeleteDomainConfigResponse]

Ejemplo

deleteDomainConfig Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[GetDomainConfigResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[GetDomainConfigsResponse]

Ejemplo

Ejemplo getDomainConfigs

Copy

1

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

3if domainConfigsOpt.isSome:

4 let domainConfigs = domainConfigsOpt.get()

5 echo domainConfigs

6

Parámetros

Respuesta

Devuelve: Option[PatchDomainConfigResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[PutDomainConfigResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[CreateEmailTemplateResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

deleteEmailTemplate Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

deleteEmailTemplateRenderError Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[GetEmailTemplateResponse]

Ejemplo

getEmailTemplate Ejemplo

Copy

1

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

3if response.isSome:

4 let tmpl = response.get()

5

Parámetros

Respuesta

Devuelve: Option[GetEmailTemplateDefinitionsResponse]

Ejemplo

Ejemplo de getEmailTemplateDefinitions

Copy

1

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

3if responseOpt.isSome:

4 let definitions = responseOpt.get()

5 echo definitions

6

Parámetros

Respuesta

Devuelve: Option[GetEmailTemplateRenderErrorsResponse]

Ejemplo

Ejemplo 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 # usar la respuesta según sea necesario

11else:

12 # manejar respuesta faltante

13 discard

14

Parámetros

Respuesta

Devuelve: Option[GetEmailTemplatesResponse]

Ejemplo

getEmailTemplates Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[RenderEmailTemplateResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

updateEmailTemplate Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[GetEventLogResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[GetEventLogResponse]

Ejemplo

getGlobalEventLog Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[CreateFeedPostsResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[CreateFeedPostResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[DeleteFeedPostPublicResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[GetFeedPostsResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[PublicFeedPostsResponse]

Ejemplo

getFeedPostsPublic Ejemplo

Copy

1

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

3if feedResponseOpt.isSome:

4 let feedResponse = feedResponseOpt.get()

5

Parámetros

Respuesta

Devuelve: Option[FeedPostsStatsResponse]

Ejemplo

Ejemplo 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 # usar stats según sea necesario

11

12

13

Parámetros

Respuesta

Devuelve: Option[UserReactsResponse]

Ejemplo

getUserReactsPublic Ejemplo

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

Parámetros

Respuesta

Devuelve: Option[ReactFeedPostResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[CreateFeedPostResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[GifGetLargeResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[GetGifsSearchResponse]

Ejemplo

Ejemplo 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 # usar resp según sea necesario

7

Parámetros

Respuesta

Devuelve: Option[GetGifsTrendingResponse]

Ejemplo

Ejemplo 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

Parámetros

Respuesta

Devuelve: Option[CreateHashTagResponse]

Ejemplo

Ejemplo de 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

Parámetros

Respuesta

Devuelve: Option[BulkCreateHashTagsResponse]

Ejemplo

Ejemplo 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

Parámetros