Skip to content

README.md

Latest commit

 

History

History
610 lines (570 loc) · 51.8 KB

README.md

File metadata and controls

610 lines (570 loc) · 51.8 KB

fastcomments-client

FastCommentsClient - the Ruby gem for the fastcomments

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.0
  • Package version: 1.2.0
  • Generator version: 7.19.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build fastcomments-client.gemspec

Then either install the gem locally:

gem install ./fastcomments-client-1.2.0.gem

(for development, run gem install --dev ./fastcomments-client-1.2.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'fastcomments-client', '~> 1.2.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'fastcomments-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'fastcomments-client'

# Setup authorization
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 

begin
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Exception when calling DefaultApi->add_domain_config: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://fastcomments.com

Class Method HTTP request Description
FastCommentsClient::DefaultApi add_domain_config POST /api/v1/domain-configs
FastCommentsClient::DefaultApi add_hash_tag POST /api/v1/hash-tags
FastCommentsClient::DefaultApi add_hash_tags_bulk POST /api/v1/hash-tags/bulk
FastCommentsClient::DefaultApi add_page POST /api/v1/pages
FastCommentsClient::DefaultApi add_sso_user POST /api/v1/sso-users
FastCommentsClient::DefaultApi aggregate POST /api/v1/aggregate
FastCommentsClient::DefaultApi aggregate_question_results GET /api/v1/question-results-aggregation
FastCommentsClient::DefaultApi block_user_from_comment POST /api/v1/comments/{id}/block
FastCommentsClient::DefaultApi bulk_aggregate_question_results POST /api/v1/question-results-aggregation/bulk
FastCommentsClient::DefaultApi change_ticket_state PATCH /api/v1/tickets/{id}/state
FastCommentsClient::DefaultApi combine_comments_with_question_results GET /api/v1/question-results-aggregation/combine/comments
FastCommentsClient::DefaultApi create_email_template POST /api/v1/email-templates
FastCommentsClient::DefaultApi create_feed_post POST /api/v1/feed-posts
FastCommentsClient::DefaultApi create_moderator POST /api/v1/moderators
FastCommentsClient::DefaultApi create_question_config POST /api/v1/question-configs
FastCommentsClient::DefaultApi create_question_result POST /api/v1/question-results
FastCommentsClient::DefaultApi create_subscription POST /api/v1/subscriptions
FastCommentsClient::DefaultApi create_tenant POST /api/v1/tenants
FastCommentsClient::DefaultApi create_tenant_package POST /api/v1/tenant-packages
FastCommentsClient::DefaultApi create_tenant_user POST /api/v1/tenant-users
FastCommentsClient::DefaultApi create_ticket POST /api/v1/tickets
FastCommentsClient::DefaultApi create_user_badge POST /api/v1/user-badges
FastCommentsClient::DefaultApi create_vote POST /api/v1/votes
FastCommentsClient::DefaultApi delete_comment DELETE /api/v1/comments/{id}
FastCommentsClient::DefaultApi delete_domain_config DELETE /api/v1/domain-configs/{domain}
FastCommentsClient::DefaultApi delete_email_template DELETE /api/v1/email-templates/{id}
FastCommentsClient::DefaultApi delete_email_template_render_error DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
FastCommentsClient::DefaultApi delete_hash_tag DELETE /api/v1/hash-tags/{tag}
FastCommentsClient::DefaultApi delete_moderator DELETE /api/v1/moderators/{id}
FastCommentsClient::DefaultApi delete_notification_count DELETE /api/v1/notification-count/{id}
FastCommentsClient::DefaultApi delete_page DELETE /api/v1/pages/{id}
FastCommentsClient::DefaultApi delete_pending_webhook_event DELETE /api/v1/pending-webhook-events/{id}
FastCommentsClient::DefaultApi delete_question_config DELETE /api/v1/question-configs/{id}
FastCommentsClient::DefaultApi delete_question_result DELETE /api/v1/question-results/{id}
FastCommentsClient::DefaultApi delete_sso_user DELETE /api/v1/sso-users/{id}
FastCommentsClient::DefaultApi delete_subscription DELETE /api/v1/subscriptions/{id}
FastCommentsClient::DefaultApi delete_tenant DELETE /api/v1/tenants/{id}
FastCommentsClient::DefaultApi delete_tenant_package DELETE /api/v1/tenant-packages/{id}
FastCommentsClient::DefaultApi delete_tenant_user DELETE /api/v1/tenant-users/{id}
FastCommentsClient::DefaultApi delete_user_badge DELETE /api/v1/user-badges/{id}
FastCommentsClient::DefaultApi delete_vote DELETE /api/v1/votes/{id}
FastCommentsClient::DefaultApi flag_comment POST /api/v1/comments/{id}/flag
FastCommentsClient::DefaultApi get_audit_logs GET /api/v1/audit-logs
FastCommentsClient::DefaultApi get_cached_notification_count GET /api/v1/notification-count/{id}
FastCommentsClient::DefaultApi get_comment GET /api/v1/comments/{id}
FastCommentsClient::DefaultApi get_comments GET /api/v1/comments
FastCommentsClient::DefaultApi get_domain_config GET /api/v1/domain-configs/{domain}
FastCommentsClient::DefaultApi get_domain_configs GET /api/v1/domain-configs
FastCommentsClient::DefaultApi get_email_template GET /api/v1/email-templates/{id}
FastCommentsClient::DefaultApi get_email_template_definitions GET /api/v1/email-templates/definitions
FastCommentsClient::DefaultApi get_email_template_render_errors GET /api/v1/email-templates/{id}/render-errors
FastCommentsClient::DefaultApi get_email_templates GET /api/v1/email-templates
FastCommentsClient::DefaultApi get_feed_posts GET /api/v1/feed-posts
FastCommentsClient::DefaultApi get_hash_tags GET /api/v1/hash-tags
FastCommentsClient::DefaultApi get_moderator GET /api/v1/moderators/{id}
FastCommentsClient::DefaultApi get_moderators GET /api/v1/moderators
FastCommentsClient::DefaultApi get_notification_count GET /api/v1/notifications/count
FastCommentsClient::DefaultApi get_notifications GET /api/v1/notifications
FastCommentsClient::DefaultApi get_page_by_urlid GET /api/v1/pages/by-url-id
FastCommentsClient::DefaultApi get_pages GET /api/v1/pages
FastCommentsClient::DefaultApi get_pending_webhook_event_count GET /api/v1/pending-webhook-events/count
FastCommentsClient::DefaultApi get_pending_webhook_events GET /api/v1/pending-webhook-events
FastCommentsClient::DefaultApi get_question_config GET /api/v1/question-configs/{id}
FastCommentsClient::DefaultApi get_question_configs GET /api/v1/question-configs
FastCommentsClient::DefaultApi get_question_result GET /api/v1/question-results/{id}
FastCommentsClient::DefaultApi get_question_results GET /api/v1/question-results
FastCommentsClient::DefaultApi get_sso_user_by_email GET /api/v1/sso-users/by-email/{email}
FastCommentsClient::DefaultApi get_sso_user_by_id GET /api/v1/sso-users/by-id/{id}
FastCommentsClient::DefaultApi get_sso_users GET /api/v1/sso-users
FastCommentsClient::DefaultApi get_subscriptions GET /api/v1/subscriptions
FastCommentsClient::DefaultApi get_tenant GET /api/v1/tenants/{id}
FastCommentsClient::DefaultApi get_tenant_daily_usages GET /api/v1/tenant-daily-usage
FastCommentsClient::DefaultApi get_tenant_package GET /api/v1/tenant-packages/{id}
FastCommentsClient::DefaultApi get_tenant_packages GET /api/v1/tenant-packages
FastCommentsClient::DefaultApi get_tenant_user GET /api/v1/tenant-users/{id}
FastCommentsClient::DefaultApi get_tenant_users GET /api/v1/tenant-users
FastCommentsClient::DefaultApi get_tenants GET /api/v1/tenants
FastCommentsClient::DefaultApi get_ticket GET /api/v1/tickets/{id}
FastCommentsClient::DefaultApi get_tickets GET /api/v1/tickets
FastCommentsClient::DefaultApi get_user GET /api/v1/users/{id}
FastCommentsClient::DefaultApi get_user_badge GET /api/v1/user-badges/{id}
FastCommentsClient::DefaultApi get_user_badge_progress_by_id GET /api/v1/user-badge-progress/{id}
FastCommentsClient::DefaultApi get_user_badge_progress_by_user_id GET /api/v1/user-badge-progress/user/{userId}
FastCommentsClient::DefaultApi get_user_badge_progress_list GET /api/v1/user-badge-progress
FastCommentsClient::DefaultApi get_user_badges GET /api/v1/user-badges
FastCommentsClient::DefaultApi get_votes GET /api/v1/votes
FastCommentsClient::DefaultApi get_votes_for_user GET /api/v1/votes/for-user
FastCommentsClient::DefaultApi patch_domain_config PATCH /api/v1/domain-configs/{domainToUpdate}
FastCommentsClient::DefaultApi patch_hash_tag PATCH /api/v1/hash-tags/{tag}
FastCommentsClient::DefaultApi patch_page PATCH /api/v1/pages/{id}
FastCommentsClient::DefaultApi patch_sso_user PATCH /api/v1/sso-users/{id}
FastCommentsClient::DefaultApi put_domain_config PUT /api/v1/domain-configs/{domainToUpdate}
FastCommentsClient::DefaultApi put_sso_user PUT /api/v1/sso-users/{id}
FastCommentsClient::DefaultApi render_email_template POST /api/v1/email-templates/render
FastCommentsClient::DefaultApi replace_tenant_package PUT /api/v1/tenant-packages/{id}
FastCommentsClient::DefaultApi replace_tenant_user PUT /api/v1/tenant-users/{id}
FastCommentsClient::DefaultApi save_comment POST /api/v1/comments
FastCommentsClient::DefaultApi save_comments_bulk POST /api/v1/comments/bulk
FastCommentsClient::DefaultApi send_invite POST /api/v1/moderators/{id}/send-invite
FastCommentsClient::DefaultApi send_login_link POST /api/v1/tenant-users/{id}/send-login-link
FastCommentsClient::DefaultApi un_block_user_from_comment POST /api/v1/comments/{id}/un-block
FastCommentsClient::DefaultApi un_flag_comment POST /api/v1/comments/{id}/un-flag
FastCommentsClient::DefaultApi update_comment PATCH /api/v1/comments/{id}
FastCommentsClient::DefaultApi update_email_template PATCH /api/v1/email-templates/{id}
FastCommentsClient::DefaultApi update_feed_post PATCH /api/v1/feed-posts/{id}
FastCommentsClient::DefaultApi update_moderator PATCH /api/v1/moderators/{id}
FastCommentsClient::DefaultApi update_notification PATCH /api/v1/notifications/{id}
FastCommentsClient::DefaultApi update_question_config PATCH /api/v1/question-configs/{id}
FastCommentsClient::DefaultApi update_question_result PATCH /api/v1/question-results/{id}
FastCommentsClient::DefaultApi update_subscription PATCH /api/v1/subscriptions/{id}
FastCommentsClient::DefaultApi update_tenant PATCH /api/v1/tenants/{id}
FastCommentsClient::DefaultApi update_tenant_package PATCH /api/v1/tenant-packages/{id}
FastCommentsClient::DefaultApi update_tenant_user PATCH /api/v1/tenant-users/{id}
FastCommentsClient::DefaultApi update_user_badge PUT /api/v1/user-badges/{id}
FastCommentsClient::PublicApi block_from_comment_public POST /block-from-comment/{commentId}
FastCommentsClient::PublicApi checked_comments_for_blocked GET /check-blocked-comments
FastCommentsClient::PublicApi create_comment_public POST /comments/{tenantId}
FastCommentsClient::PublicApi create_feed_post_public POST /feed-posts/{tenantId}
FastCommentsClient::PublicApi delete_comment_public DELETE /comments/{tenantId}/{commentId}
FastCommentsClient::PublicApi delete_comment_vote DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
FastCommentsClient::PublicApi delete_feed_post_public DELETE /feed-posts/{tenantId}/{postId}
FastCommentsClient::PublicApi flag_comment_public POST /flag-comment/{commentId}
FastCommentsClient::PublicApi get_comment_text GET /comments/{tenantId}/{commentId}/text
FastCommentsClient::PublicApi get_comment_vote_user_names GET /comments/{tenantId}/{commentId}/votes
FastCommentsClient::PublicApi get_comments_public GET /comments/{tenantId}
FastCommentsClient::PublicApi get_event_log GET /event-log/{tenantId}
FastCommentsClient::PublicApi get_feed_posts_public GET /feed-posts/{tenantId}
FastCommentsClient::PublicApi get_feed_posts_stats GET /feed-posts/{tenantId}/stats
FastCommentsClient::PublicApi get_global_event_log GET /event-log/global/{tenantId}
FastCommentsClient::PublicApi get_user_notification_count GET /user-notifications/get-count
FastCommentsClient::PublicApi get_user_notifications GET /user-notifications
FastCommentsClient::PublicApi get_user_presence_statuses GET /user-presence-status
FastCommentsClient::PublicApi get_user_reacts_public GET /feed-posts/{tenantId}/user-reacts
FastCommentsClient::PublicApi lock_comment POST /comments/{tenantId}/{commentId}/lock
FastCommentsClient::PublicApi pin_comment POST /comments/{tenantId}/{commentId}/pin
FastCommentsClient::PublicApi react_feed_post_public POST /feed-posts/{tenantId}/react/{postId}
FastCommentsClient::PublicApi reset_user_notification_count POST /user-notifications/reset-count
FastCommentsClient::PublicApi reset_user_notifications POST /user-notifications/reset
FastCommentsClient::PublicApi search_users GET /user-search/{tenantId}
FastCommentsClient::PublicApi set_comment_text POST /comments/{tenantId}/{commentId}/update-text
FastCommentsClient::PublicApi un_block_comment_public DELETE /block-from-comment/{commentId}
FastCommentsClient::PublicApi un_lock_comment POST /comments/{tenantId}/{commentId}/unlock
FastCommentsClient::PublicApi un_pin_comment POST /comments/{tenantId}/{commentId}/unpin
FastCommentsClient::PublicApi update_feed_post_public PUT /feed-posts/{tenantId}/{postId}
FastCommentsClient::PublicApi update_user_notification_comment_subscription_status POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}
FastCommentsClient::PublicApi update_user_notification_page_subscription_status POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}
FastCommentsClient::PublicApi update_user_notification_status POST /user-notifications/{notificationId}/mark/{newStatus}
FastCommentsClient::PublicApi upload_image POST /upload-image/{tenantId}
FastCommentsClient::PublicApi vote_comment POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header