Skip to content

README.md

Latest commit

 

History

History
243 lines (230 loc) · 17.6 KB

README.md

File metadata and controls

243 lines (230 loc) · 17.6 KB
Raw

Nim API client for fastcomments (Package: fastcomments)

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

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 0.0.0
  • Package version: 3.0.0
    • Generator version: 7.23.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.NimClientCodegen

Installation

Put the package under your project folder and add the following to the nimble file of your project:

import fastcomments

Documentation for API Endpoints

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

Module Proc HTTP request Description
api_default addDomainConfig POST /api/v1/domain-configs
api_default addHashTag POST /api/v1/hash-tags
api_default addHashTagsBulk POST /api/v1/hash-tags/bulk
api_default addPage POST /api/v1/pages
api_default addSSOUser POST /api/v1/sso-users
api_default aggregate POST /api/v1/aggregate
api_default aggregateQuestionResults GET /api/v1/question-results-aggregation
api_default blockUserFromComment POST /api/v1/comments/{id}/block
api_default bulkAggregateQuestionResults POST /api/v1/question-results-aggregation/bulk
api_default changeTicketState PATCH /api/v1/tickets/{id}/state
api_default combineCommentsWithQuestionResults GET /api/v1/question-results-aggregation/combine/comments
api_default createEmailTemplate POST /api/v1/email-templates
api_default createFeedPost POST /api/v1/feed-posts
api_default createModerator POST /api/v1/moderators
api_default createQuestionConfig POST /api/v1/question-configs
api_default createQuestionResult POST /api/v1/question-results
api_default createSubscription POST /api/v1/subscriptions
api_default createTenant POST /api/v1/tenants
api_default createTenantPackage POST /api/v1/tenant-packages
api_default createTenantUser POST /api/v1/tenant-users
api_default createTicket POST /api/v1/tickets
api_default createUserBadge POST /api/v1/user-badges
api_default createVote POST /api/v1/votes
api_default deleteComment DELETE /api/v1/comments/{id}
api_default deleteDomainConfig DELETE /api/v1/domain-configs/{domain}
api_default deleteEmailTemplate DELETE /api/v1/email-templates/{id}
api_default deleteEmailTemplateRenderError DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
api_default deleteHashTag DELETE /api/v1/hash-tags/{tag}
api_default deleteModerator DELETE /api/v1/moderators/{id}
api_default deleteNotificationCount DELETE /api/v1/notification-count/{id}
api_default deletePage DELETE /api/v1/pages/{id}
api_default deletePendingWebhookEvent DELETE /api/v1/pending-webhook-events/{id}
api_default deleteQuestionConfig DELETE /api/v1/question-configs/{id}
api_default deleteQuestionResult DELETE /api/v1/question-results/{id}
api_default deleteSSOUser DELETE /api/v1/sso-users/{id}
api_default deleteSubscription DELETE /api/v1/subscriptions/{id}
api_default deleteTenant DELETE /api/v1/tenants/{id}
api_default deleteTenantPackage DELETE /api/v1/tenant-packages/{id}
api_default deleteTenantUser DELETE /api/v1/tenant-users/{id}
api_default deleteUserBadge DELETE /api/v1/user-badges/{id}
api_default deleteVote DELETE /api/v1/votes/{id}
api_default flagComment POST /api/v1/comments/{id}/flag
api_default getAuditLogs GET /api/v1/audit-logs
api_default getCachedNotificationCount GET /api/v1/notification-count/{id}
api_default getComment GET /api/v1/comments/{id}
api_default getComments GET /api/v1/comments
api_default getDomainConfig GET /api/v1/domain-configs/{domain}
api_default getDomainConfigs GET /api/v1/domain-configs
api_default getEmailTemplate GET /api/v1/email-templates/{id}
api_default getEmailTemplateDefinitions GET /api/v1/email-templates/definitions
api_default getEmailTemplateRenderErrors GET /api/v1/email-templates/{id}/render-errors
api_default getEmailTemplates GET /api/v1/email-templates
api_default getFeedPosts GET /api/v1/feed-posts
api_default getHashTags GET /api/v1/hash-tags
api_default getModerator GET /api/v1/moderators/{id}
api_default getModerators GET /api/v1/moderators
api_default getNotificationCount GET /api/v1/notifications/count
api_default getNotifications GET /api/v1/notifications
api_default getPageByURLId GET /api/v1/pages/by-url-id
api_default getPages GET /api/v1/pages
api_default getPendingWebhookEventCount GET /api/v1/pending-webhook-events/count
api_default getPendingWebhookEvents GET /api/v1/pending-webhook-events
api_default getQuestionConfig GET /api/v1/question-configs/{id}
api_default getQuestionConfigs GET /api/v1/question-configs
api_default getQuestionResult GET /api/v1/question-results/{id}
api_default getQuestionResults GET /api/v1/question-results
api_default getSSOUserByEmail GET /api/v1/sso-users/by-email/{email}
api_default getSSOUserById GET /api/v1/sso-users/by-id/{id}
api_default getSSOUsers GET /api/v1/sso-users
api_default getSubscriptions GET /api/v1/subscriptions
api_default getTenant GET /api/v1/tenants/{id}
api_default getTenantDailyUsages GET /api/v1/tenant-daily-usage
api_default getTenantPackage GET /api/v1/tenant-packages/{id}
api_default getTenantPackages GET /api/v1/tenant-packages
api_default getTenantUser GET /api/v1/tenant-users/{id}
api_default getTenantUsers GET /api/v1/tenant-users
api_default getTenants GET /api/v1/tenants
api_default getTicket GET /api/v1/tickets/{id}
api_default getTickets GET /api/v1/tickets
api_default getUser GET /api/v1/users/{id}
api_default getUserBadge GET /api/v1/user-badges/{id}
api_default getUserBadgeProgressById GET /api/v1/user-badge-progress/{id}
api_default getUserBadgeProgressByUserId GET /api/v1/user-badge-progress/user/{userId}
api_default getUserBadgeProgressList GET /api/v1/user-badge-progress
api_default getUserBadges GET /api/v1/user-badges
api_default getVotes GET /api/v1/votes
api_default getVotesForUser GET /api/v1/votes/for-user
api_default patchDomainConfig PATCH /api/v1/domain-configs/{domainToUpdate}
api_default patchHashTag PATCH /api/v1/hash-tags/{tag}
api_default patchPage PATCH /api/v1/pages/{id}
api_default patchSSOUser PATCH /api/v1/sso-users/{id}
api_default putDomainConfig PUT /api/v1/domain-configs/{domainToUpdate}
api_default putSSOUser PUT /api/v1/sso-users/{id}
api_default renderEmailTemplate POST /api/v1/email-templates/render
api_default replaceTenantPackage PUT /api/v1/tenant-packages/{id}
api_default replaceTenantUser PUT /api/v1/tenant-users/{id}
api_default saveComment POST /api/v1/comments
api_default saveCommentsBulk POST /api/v1/comments/bulk
api_default sendInvite POST /api/v1/moderators/{id}/send-invite
api_default sendLoginLink POST /api/v1/tenant-users/{id}/send-login-link
api_default unBlockUserFromComment POST /api/v1/comments/{id}/un-block
api_default unFlagComment POST /api/v1/comments/{id}/un-flag
api_default updateComment PATCH /api/v1/comments/{id}
api_default updateEmailTemplate PATCH /api/v1/email-templates/{id}
api_default updateFeedPost PATCH /api/v1/feed-posts/{id}
api_default updateModerator PATCH /api/v1/moderators/{id}
api_default updateNotification PATCH /api/v1/notifications/{id}
api_default updateQuestionConfig PATCH /api/v1/question-configs/{id}
api_default updateQuestionResult PATCH /api/v1/question-results/{id}
api_default updateSubscription PATCH /api/v1/subscriptions/{id}
api_default updateTenant PATCH /api/v1/tenants/{id}
api_default updateTenantPackage PATCH /api/v1/tenant-packages/{id}
api_default updateTenantUser PATCH /api/v1/tenant-users/{id}
api_default updateUserBadge PUT /api/v1/user-badges/{id}
api_moderation deleteModerationVote DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
api_moderation getApiComments GET /auth/my-account/moderate-comments/mod_api/api/comments
api_moderation getApiExportStatus GET /auth/my-account/moderate-comments/mod_api/api/export/status
api_moderation getApiIds GET /auth/my-account/moderate-comments/mod_api/api/ids
api_moderation getBanUsersFromComment GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
api_moderation getCommentBanStatus GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
api_moderation getCommentChildren GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
api_moderation getCount GET /auth/my-account/moderate-comments/mod_api/count
api_moderation getCounts GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
api_moderation getLogs GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
api_moderation getManualBadges GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
api_moderation getManualBadgesForUser GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
api_moderation getModerationComment GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
api_moderation getModerationCommentText GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
api_moderation getPreBanSummary GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
api_moderation getSearchCommentsSummary GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
api_moderation getSearchPages GET /auth/my-account/moderate-comments/mod_api/search/pages
api_moderation getSearchSites GET /auth/my-account/moderate-comments/mod_api/search/sites
api_moderation getSearchSuggest GET /auth/my-account/moderate-comments/mod_api/search/suggest
api_moderation getSearchUsers GET /auth/my-account/moderate-comments/mod_api/search/users
api_moderation getTrustFactor GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
api_moderation getUserBanPreference GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
api_moderation getUserInternalProfile GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
api_moderation postAdjustCommentVotes POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
api_moderation postApiExport POST /auth/my-account/moderate-comments/mod_api/api/export
api_moderation postBanUserFromComment POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
api_moderation postBanUserUndo POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
api_moderation postBulkPreBanSummary POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
api_moderation postCommentsByIds POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
api_moderation postFlagComment POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
api_moderation postRemoveComment POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
api_moderation postRestoreDeletedComment POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
api_moderation postSetCommentApprovalStatus POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
api_moderation postSetCommentReviewStatus POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
api_moderation postSetCommentSpamStatus POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
api_moderation postSetCommentText POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
api_moderation postUnFlagComment POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
api_moderation postVote POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
api_moderation putAwardBadge PUT /auth/my-account/moderate-comments/mod_api/award-badge
api_moderation putCloseThread PUT /auth/my-account/moderate-comments/mod_api/close-thread
api_moderation putRemoveBadge PUT /auth/my-account/moderate-comments/mod_api/remove-badge
api_moderation putReopenThread PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
api_moderation setTrustFactor PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
api_public blockFromCommentPublic POST /block-from-comment/{commentId}
api_public checkedCommentsForBlocked GET /check-blocked-comments
api_public createCommentPublic POST /comments/{tenantId}
api_public createFeedPostPublic POST /feed-posts/{tenantId}
api_public createV1PageReact POST /page-reacts/v1/likes/{tenantId}
api_public createV2PageReact POST /page-reacts/v2/{tenantId}
api_public deleteCommentPublic DELETE /comments/{tenantId}/{commentId}
api_public deleteCommentVote DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
api_public deleteFeedPostPublic DELETE /feed-posts/{tenantId}/{postId}
api_public deleteV1PageReact DELETE /page-reacts/v1/likes/{tenantId}
api_public deleteV2PageReact DELETE /page-reacts/v2/{tenantId}
api_public flagCommentPublic POST /flag-comment/{commentId}
api_public getCommentText GET /comments/{tenantId}/{commentId}/text
api_public getCommentVoteUserNames GET /comments/{tenantId}/{commentId}/votes
api_public getCommentsForUser GET /comments-for-user
api_public getCommentsPublic GET /comments/{tenantId}
api_public getEventLog GET /event-log/{tenantId}
api_public getFeedPostsPublic GET /feed-posts/{tenantId}
api_public getFeedPostsStats GET /feed-posts/{tenantId}/stats
api_public getGifLarge GET /gifs/get-large/{tenantId}
api_public getGifsSearch GET /gifs/search/{tenantId}
api_public getGifsTrending GET /gifs/trending/{tenantId}
api_public getGlobalEventLog GET /event-log/global/{tenantId}
api_public getOfflineUsers GET /pages/{tenantId}/users/offline
api_public getOnlineUsers GET /pages/{tenantId}/users/online
api_public getPagesPublic GET /pages/{tenantId}
api_public getTranslations GET /translations/{namespace}/{component}
api_public getUserNotificationCount GET /user-notifications/get-count
api_public getUserNotifications GET /user-notifications
api_public getUserPresenceStatuses GET /user-presence-status
api_public getUserReactsPublic GET /feed-posts/{tenantId}/user-reacts
api_public getUsersInfo GET /pages/{tenantId}/users/info
api_public getV1PageLikes GET /page-reacts/v1/likes/{tenantId}
api_public getV2PageReactUsers GET /page-reacts/v2/{tenantId}/list
api_public getV2PageReacts GET /page-reacts/v2/{tenantId}
api_public lockComment POST /comments/{tenantId}/{commentId}/lock
api_public logoutPublic PUT /auth/logout
api_public pinComment POST /comments/{tenantId}/{commentId}/pin
api_public reactFeedPostPublic POST /feed-posts/{tenantId}/react/{postId}
api_public resetUserNotificationCount POST /user-notifications/reset-count
api_public resetUserNotifications POST /user-notifications/reset
api_public searchUsers GET /user-search/{tenantId}
api_public setCommentText POST /comments/{tenantId}/{commentId}/update-text
api_public unBlockCommentPublic DELETE /block-from-comment/{commentId}
api_public unLockComment POST /comments/{tenantId}/{commentId}/unlock
api_public unPinComment POST /comments/{tenantId}/{commentId}/unpin
api_public updateFeedPostPublic PUT /feed-posts/{tenantId}/{postId}
api_public updateUserNotificationCommentSubscriptionStatus POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}
api_public updateUserNotificationPageSubscriptionStatus POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}
api_public updateUserNotificationStatus POST /user-notifications/{notificationId}/mark/{newStatus}
api_public uploadImage POST /upload-image/{tenantId}
api_public voteComment POST /comments/{tenantId}/{commentId}/vote

To generate documentation with Nim DocGen, use:

nim doc --project --index:on fastcomments.nim