fastcomments 0.1.0

data/client/docs/SORTDIR.md

@@ -0,0 +1,15 @@
+# FastCommentsClient::SORTDIR
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SORTDIR.new()
+```
+

data/client/docs/SSOSecurityLevel.md

@@ -0,0 +1,15 @@
+# FastCommentsClient::SSOSecurityLevel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SSOSecurityLevel.new()
+```
+

data/client/docs/SaveComment200Response.md

@@ -0,0 +1,38 @@
+# FastCommentsClient::SaveComment200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **comment** | [**FComment**](FComment.md) |  |  |
+| **user** | [**UserSessionInfo**](UserSessionInfo.md) |  |  |
+| **module_data** | **Hash<String, Object>** | Construct a type with a set of properties K of type T | [optional] |
+| **reason** | **String** |  |  |
+| **code** | **String** |  |  |
+| **secondary_code** | **String** |  | [optional] |
+| **banned_until** | **Integer** |  | [optional] |
+| **max_character_length** | **Integer** |  | [optional] |
+| **translated_error** | **String** |  | [optional] |
+| **custom_config** | [**CustomConfigParameters**](CustomConfigParameters.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SaveComment200Response.new(
+  status: null,
+  comment: null,
+  user: null,
+  module_data: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/SaveCommentResponse.md

@@ -0,0 +1,24 @@
+# FastCommentsClient::SaveCommentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **comment** | [**FComment**](FComment.md) |  |  |
+| **user** | [**UserSessionInfo**](UserSessionInfo.md) |  |  |
+| **module_data** | **Hash<String, Object>** | Construct a type with a set of properties K of type T | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SaveCommentResponse.new(
+  status: null,
+  comment: null,
+  user: null,
+  module_data: null
+)
+```
+

data/client/docs/SaveCommentResponseOptimized.md

@@ -0,0 +1,24 @@
+# FastCommentsClient::SaveCommentResponseOptimized
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **comment** | [**PublicComment**](PublicComment.md) |  |  |
+| **user** | [**UserSessionInfo**](UserSessionInfo.md) |  |  |
+| **module_data** | **Hash<String, Object>** | Construct a type with a set of properties K of type T | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SaveCommentResponseOptimized.new(
+  status: null,
+  comment: null,
+  user: null,
+  module_data: null
+)
+```
+

data/client/docs/SaveCommentsResponseWithPresence.md

@@ -0,0 +1,26 @@
+# FastCommentsClient::SaveCommentsResponseWithPresence
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **comment** | [**PublicComment**](PublicComment.md) |  |  |
+| **user** | [**UserSessionInfo**](UserSessionInfo.md) |  |  |
+| **module_data** | **Hash<String, Object>** | Construct a type with a set of properties K of type T | [optional] |
+| **user_id_ws** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SaveCommentsResponseWithPresence.new(
+  status: null,
+  comment: null,
+  user: null,
+  module_data: null,
+  user_id_ws: null
+)
+```
+

data/client/docs/SearchUsers200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::SearchUsers200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **users** | [**Array<UserSearchResult>**](UserSearchResult.md) |  |  |
+| **reason** | **String** |  |  |
+| **code** | **String** |  |  |
+| **secondary_code** | **String** |  | [optional] |
+| **banned_until** | **Integer** |  | [optional] |
+| **max_character_length** | **Integer** |  | [optional] |
+| **translated_error** | **String** |  | [optional] |
+| **custom_config** | [**CustomConfigParameters**](CustomConfigParameters.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SearchUsers200Response.new(
+  status: null,
+  users: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/SearchUsersResponse.md

@@ -0,0 +1,20 @@
+# FastCommentsClient::SearchUsersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **users** | [**Array<UserSearchResult>**](UserSearchResult.md) |  |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SearchUsersResponse.new(
+  status: null,
+  users: null
+)
+```
+

data/client/docs/SetCommentText200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::SetCommentText200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | [**SetCommentTextResult**](SetCommentTextResult.md) |  |  |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **reason** | **String** |  |  |
+| **code** | **String** |  |  |
+| **secondary_code** | **String** |  | [optional] |
+| **banned_until** | **Integer** |  | [optional] |
+| **max_character_length** | **Integer** |  | [optional] |
+| **translated_error** | **String** |  | [optional] |
+| **custom_config** | [**CustomConfigParameters**](CustomConfigParameters.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SetCommentText200Response.new(
+  comment: null,
+  status: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/SetCommentTextResult.md

@@ -0,0 +1,20 @@
+# FastCommentsClient::SetCommentTextResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approved** | **Boolean** |  |  |
+| **comment_html** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SetCommentTextResult.new(
+  approved: null,
+  comment_html: null
+)
+```
+

data/client/docs/SizePreset.md

@@ -0,0 +1,15 @@
+# FastCommentsClient::SizePreset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SizePreset.new()
+```
+

data/client/docs/SortDirections.md

@@ -0,0 +1,15 @@
+# FastCommentsClient::SortDirections
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SortDirections.new()
+```
+

data/client/docs/SpamRule.md

@@ -0,0 +1,20 @@
+# FastCommentsClient::SpamRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actions** | **Array<String>** |  |  |
+| **comment_contains** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::SpamRule.new(
+  actions: null,
+  comment_contains: null
+)
+```
+

data/client/docs/UnBlockCommentPublic200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::UnBlockCommentPublic200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **comment_statuses** | **Hash<String, Boolean>** | Construct a type with a set of properties K of type T |  |
+| **reason** | **String** |  |  |
+| **code** | **String** |  |  |
+| **secondary_code** | **String** |  | [optional] |
+| **banned_until** | **Integer** |  | [optional] |
+| **max_character_length** | **Integer** |  | [optional] |
+| **translated_error** | **String** |  | [optional] |
+| **custom_config** | [**CustomConfigParameters**](CustomConfigParameters.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UnBlockCommentPublic200Response.new(
+  status: null,
+  comment_statuses: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/UnBlockFromCommentParams.md

@@ -0,0 +1,18 @@
+# FastCommentsClient::UnBlockFromCommentParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment_ids_to_check** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UnBlockFromCommentParams.new(
+  comment_ids_to_check: null
+)
+```
+

data/client/docs/UnblockSuccess.md

@@ -0,0 +1,20 @@
+# FastCommentsClient::UnblockSuccess
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **comment_statuses** | **Hash<String, Boolean>** | Construct a type with a set of properties K of type T |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UnblockSuccess.new(
+  status: null,
+  comment_statuses: null
+)
+```
+

data/client/docs/UpdatableCommentParams.md

@@ -0,0 +1,94 @@
+# FastCommentsClient::UpdatableCommentParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url_id** | **String** |  | [optional] |
+| **url_id_raw** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **page_title** | **String** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+| **commenter_email** | **String** |  | [optional] |
+| **commenter_name** | **String** |  | [optional] |
+| **commenter_link** | **String** |  | [optional] |
+| **comment** | **String** |  | [optional] |
+| **comment_html** | **String** |  | [optional] |
+| **parent_id** | **String** |  | [optional] |
+| **date** | **Float** |  | [optional] |
+| **local_date_string** | **String** |  | [optional] |
+| **local_date_hours** | **Integer** |  | [optional] |
+| **votes** | **Integer** |  | [optional] |
+| **votes_up** | **Integer** |  | [optional] |
+| **votes_down** | **Integer** |  | [optional] |
+| **expire_at** | **Time** |  | [optional] |
+| **verified** | **Boolean** |  | [optional] |
+| **verified_date** | **Time** |  | [optional] |
+| **notification_sent_for_parent** | **Boolean** |  | [optional] |
+| **notification_sent_for_parent_tenant** | **Boolean** |  | [optional] |
+| **reviewed** | **Boolean** |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+| **external_parent_id** | **String** |  | [optional] |
+| **avatar_src** | **String** |  | [optional] |
+| **is_spam** | **Boolean** |  | [optional] |
+| **approved** | **Boolean** |  | [optional] |
+| **is_deleted** | **Boolean** |  | [optional] |
+| **is_deleted_user** | **Boolean** |  | [optional] |
+| **is_by_admin** | **Boolean** |  | [optional] |
+| **is_by_moderator** | **Boolean** |  | [optional] |
+| **is_pinned** | **Boolean** |  | [optional] |
+| **is_locked** | **Boolean** |  | [optional] |
+| **flag_count** | **Integer** |  | [optional] |
+| **display_label** | **String** |  | [optional] |
+| **meta** | [**FCommentMeta**](FCommentMeta.md) |  | [optional] |
+| **moderation_group_ids** | **Array<String>** |  | [optional] |
+| **feedback_ids** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UpdatableCommentParams.new(
+  url_id: null,
+  url_id_raw: null,
+  url: null,
+  page_title: null,
+  user_id: null,
+  commenter_email: null,
+  commenter_name: null,
+  commenter_link: null,
+  comment: null,
+  comment_html: null,
+  parent_id: null,
+  date: null,
+  local_date_string: null,
+  local_date_hours: null,
+  votes: null,
+  votes_up: null,
+  votes_down: null,
+  expire_at: null,
+  verified: null,
+  verified_date: null,
+  notification_sent_for_parent: null,
+  notification_sent_for_parent_tenant: null,
+  reviewed: null,
+  external_id: null,
+  external_parent_id: null,
+  avatar_src: null,
+  is_spam: null,
+  approved: null,
+  is_deleted: null,
+  is_deleted_user: null,
+  is_by_admin: null,
+  is_by_moderator: null,
+  is_pinned: null,
+  is_locked: null,
+  flag_count: null,
+  display_label: null,
+  meta: null,
+  moderation_group_ids: null,
+  feedback_ids: null
+)
+```
+

data/client/docs/UpdateAPIPageData.md

@@ -0,0 +1,26 @@
+# FastCommentsClient::UpdateAPIPageData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_closed** | **Boolean** |  | [optional] |
+| **accessible_by_group_ids** | **Array<String>** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **url_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UpdateAPIPageData.new(
+  is_closed: null,
+  accessible_by_group_ids: null,
+  title: null,
+  url: null,
+  url_id: null
+)
+```
+

data/client/docs/UpdateAPISSOUserData.md

@@ -0,0 +1,56 @@
+# FastCommentsClient::UpdateAPISSOUserData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_ids** | **Array<String>** |  | [optional] |
+| **has_blocked_users** | **Boolean** |  | [optional] |
+| **is_profile_dm_disabled** | **Boolean** |  | [optional] |
+| **is_profile_comments_private** | **Boolean** |  | [optional] |
+| **is_profile_activity_private** | **Boolean** |  | [optional] |
+| **is_comment_moderator_admin** | **Boolean** |  | [optional] |
+| **is_admin_admin** | **Boolean** |  | [optional] |
+| **is_account_owner** | **Boolean** |  | [optional] |
+| **display_name** | **String** |  | [optional] |
+| **display_label** | **String** |  | [optional] |
+| **opted_in_subscription_notifications** | **Boolean** |  | [optional] |
+| **opted_in_notifications** | **Boolean** |  | [optional] |
+| **avatar_src** | **String** |  | [optional] |
+| **login_count** | **Integer** |  | [optional] |
+| **created_from_url_id** | **String** |  | [optional] |
+| **sign_up_date** | **Integer** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **website_url** | **String** |  | [optional] |
+| **username** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UpdateAPISSOUserData.new(
+  group_ids: null,
+  has_blocked_users: null,
+  is_profile_dm_disabled: null,
+  is_profile_comments_private: null,
+  is_profile_activity_private: null,
+  is_comment_moderator_admin: null,
+  is_admin_admin: null,
+  is_account_owner: null,
+  display_name: null,
+  display_label: null,
+  opted_in_subscription_notifications: null,
+  opted_in_notifications: null,
+  avatar_src: null,
+  login_count: null,
+  created_from_url_id: null,
+  sign_up_date: null,
+  email: null,
+  website_url: null,
+  username: null,
+  id: null
+)
+```
+

data/client/docs/UpdateDomainConfigParams.md

@@ -0,0 +1,30 @@
+# FastCommentsClient::UpdateDomainConfigParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+| **email_from_name** | **String** |  | [optional] |
+| **email_from_email** | **String** |  | [optional] |
+| **logo_src** | **String** |  | [optional] |
+| **logo_src100px** | **String** |  | [optional] |
+| **footer_unsubscribe_url** | **String** |  | [optional] |
+| **email_headers** | **Hash<String, String>** | Construct a type with a set of properties K of type T | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UpdateDomainConfigParams.new(
+  domain: null,
+  email_from_name: null,
+  email_from_email: null,
+  logo_src: null,
+  logo_src100px: null,
+  footer_unsubscribe_url: null,
+  email_headers: null
+)
+```
+

data/client/docs/UpdateFeedPostParams.md

@@ -0,0 +1,28 @@
+# FastCommentsClient::UpdateFeedPostParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  | [optional] |
+| **content_html** | **String** |  | [optional] |
+| **media** | [**Array<FeedPostMediaItem>**](FeedPostMediaItem.md) |  | [optional] |
+| **links** | [**Array<FeedPostLink>**](FeedPostLink.md) |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **meta** | **Hash<String, String>** | Construct a type with a set of properties K of type T | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UpdateFeedPostParams.new(
+  title: null,
+  content_html: null,
+  media: null,
+  links: null,
+  tags: null,
+  meta: null
+)
+```
+

data/client/docs/UpdateUserBadge200Response.md

@@ -0,0 +1,32 @@
+# FastCommentsClient::UpdateUserBadge200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **reason** | **String** |  |  |
+| **code** | **String** |  |  |
+| **secondary_code** | **String** |  | [optional] |
+| **banned_until** | **Integer** |  | [optional] |
+| **max_character_length** | **Integer** |  | [optional] |
+| **translated_error** | **String** |  | [optional] |
+| **custom_config** | [**CustomConfigParameters**](CustomConfigParameters.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UpdateUserBadge200Response.new(
+  status: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/UpdateUserBadgeParams.md

@@ -0,0 +1,18 @@
+# FastCommentsClient::UpdateUserBadgeParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **displayed_on_comments** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::UpdateUserBadgeParams.new(
+  displayed_on_comments: null
+)
+```
+