fastcomments 0.3.0 → 1.0.0

data/client/docs/GetTenantUsersResponse.md

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

data/client/docs/GetTenants200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::GetTenants200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **tenants** | [**Array<APITenant>**](APITenant.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::GetTenants200Response.new(
+  status: null,
+  tenants: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/GetTenantsResponse.md

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

data/client/docs/GetUser200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::GetUser200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **user** | [**User**](User.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::GetUser200Response.new(
+  status: null,
+  user: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/GetUserResponse.md

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

data/client/docs/GetVotes200Response.md

@@ -0,0 +1,38 @@
+# FastCommentsClient::GetVotes200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **applied_authorized_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **applied_anonymous_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **pending_votes** | [**Array<PublicVote>**](PublicVote.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::GetVotes200Response.new(
+  status: null,
+  applied_authorized_votes: null,
+  applied_anonymous_votes: null,
+  pending_votes: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/GetVotesForUser200Response.md

@@ -0,0 +1,38 @@
+# FastCommentsClient::GetVotesForUser200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **applied_authorized_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **applied_anonymous_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **pending_votes** | [**Array<PublicVote>**](PublicVote.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::GetVotesForUser200Response.new(
+  status: null,
+  applied_authorized_votes: null,
+  applied_anonymous_votes: null,
+  pending_votes: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/GetVotesForUserResponse.md

@@ -0,0 +1,24 @@
+# FastCommentsClient::GetVotesForUserResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **applied_authorized_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **applied_anonymous_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **pending_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::GetVotesForUserResponse.new(
+  status: null,
+  applied_authorized_votes: null,
+  applied_anonymous_votes: null,
+  pending_votes: null
+)
+```
+

data/client/docs/GetVotesResponse.md

@@ -0,0 +1,24 @@
+# FastCommentsClient::GetVotesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **applied_authorized_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **applied_anonymous_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+| **pending_votes** | [**Array<PublicVote>**](PublicVote.md) |  |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::GetVotesResponse.new(
+  status: null,
+  applied_authorized_votes: null,
+  applied_anonymous_votes: null,
+  pending_votes: null
+)
+```
+

data/client/docs/ImportedSiteType.md

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

data/client/docs/Moderator.md

@@ -0,0 +1,52 @@
+# FastCommentsClient::Moderator
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **accepted_invite** | **Boolean** |  |  |
+| **email** | **String** |  |  |
+| **mark_reviewed_count** | **Float** |  |  |
+| **deleted_count** | **Float** |  |  |
+| **marked_spam_count** | **Float** |  |  |
+| **marked_not_spam_count** | **Float** |  |  |
+| **approved_count** | **Float** |  |  |
+| **un_approved_count** | **Float** |  |  |
+| **edited_count** | **Float** |  |  |
+| **banned_count** | **Float** |  |  |
+| **un_flagged_count** | **Float** |  |  |
+| **verification_id** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **moderation_group_ids** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::Moderator.new(
+  _id: null,
+  tenant_id: null,
+  name: null,
+  user_id: null,
+  accepted_invite: null,
+  email: null,
+  mark_reviewed_count: null,
+  deleted_count: null,
+  marked_spam_count: null,
+  marked_not_spam_count: null,
+  approved_count: null,
+  un_approved_count: null,
+  edited_count: null,
+  banned_count: null,
+  un_flagged_count: null,
+  verification_id: null,
+  created_at: null,
+  moderation_group_ids: null
+)
+```
+

data/client/docs/PatchHashTag200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::PatchHashTag200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **hash_tag** | [**TenantHashTag**](TenantHashTag.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::PatchHashTag200Response.new(
+  status: null,
+  hash_tag: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/PendingCommentToSyncOutbound.md

@@ -0,0 +1,42 @@
+# FastCommentsClient::PendingCommentToSyncOutbound
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  |  |
+| **comment_id** | **String** |  |  |
+| **comment** | [**FComment**](FComment.md) |  | [optional] |
+| **external_id** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **tenant_id** | **String** |  |  |
+| **attempt_count** | **Float** |  |  |
+| **next_attempt_at** | **Time** |  |  |
+| **event_type** | **Float** |  |  |
+| **type** | **Float** |  |  |
+| **domain** | **String** |  |  |
+| **last_error** | **Object** |  |  |
+| **webhook_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::PendingCommentToSyncOutbound.new(
+  _id: null,
+  comment_id: null,
+  comment: null,
+  external_id: null,
+  created_at: null,
+  tenant_id: null,
+  attempt_count: null,
+  next_attempt_at: null,
+  event_type: null,
+  type: null,
+  domain: null,
+  last_error: null,
+  webhook_id: null
+)
+```
+

data/client/docs/PublicApi.md

@@ -1801,7 +1801,7 @@ No authorization required
 
 ## search_users
 
-> <SearchUsers200Response> search_users(tenant_id, url_id, username_starts_with, opts)
+> <SearchUsers200Response> search_users(tenant_id, url_id, opts)
 
 
 
@@ -1814,15 +1814,15 @@ require 'fastcomments-client'
 api_instance = FastCommentsClient::PublicApi.new
 tenant_id = 'tenant_id_example' # String | 
 url_id = 'url_id_example' # String | 
-username_starts_with = 'username_starts_with_example' # String | 
 opts = {
+  username_starts_with: 'username_starts_with_example', # String | 
   mention_group_ids: ['inner_example'], # Array<String> | 
   sso: 'sso_example' # String | 
 }
 
 begin
   
-  result = api_instance.search_users(tenant_id, url_id, username_starts_with, opts)
+  result = api_instance.search_users(tenant_id, url_id, opts)
   p result
 rescue FastCommentsClient::ApiError => e
   puts "Error when calling PublicApi->search_users: #{e}"
@@ -1833,12 +1833,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SearchUsers200Response>, Integer, Hash)> search_users_with_http_info(tenant_id, url_id, username_starts_with, opts)
+> <Array(<SearchUsers200Response>, Integer, Hash)> search_users_with_http_info(tenant_id, url_id, opts)
 
 ```ruby
 begin
   
-  data, status_code, headers = api_instance.search_users_with_http_info(tenant_id, url_id, username_starts_with, opts)
+  data, status_code, headers = api_instance.search_users_with_http_info(tenant_id, url_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SearchUsers200Response>
@@ -1853,7 +1853,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **tenant_id** | **String** |  |  |
 | **url_id** | **String** |  |  |
-| **username_starts_with** | **String** |  |  |
+| **username_starts_with** | **String** |  | [optional] |
 | **mention_group_ids** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
 | **sso** | **String** |  | [optional] |
 

data/client/docs/PublicVote.md

@@ -0,0 +1,28 @@
+# FastCommentsClient::PublicVote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **url_id** | **String** |  |  |
+| **comment_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **direction** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::PublicVote.new(
+  id: null,
+  url_id: null,
+  comment_id: null,
+  user_id: null,
+  direction: null,
+  created_at: null
+)
+```
+

data/client/docs/QuestionConfig.md

@@ -0,0 +1,58 @@
+# FastCommentsClient::QuestionConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **question** | **String** |  |  |
+| **summary_label** | **String** |  | [optional] |
+| **help_text** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **created_by** | **String** |  |  |
+| **used_count** | **Float** |  |  |
+| **last_used** | **Time** |  |  |
+| **type** | **String** |  |  |
+| **num_stars** | **Float** |  |  |
+| **min** | **Float** |  |  |
+| **max** | **Float** |  |  |
+| **default_value** | **Float** |  |  |
+| **label_negative** | **String** |  |  |
+| **label_positive** | **String** |  |  |
+| **custom_options** | [**Array<QuestionConfigCustomOptionsInner>**](QuestionConfigCustomOptionsInner.md) |  |  |
+| **sub_question_ids** | **Array<String>** |  |  |
+| **always_show_sub_questions** | **Boolean** |  |  |
+| **reporting_order** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::QuestionConfig.new(
+  _id: null,
+  tenant_id: null,
+  name: null,
+  question: null,
+  summary_label: null,
+  help_text: null,
+  created_at: null,
+  created_by: null,
+  used_count: null,
+  last_used: null,
+  type: null,
+  num_stars: null,
+  min: null,
+  max: null,
+  default_value: null,
+  label_negative: null,
+  label_positive: null,
+  custom_options: null,
+  sub_question_ids: null,
+  always_show_sub_questions: null,
+  reporting_order: null
+)
+```
+

data/client/docs/QuestionConfigCustomOptionsInner.md

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

data/client/docs/RenderEmailTemplate200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::RenderEmailTemplate200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **html** | **String** |  |  |
+| **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::RenderEmailTemplate200Response.new(
+  status: null,
+  html: null,
+  reason: null,
+  code: null,
+  secondary_code: null,
+  banned_until: null,
+  max_character_length: null,
+  translated_error: null,
+  custom_config: null
+)
+```
+

data/client/docs/RenderEmailTemplateBody.md

@@ -0,0 +1,24 @@
+# FastCommentsClient::RenderEmailTemplateBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_template_id** | **String** |  |  |
+| **ejs** | **String** |  |  |
+| **test_data** | **Hash<String, Object>** | Construct a type with a set of properties K of type T | [optional] |
+| **translation_overrides_by_locale** | **Hash<String, Hash>** | Construct a type with a set of properties K of type T | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::RenderEmailTemplateBody.new(
+  email_template_id: null,
+  ejs: null,
+  test_data: null,
+  translation_overrides_by_locale: null
+)
+```
+

data/client/docs/RenderEmailTemplateResponse.md

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