Skip to content

Releases: FastComments/fastcomments-ruby

v3.0.0

Choose a tag to compare

@winrid winrid released this 30 Jun 19:20
b1efec9

Regenerates the Ruby client from the latest OpenAPI spec. Two notable changes since the last release:

Grouped request parameters: all API methods now take required parameters and the request body positionally, with an operation's optional parameters that use the conventional trailing opts = {} hash.

Moderation API: adds the moderator-dashboard endpoints (listing, searching, counting and exporting comments and logs; moderation actions such as remove/restore/flag and review/spam/approval status; vote adjustments; bans; badges and trust), authenticated with an SSO moderator token.

Model rename: PostRemoveCommentResponse is renamed to PostRemoveCommentApiResponse.

v2.0.0

Choose a tag to compare

@winrid winrid released this 19 Jun 18:21

Adds the Moderation API (moderator dashboard) and renames response types to stable names. This is a breaking change (renamed return types), hence the major version bump.

1.2.1

Choose a tag to compare

@winrid winrid released this 25 Mar 05:34

What's New

Tickets API

  • Added full support for the Tickets system: list tickets, get ticket details, create tickets, and change ticket state via the API
  • New models: APITicket, APITicketDetail, APITicketFile, along with corresponding request/response types

Subscription Updates

  • Added UpdateSubscription endpoint (PATCH /api/v1/subscriptions/{id}) to update existing subscriptions
  • New notificationFrequency field on subscriptions for controlling notification delivery cadence

User Search Improvements

  • Added sectioned user search support with new searchSection parameter (fast, site)
  • New models: UserSearchSection, UserSearchSectionResult, SearchUsersSectionedResponse
  • New MentionAutoCompleteMode enum for configuring mention autocomplete behavior

Terms of Service Support

  • New TOSConfig model for configuring terms of service per tenant
  • Added tos field to CustomConfigParameters and comment creation params
  • Added tosAcceptedAt tracking on user badge progress
  • Added needsTOS flag to UserSessionInfo

Ticketing Configuration

  • New config parameters: ticketBaseUrl, ticketKBSearchEndpoint, ticketFileUploadsEnabled, ticketMaxFileSize, ticketAutoAssignUserIds

Improvements

User Model

  • Added backupEmail and pendingBackupEmail fields
  • Added isSiteAdmin role flag
  • Added notificationFrequency and adminNotificationFrequency controls
  • Added lastTenantNotificationSentDate and lastReplyNotificationSentDate tracking
  • Added isEmailSuppressed flag (also added to Moderator model)

Widget Configuration

  • Added disableProfileComments and disableProfileDirectMessages options
  • Added widgetQuestionShowBreakdown option for question/poll widgets
  • Added mentionAutoCompleteMode to CustomConfigParameters

Header State

  • Added HeaderAccountNotification model with support for localized messages, severity levels, and links
  • Added accountNotifications array to HeaderState

Tenant Packages

  • Added maxCustomCollectionSize field
  • Added enableCanvasLTI flag for Canvas LMS integration

Comments

  • Added wpId to comment metadata (APICommentBaseMeta, FCommentMeta)
  • Added urlId field to UserBadge

Bug Fixes

Integer Enum Types

  • Fixed numeric enum types (CommentApprovalStatus, CommentThreadDeletionMode, CommenterNameFormats, SortStyle, NotificationType, ImportedSiteType, and others) to use integer instead of number in the OpenAPI spec, ensuring proper type generation in the SDK

Release 1.2.0

Choose a tag to compare

@winrid winrid released this 09 Jan 05:05
adfe280

Fixes vote response objects to be properly typed.

Release 1.0.0

Choose a tag to compare

@winrid winrid released this 08 Jan 19:53
3a36e75

Adds: email-templates, hash-tags, moderators, notification-count, notifications, pending-webhook-events, question-config, question-results, tenant-daily-usage, tenant-packages, tenants, tenant-users, users, votes

Release 0.3.0

Choose a tag to compare

@winrid winrid released this 20 Nov 23:16
319721c
  • Add ApiModelBase (lib/fastcomments-client/api_model_base.rb) that centralizes deserialization and hash/serialization helpers (to_s, to_body, _to_hash, _deserialize behaviour).
  • Refactor models to inherit from ApiModelBase (many model classes updated to < ApiModelBase) and remove duplicated implementations of _deserialize, to_s, to_body and _to_hash from individual model files to DRY up the codebase.
  • Simplify anyOf handling in multiple generated anyOf wrapper classes: return find_and_cast_into_type(...) directly instead of assigning temporary typed_data variable.
  • Change VoteResponse.status representation: replace the generated VoteResponseStatus model/anyOf with a plain String type; add enum validation for allowed status values (success, failed, pending-verification). Remove the VoteResponseStatus model and its docs.
  • Add approved boolean property to PublicComment and PublicCommentBase (openapi.json and generated docs/models updated); wire attribute into attribute_map, openapi_types, initializer, equality/hash and docs.
  • Require the new ApiModelBase from the main library file (lib/fastcomments-client.rb) and stop requiring removed VoteResponseStatus model.
  • Update many model files to reflect the generator changes (generator version header updates, inheritance change, small internal refactors) — e.g., AddDomainConfig200ResponseAnyOf, AddDomainConfigParams, AddPageAPIResponse, Aggregation* models, API* models, Block*/Unblock*, Comment*, FeedPost*, Public* models and many others.
  • Update generated specs: comment out auto-instantiation helper lines and update generator version notes in many spec files; various model spec files updated to reflect generator changes and removed generated helper objects.
  • Remove VoteResponseStatus documentation file (docs/VoteResponseStatus.md) and update README/docs table of models to remove that entry.
  • Minor codegen cleanups throughout (small style and simplification changes in many generated files: e.g. inlined returns, header generator version updates).

v0.2.0

Choose a tag to compare

@winrid winrid released this 19 Nov 21:12
  • Fixes endpoints that use anyOf.
  • Adds "notes" in add user badge response.
  • Adds "no_new_root_comments" to custom configs.
  • Adds "comments_updated" to page API.

Full Changelog: https://github.com/FastComments/fastcomments-ruby/commits/v0.2.0