Skip to content

README.md

Latest commit

 

History

History
659 lines (609 loc) · 42.5 KB

README.md

File metadata and controls

659 lines (609 loc) · 42.5 KB

client

fastcomments

  • API version: 0.0.0
    • Generator version: 7.19.0-SNAPSHOT

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

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.fastcomments</groupId>
  <artifactId>client</artifactId>
  <version>1.3.5</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.fastcomments:client:1.3.5"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/client-1.3.5.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.fastcomments.invoker.ApiClient;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.invoker.Configuration;
import com.fastcomments.invoker.auth.*;
import com.fastcomments.model.*;
import com.fastcomments.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://fastcomments.com");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    String tenantId = "tenantId_example"; // String | 
    AddDomainConfigParams addDomainConfigParams = new AddDomainConfigParams(); // AddDomainConfigParams | 
    try {
      AddDomainConfig200Response result = apiInstance.addDomainConfig(tenantId, addDomainConfigParams)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#addDomainConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
DefaultApi addDomainConfig POST /api/v1/domain-configs
DefaultApi addHashTag POST /api/v1/hash-tags
DefaultApi addHashTagsBulk POST /api/v1/hash-tags/bulk
DefaultApi addPage POST /api/v1/pages
DefaultApi addSSOUser POST /api/v1/sso-users
DefaultApi aggregate POST /api/v1/aggregate
DefaultApi aggregateQuestionResults GET /api/v1/question-results-aggregation
DefaultApi blockUserFromComment POST /api/v1/comments/{id}/block
DefaultApi bulkAggregateQuestionResults POST /api/v1/question-results-aggregation/bulk
DefaultApi changeTicketState PATCH /api/v1/tickets/{id}/state
DefaultApi combineCommentsWithQuestionResults GET /api/v1/question-results-aggregation/combine/comments
DefaultApi createEmailTemplate POST /api/v1/email-templates
DefaultApi createFeedPost POST /api/v1/feed-posts
DefaultApi createModerator POST /api/v1/moderators
DefaultApi createQuestionConfig POST /api/v1/question-configs
DefaultApi createQuestionResult POST /api/v1/question-results
DefaultApi createSubscription POST /api/v1/subscriptions
DefaultApi createTenant POST /api/v1/tenants
DefaultApi createTenantPackage POST /api/v1/tenant-packages
DefaultApi createTenantUser POST /api/v1/tenant-users
DefaultApi createTicket POST /api/v1/tickets
DefaultApi createUserBadge POST /api/v1/user-badges
DefaultApi createVote POST /api/v1/votes
DefaultApi deleteComment DELETE /api/v1/comments/{id}
DefaultApi deleteDomainConfig DELETE /api/v1/domain-configs/{domain}
DefaultApi deleteEmailTemplate DELETE /api/v1/email-templates/{id}
DefaultApi deleteEmailTemplateRenderError DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi deleteHashTag DELETE /api/v1/hash-tags/{tag}
DefaultApi deleteModerator DELETE /api/v1/moderators/{id}
DefaultApi deleteNotificationCount DELETE /api/v1/notification-count/{id}
DefaultApi deletePage DELETE /api/v1/pages/{id}
DefaultApi deletePendingWebhookEvent DELETE /api/v1/pending-webhook-events/{id}
DefaultApi deleteQuestionConfig DELETE /api/v1/question-configs/{id}
DefaultApi deleteQuestionResult DELETE /api/v1/question-results/{id}
DefaultApi deleteSSOUser DELETE /api/v1/sso-users/{id}
DefaultApi deleteSubscription DELETE /api/v1/subscriptions/{id}
DefaultApi deleteTenant DELETE /api/v1/tenants/{id}
DefaultApi deleteTenantPackage DELETE /api/v1/tenant-packages/{id}
DefaultApi deleteTenantUser DELETE /api/v1/tenant-users/{id}
DefaultApi deleteUserBadge DELETE /api/v1/user-badges/{id}
DefaultApi deleteVote DELETE /api/v1/votes/{id}
DefaultApi flagComment POST /api/v1/comments/{id}/flag
DefaultApi getAuditLogs GET /api/v1/audit-logs
DefaultApi getCachedNotificationCount GET /api/v1/notification-count/{id}
DefaultApi getComment GET /api/v1/comments/{id}
DefaultApi getComments GET /api/v1/comments
DefaultApi getDomainConfig GET /api/v1/domain-configs/{domain}
DefaultApi getDomainConfigs GET /api/v1/domain-configs
DefaultApi getEmailTemplate GET /api/v1/email-templates/{id}
DefaultApi getEmailTemplateDefinitions GET /api/v1/email-templates/definitions
DefaultApi getEmailTemplateRenderErrors GET /api/v1/email-templates/{id}/render-errors
DefaultApi getEmailTemplates GET /api/v1/email-templates
DefaultApi getFeedPosts GET /api/v1/feed-posts
DefaultApi getHashTags GET /api/v1/hash-tags
DefaultApi getModerator GET /api/v1/moderators/{id}
DefaultApi getModerators GET /api/v1/moderators
DefaultApi getNotificationCount GET /api/v1/notifications/count
DefaultApi getNotifications GET /api/v1/notifications
DefaultApi getPageByURLId GET /api/v1/pages/by-url-id
DefaultApi getPages GET /api/v1/pages
DefaultApi getPendingWebhookEventCount GET /api/v1/pending-webhook-events/count
DefaultApi getPendingWebhookEvents GET /api/v1/pending-webhook-events
DefaultApi getQuestionConfig GET /api/v1/question-configs/{id}
DefaultApi getQuestionConfigs GET /api/v1/question-configs
DefaultApi getQuestionResult GET /api/v1/question-results/{id}
DefaultApi getQuestionResults GET /api/v1/question-results
DefaultApi getSSOUserByEmail GET /api/v1/sso-users/by-email/{email}
DefaultApi getSSOUserById GET /api/v1/sso-users/by-id/{id}
DefaultApi getSSOUsers GET /api/v1/sso-users
DefaultApi getSubscriptions GET /api/v1/subscriptions
DefaultApi getTenant GET /api/v1/tenants/{id}
DefaultApi getTenantDailyUsages GET /api/v1/tenant-daily-usage
DefaultApi getTenantPackage GET /api/v1/tenant-packages/{id}
DefaultApi getTenantPackages GET /api/v1/tenant-packages
DefaultApi getTenantUser GET /api/v1/tenant-users/{id}
DefaultApi getTenantUsers GET /api/v1/tenant-users
DefaultApi getTenants GET /api/v1/tenants
DefaultApi getTicket GET /api/v1/tickets/{id}
DefaultApi getTickets GET /api/v1/tickets
DefaultApi getUser GET /api/v1/users/{id}
DefaultApi getUserBadge GET /api/v1/user-badges/{id}
DefaultApi getUserBadgeProgressById GET /api/v1/user-badge-progress/{id}
DefaultApi getUserBadgeProgressByUserId GET /api/v1/user-badge-progress/user/{userId}
DefaultApi getUserBadgeProgressList GET /api/v1/user-badge-progress
DefaultApi getUserBadges GET /api/v1/user-badges
DefaultApi getVotes GET /api/v1/votes
DefaultApi getVotesForUser GET /api/v1/votes/for-user
DefaultApi patchDomainConfig PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi patchHashTag PATCH /api/v1/hash-tags/{tag}
DefaultApi patchPage PATCH /api/v1/pages/{id}
DefaultApi patchSSOUser PATCH /api/v1/sso-users/{id}
DefaultApi putDomainConfig PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi putSSOUser PUT /api/v1/sso-users/{id}
DefaultApi renderEmailTemplate POST /api/v1/email-templates/render
DefaultApi replaceTenantPackage PUT /api/v1/tenant-packages/{id}
DefaultApi replaceTenantUser PUT /api/v1/tenant-users/{id}
DefaultApi saveComment POST /api/v1/comments
DefaultApi saveCommentsBulk POST /api/v1/comments/bulk
DefaultApi sendInvite POST /api/v1/moderators/{id}/send-invite
DefaultApi sendLoginLink POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi unBlockUserFromComment POST /api/v1/comments/{id}/un-block
DefaultApi unFlagComment POST /api/v1/comments/{id}/un-flag
DefaultApi updateComment PATCH /api/v1/comments/{id}
DefaultApi updateEmailTemplate PATCH /api/v1/email-templates/{id}
DefaultApi updateFeedPost PATCH /api/v1/feed-posts/{id}
DefaultApi updateModerator PATCH /api/v1/moderators/{id}
DefaultApi updateNotification PATCH /api/v1/notifications/{id}
DefaultApi updateQuestionConfig PATCH /api/v1/question-configs/{id}
DefaultApi updateQuestionResult PATCH /api/v1/question-results/{id}
DefaultApi updateSubscription PATCH /api/v1/subscriptions/{id}
DefaultApi updateTenant PATCH /api/v1/tenants/{id}
DefaultApi updateTenantPackage PATCH /api/v1/tenant-packages/{id}
DefaultApi updateTenantUser PATCH /api/v1/tenant-users/{id}
DefaultApi updateUserBadge PUT /api/v1/user-badges/{id}
PublicApi blockFromCommentPublic POST /block-from-comment/{commentId}
PublicApi checkedCommentsForBlocked GET /check-blocked-comments
PublicApi createCommentPublic POST /comments/{tenantId}
PublicApi createFeedPostPublic POST /feed-posts/{tenantId}
PublicApi deleteCommentPublic DELETE /comments/{tenantId}/{commentId}
PublicApi deleteCommentVote DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi deleteFeedPostPublic DELETE /feed-posts/{tenantId}/{postId}
PublicApi flagCommentPublic POST /flag-comment/{commentId}
PublicApi getCommentText GET /comments/{tenantId}/{commentId}/text
PublicApi getCommentVoteUserNames GET /comments/{tenantId}/{commentId}/votes
PublicApi getCommentsPublic GET /comments/{tenantId}
PublicApi getEventLog GET /event-log/{tenantId}
PublicApi getFeedPostsPublic GET /feed-posts/{tenantId}
PublicApi getFeedPostsStats GET /feed-posts/{tenantId}/stats
PublicApi getGlobalEventLog GET /event-log/global/{tenantId}
PublicApi getUserNotificationCount GET /user-notifications/get-count
PublicApi getUserNotifications GET /user-notifications
PublicApi getUserPresenceStatuses GET /user-presence-status
PublicApi getUserReactsPublic GET /feed-posts/{tenantId}/user-reacts
PublicApi lockComment POST /comments/{tenantId}/{commentId}/lock
PublicApi pinComment POST /comments/{tenantId}/{commentId}/pin
PublicApi reactFeedPostPublic POST /feed-posts/{tenantId}/react/{postId}
PublicApi resetUserNotificationCount POST /user-notifications/reset-count
PublicApi resetUserNotifications POST /user-notifications/reset
PublicApi searchUsers GET /user-search/{tenantId}
PublicApi setCommentText POST /comments/{tenantId}/{commentId}/update-text
PublicApi unBlockCommentPublic DELETE /block-from-comment/{commentId}
PublicApi unLockComment POST /comments/{tenantId}/{commentId}/unlock
PublicApi unPinComment POST /comments/{tenantId}/{commentId}/unpin
PublicApi updateFeedPostPublic PUT /feed-posts/{tenantId}/{postId}
PublicApi updateUserNotificationCommentSubscriptionStatus POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}
PublicApi updateUserNotificationPageSubscriptionStatus POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}
PublicApi updateUserNotificationStatus POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi uploadImage POST /upload-image/{tenantId}
PublicApi voteComment 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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@fastcomments.com