fastcomments 0.2.0 → 1.0.0

data/client/docs/CreateTenantBody.md

@@ -0,0 +1,62 @@
+# FastCommentsClient::CreateTenantBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **domain_configuration** | [**Array<APIDomainConfiguration>**](APIDomainConfiguration.md) |  |  |
+| **email** | **String** |  | [optional] |
+| **sign_up_date** | **Float** |  | [optional] |
+| **package_id** | **String** |  | [optional] |
+| **payment_frequency** | **Float** |  | [optional] |
+| **billing_info_valid** | **Boolean** |  | [optional] |
+| **billing_handled_externally** | **Boolean** |  | [optional] |
+| **created_by** | **String** |  | [optional] |
+| **is_setup** | **Boolean** |  | [optional] |
+| **billing_info** | [**BillingInfo**](BillingInfo.md) |  | [optional] |
+| **stripe_customer_id** | **String** |  | [optional] |
+| **stripe_subscription_id** | **String** |  | [optional] |
+| **stripe_plan_id** | **String** |  | [optional] |
+| **enable_profanity_filter** | **Boolean** |  | [optional] |
+| **enable_spam_filter** | **Boolean** |  | [optional] |
+| **remove_unverified_comments** | **Boolean** |  | [optional] |
+| **unverified_comments_tt_lms** | **Float** |  | [optional] |
+| **comments_require_approval** | **Boolean** |  | [optional] |
+| **auto_approve_comment_on_verification** | **Boolean** |  | [optional] |
+| **send_profane_to_spam** | **Boolean** |  | [optional] |
+| **de_anon_ip_addr** | **Float** |  | [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::CreateTenantBody.new(
+  name: null,
+  domain_configuration: null,
+  email: null,
+  sign_up_date: null,
+  package_id: null,
+  payment_frequency: null,
+  billing_info_valid: null,
+  billing_handled_externally: null,
+  created_by: null,
+  is_setup: null,
+  billing_info: null,
+  stripe_customer_id: null,
+  stripe_subscription_id: null,
+  stripe_plan_id: null,
+  enable_profanity_filter: null,
+  enable_spam_filter: null,
+  remove_unverified_comments: null,
+  unverified_comments_tt_lms: null,
+  comments_require_approval: null,
+  auto_approve_comment_on_verification: null,
+  send_profane_to_spam: null,
+  de_anon_ip_addr: null,
+  meta: null
+)
+```
+

data/client/docs/CreateTenantPackage200Response.md

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

data/client/docs/CreateTenantPackageBody.md

@@ -0,0 +1,112 @@
+# FastCommentsClient::CreateTenantPackageBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **monthly_cost_usd** | **Float** |  | [optional] |
+| **yearly_cost_usd** | **Float** |  | [optional] |
+| **monthly_stripe_plan_id** | **String** |  | [optional] |
+| **yearly_stripe_plan_id** | **String** |  | [optional] |
+| **max_monthly_page_loads** | **Float** |  |  |
+| **max_monthly_api_credits** | **Float** |  |  |
+| **max_monthly_small_widgets_credits** | **Float** |  | [optional] |
+| **max_monthly_comments** | **Float** |  |  |
+| **max_concurrent_users** | **Float** |  |  |
+| **max_tenant_users** | **Float** |  |  |
+| **max_sso_users** | **Float** |  |  |
+| **max_moderators** | **Float** |  |  |
+| **max_domains** | **Float** |  |  |
+| **max_white_labeled_tenants** | **Float** |  | [optional] |
+| **max_monthly_event_log_requests** | **Float** |  | [optional] |
+| **has_white_labeling** | **Boolean** |  | [optional] |
+| **has_debranding** | **Boolean** |  |  |
+| **has_llm_spam_detection** | **Boolean** |  | [optional] |
+| **for_who_text** | **String** |  |  |
+| **feature_taglines** | **Array<String>** |  |  |
+| **has_auditing** | **Boolean** |  | [optional] |
+| **has_flex_pricing** | **Boolean** |  |  |
+| **enable_saml** | **Boolean** |  | [optional] |
+| **flex_page_load_cost_cents** | **Float** |  | [optional] |
+| **flex_page_load_unit** | **Float** |  | [optional] |
+| **flex_comment_cost_cents** | **Float** |  | [optional] |
+| **flex_comment_unit** | **Float** |  | [optional] |
+| **flex_sso_user_cost_cents** | **Float** |  | [optional] |
+| **flex_sso_user_unit** | **Float** |  | [optional] |
+| **flex_api_credit_cost_cents** | **Float** |  | [optional] |
+| **flex_api_credit_unit** | **Float** |  | [optional] |
+| **flex_small_widgets_credit_cost_cents** | **Float** |  | [optional] |
+| **flex_small_widgets_credit_unit** | **Float** |  | [optional] |
+| **flex_moderator_cost_cents** | **Float** |  | [optional] |
+| **flex_moderator_unit** | **Float** |  | [optional] |
+| **flex_admin_cost_cents** | **Float** |  | [optional] |
+| **flex_admin_unit** | **Float** |  | [optional] |
+| **flex_domain_cost_cents** | **Float** |  | [optional] |
+| **flex_domain_unit** | **Float** |  | [optional] |
+| **flex_chat_gpt_cost_cents** | **Float** |  | [optional] |
+| **flex_chat_gpt_unit** | **Float** |  | [optional] |
+| **flex_minimum_cost_cents** | **Float** |  | [optional] |
+| **flex_managed_tenant_cost_cents** | **Float** |  | [optional] |
+| **flex_sso_admin_cost_cents** | **Float** |  | [optional] |
+| **flex_sso_admin_unit** | **Float** |  | [optional] |
+| **flex_sso_moderator_cost_cents** | **Float** |  | [optional] |
+| **flex_sso_moderator_unit** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::CreateTenantPackageBody.new(
+  name: null,
+  monthly_cost_usd: null,
+  yearly_cost_usd: null,
+  monthly_stripe_plan_id: null,
+  yearly_stripe_plan_id: null,
+  max_monthly_page_loads: null,
+  max_monthly_api_credits: null,
+  max_monthly_small_widgets_credits: null,
+  max_monthly_comments: null,
+  max_concurrent_users: null,
+  max_tenant_users: null,
+  max_sso_users: null,
+  max_moderators: null,
+  max_domains: null,
+  max_white_labeled_tenants: null,
+  max_monthly_event_log_requests: null,
+  has_white_labeling: null,
+  has_debranding: null,
+  has_llm_spam_detection: null,
+  for_who_text: null,
+  feature_taglines: null,
+  has_auditing: null,
+  has_flex_pricing: null,
+  enable_saml: null,
+  flex_page_load_cost_cents: null,
+  flex_page_load_unit: null,
+  flex_comment_cost_cents: null,
+  flex_comment_unit: null,
+  flex_sso_user_cost_cents: null,
+  flex_sso_user_unit: null,
+  flex_api_credit_cost_cents: null,
+  flex_api_credit_unit: null,
+  flex_small_widgets_credit_cost_cents: null,
+  flex_small_widgets_credit_unit: null,
+  flex_moderator_cost_cents: null,
+  flex_moderator_unit: null,
+  flex_admin_cost_cents: null,
+  flex_admin_unit: null,
+  flex_domain_cost_cents: null,
+  flex_domain_unit: null,
+  flex_chat_gpt_cost_cents: null,
+  flex_chat_gpt_unit: null,
+  flex_minimum_cost_cents: null,
+  flex_managed_tenant_cost_cents: null,
+  flex_sso_admin_cost_cents: null,
+  flex_sso_admin_unit: null,
+  flex_sso_moderator_cost_cents: null,
+  flex_sso_moderator_unit: null
+)
+```
+

data/client/docs/CreateTenantPackageResponse.md

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

data/client/docs/CreateTenantResponse.md

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

data/client/docs/CreateTenantUser200Response.md

@@ -0,0 +1,34 @@
+# FastCommentsClient::CreateTenantUser200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**APIStatus**](APIStatus.md) |  |  |
+| **tenant_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::CreateTenantUser200Response.new(
+  status: null,
+  tenant_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/CreateTenantUserBody.md

@@ -0,0 +1,64 @@
+# FastCommentsClient::CreateTenantUserBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+| **email** | **String** |  |  |
+| **display_name** | **String** |  | [optional] |
+| **website_url** | **String** |  | [optional] |
+| **sign_up_date** | **Float** |  | [optional] |
+| **locale** | **String** |  | [optional] |
+| **verified** | **Boolean** |  | [optional] |
+| **login_count** | **Float** |  | [optional] |
+| **opted_in_notifications** | **Boolean** |  | [optional] |
+| **opted_in_tenant_notifications** | **Boolean** |  | [optional] |
+| **hide_account_code** | **Boolean** |  | [optional] |
+| **avatar_src** | **String** |  | [optional] |
+| **is_help_request_admin** | **Boolean** |  | [optional] |
+| **is_account_owner** | **Boolean** |  | [optional] |
+| **is_admin_admin** | **Boolean** |  | [optional] |
+| **is_billing_admin** | **Boolean** |  | [optional] |
+| **is_analytics_admin** | **Boolean** |  | [optional] |
+| **is_customization_admin** | **Boolean** |  | [optional] |
+| **is_manage_data_admin** | **Boolean** |  | [optional] |
+| **is_comment_moderator_admin** | **Boolean** |  | [optional] |
+| **is_api_admin** | **Boolean** |  | [optional] |
+| **moderator_ids** | **Array<String>** |  | [optional] |
+| **digest_email_frequency** | **Float** |  | [optional] |
+| **display_label** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fastcomments-client'
+
+instance = FastCommentsClient::CreateTenantUserBody.new(
+  username: null,
+  email: null,
+  display_name: null,
+  website_url: null,
+  sign_up_date: null,
+  locale: null,
+  verified: null,
+  login_count: null,
+  opted_in_notifications: null,
+  opted_in_tenant_notifications: null,
+  hide_account_code: null,
+  avatar_src: null,
+  is_help_request_admin: null,
+  is_account_owner: null,
+  is_admin_admin: null,
+  is_billing_admin: null,
+  is_analytics_admin: null,
+  is_customization_admin: null,
+  is_manage_data_admin: null,
+  is_comment_moderator_admin: null,
+  is_api_admin: null,
+  moderator_ids: null,
+  digest_email_frequency: null,
+  display_label: null
+)
+```
+

data/client/docs/CreateTenantUserResponse.md

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

data/client/docs/CreateVote200Response.md

@@ -0,0 +1,32 @@
+# FastCommentsClient::CreateVote200Response
+
+## 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::CreateVote200Response.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/CreateVoteResponse.md

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

data/client/docs/CustomEmailTemplate.md

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