fastcomments 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (693) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +210 -0
  4. data/client/Gemfile +9 -0
  5. data/client/README.md +407 -0
  6. data/client/Rakefile +10 -0
  7. data/client/docs/APIAuditLog.md +40 -0
  8. data/client/docs/APIComment.md +122 -0
  9. data/client/docs/APICommentBase.md +122 -0
  10. data/client/docs/APICreateUserBadgeResponse.md +20 -0
  11. data/client/docs/APIEmptyResponse.md +18 -0
  12. data/client/docs/APIEmptySuccessResponse.md +18 -0
  13. data/client/docs/APIError.md +32 -0
  14. data/client/docs/APIGetCommentResponse.md +20 -0
  15. data/client/docs/APIGetCommentsResponse.md +20 -0
  16. data/client/docs/APIGetUserBadgeProgressListResponse.md +20 -0
  17. data/client/docs/APIGetUserBadgeProgressResponse.md +20 -0
  18. data/client/docs/APIGetUserBadgeResponse.md +20 -0
  19. data/client/docs/APIGetUserBadgesResponse.md +20 -0
  20. data/client/docs/APIPage.md +34 -0
  21. data/client/docs/APISSOUser.md +56 -0
  22. data/client/docs/APIStatus.md +15 -0
  23. data/client/docs/APIUserSubscription.md +30 -0
  24. data/client/docs/AddDomainConfig200Response.md +24 -0
  25. data/client/docs/AddDomainConfig200ResponseAnyOf.md +20 -0
  26. data/client/docs/AddDomainConfigParams.md +30 -0
  27. data/client/docs/AddPageAPIResponse.md +24 -0
  28. data/client/docs/AddSSOUserAPIResponse.md +24 -0
  29. data/client/docs/AggregateQuestionResults200Response.md +34 -0
  30. data/client/docs/AggregateQuestionResultsResponse.md +20 -0
  31. data/client/docs/AggregateTimeBucket.md +15 -0
  32. data/client/docs/AggregationItem.md +18 -0
  33. data/client/docs/AggregationOpType.md +15 -0
  34. data/client/docs/AggregationOperation.md +24 -0
  35. data/client/docs/AggregationRequest.md +26 -0
  36. data/client/docs/AggregationRequestSort.md +20 -0
  37. data/client/docs/AggregationResponse.md +22 -0
  38. data/client/docs/AggregationResponseStats.md +20 -0
  39. data/client/docs/AggregationValue.md +26 -0
  40. data/client/docs/BlockFromCommentParams.md +18 -0
  41. data/client/docs/BlockFromCommentPublic200Response.md +34 -0
  42. data/client/docs/BlockSuccess.md +20 -0
  43. data/client/docs/BulkAggregateQuestionItem.md +28 -0
  44. data/client/docs/BulkAggregateQuestionResults200Response.md +34 -0
  45. data/client/docs/BulkAggregateQuestionResultsRequest.md +18 -0
  46. data/client/docs/BulkAggregateQuestionResultsResponse.md +20 -0
  47. data/client/docs/ChangeCommentPinStatusResponse.md +20 -0
  48. data/client/docs/CheckBlockedCommentsResponse.md +20 -0
  49. data/client/docs/CheckedCommentsForBlocked200Response.md +34 -0
  50. data/client/docs/CombineCommentsWithQuestionResults200Response.md +34 -0
  51. data/client/docs/CombineQuestionResultsWithCommentsResponse.md +20 -0
  52. data/client/docs/CommentData.md +64 -0
  53. data/client/docs/CommentHTMLRenderingMode.md +15 -0
  54. data/client/docs/CommentLogData.md +102 -0
  55. data/client/docs/CommentLogEntry.md +22 -0
  56. data/client/docs/CommentLogType.md +15 -0
  57. data/client/docs/CommentQuestionResultsRenderingType.md +15 -0
  58. data/client/docs/CommentQuestionsRequired.md +15 -0
  59. data/client/docs/CommentTextUpdateRequest.md +22 -0
  60. data/client/docs/CommentThreadDeletionMode.md +15 -0
  61. data/client/docs/CommentUserBadgeInfo.md +34 -0
  62. data/client/docs/CommentUserHashTagInfo.md +24 -0
  63. data/client/docs/CommentUserMentionInfo.md +26 -0
  64. data/client/docs/CommenterNameFormats.md +15 -0
  65. data/client/docs/CreateAPIPageData.md +28 -0
  66. data/client/docs/CreateAPISSOUserData.md +56 -0
  67. data/client/docs/CreateAPIUserSubscriptionData.md +26 -0
  68. data/client/docs/CreateCommentParams.md +84 -0
  69. data/client/docs/CreateCommentPublic200Response.md +40 -0
  70. data/client/docs/CreateFeedPost200Response.md +34 -0
  71. data/client/docs/CreateFeedPostParams.md +32 -0
  72. data/client/docs/CreateFeedPostPublic200Response.md +34 -0
  73. data/client/docs/CreateFeedPostResponse.md +20 -0
  74. data/client/docs/CreateFeedPostsResponse.md +20 -0
  75. data/client/docs/CreateSubscriptionAPIResponse.md +24 -0
  76. data/client/docs/CreateUserBadge200Response.md +34 -0
  77. data/client/docs/CreateUserBadgeParams.md +22 -0
  78. data/client/docs/CustomConfigParameters.md +160 -0
  79. data/client/docs/DefaultApi.md +3601 -0
  80. data/client/docs/DeleteComment200Response.md +34 -0
  81. data/client/docs/DeleteCommentAction.md +15 -0
  82. data/client/docs/DeleteCommentPublic200Response.md +36 -0
  83. data/client/docs/DeleteCommentResult.md +20 -0
  84. data/client/docs/DeleteCommentVote200Response.md +34 -0
  85. data/client/docs/DeleteDomainConfig200Response.md +18 -0
  86. data/client/docs/DeleteFeedPostPublic200Response.md +32 -0
  87. data/client/docs/DeleteFeedPostPublic200ResponseAnyOf.md +18 -0
  88. data/client/docs/DeletePageAPIResponse.md +22 -0
  89. data/client/docs/DeleteSSOUserAPIResponse.md +24 -0
  90. data/client/docs/DeleteSubscriptionAPIResponse.md +22 -0
  91. data/client/docs/DeletedCommentResultComment.md +24 -0
  92. data/client/docs/EventLogEntry.md +28 -0
  93. data/client/docs/FComment.md +158 -0
  94. data/client/docs/FCommentMeta.md +20 -0
  95. data/client/docs/FeedPost.md +48 -0
  96. data/client/docs/FeedPostLink.md +24 -0
  97. data/client/docs/FeedPostMediaItem.md +22 -0
  98. data/client/docs/FeedPostMediaItemAsset.md +22 -0
  99. data/client/docs/FeedPostStats.md +20 -0
  100. data/client/docs/FeedPostsStatsResponse.md +20 -0
  101. data/client/docs/FindCommentsByRangeItem.md +20 -0
  102. data/client/docs/FindCommentsByRangeResponse.md +20 -0
  103. data/client/docs/FlagComment200Response.md +36 -0
  104. data/client/docs/FlagCommentPublic200Response.md +32 -0
  105. data/client/docs/FlagCommentResponse.md +26 -0
  106. data/client/docs/GetAuditLogs200Response.md +34 -0
  107. data/client/docs/GetAuditLogsResponse.md +20 -0
  108. data/client/docs/GetComment200Response.md +34 -0
  109. data/client/docs/GetCommentText200Response.md +36 -0
  110. data/client/docs/GetCommentVoteUserNames200Response.md +36 -0
  111. data/client/docs/GetCommentVoteUserNamesSuccessResponse.md +22 -0
  112. data/client/docs/GetComments200Response.md +34 -0
  113. data/client/docs/GetCommentsPublic200Response.md +78 -0
  114. data/client/docs/GetCommentsResponsePublicComment.md +64 -0
  115. data/client/docs/GetCommentsResponseWithPresencePublicComment.md +70 -0
  116. data/client/docs/GetDomainConfig200Response.md +24 -0
  117. data/client/docs/GetDomainConfigs200Response.md +24 -0
  118. data/client/docs/GetDomainConfigs200ResponseAnyOf.md +20 -0
  119. data/client/docs/GetDomainConfigs200ResponseAnyOf1.md +22 -0
  120. data/client/docs/GetEventLog200Response.md +34 -0
  121. data/client/docs/GetEventLogResponse.md +20 -0
  122. data/client/docs/GetFeedPosts200Response.md +34 -0
  123. data/client/docs/GetFeedPostsPublic200Response.md +44 -0
  124. data/client/docs/GetFeedPostsResponse.md +20 -0
  125. data/client/docs/GetFeedPostsStats200Response.md +34 -0
  126. data/client/docs/GetMyNotificationsResponse.md +26 -0
  127. data/client/docs/GetPageByURLIdAPIResponse.md +24 -0
  128. data/client/docs/GetPagesAPIResponse.md +24 -0
  129. data/client/docs/GetPublicFeedPostsResponse.md +22 -0
  130. data/client/docs/GetSSOUserByEmailAPIResponse.md +24 -0
  131. data/client/docs/GetSSOUserByIdAPIResponse.md +24 -0
  132. data/client/docs/GetSSOUsers200Response.md +20 -0
  133. data/client/docs/GetSubscriptionsAPIResponse.md +24 -0
  134. data/client/docs/GetUserBadge200Response.md +34 -0
  135. data/client/docs/GetUserBadgeProgressById200Response.md +34 -0
  136. data/client/docs/GetUserBadgeProgressList200Response.md +34 -0
  137. data/client/docs/GetUserBadges200Response.md +34 -0
  138. data/client/docs/GetUserNotificationCount200Response.md +34 -0
  139. data/client/docs/GetUserNotificationCountResponse.md +20 -0
  140. data/client/docs/GetUserNotifications200Response.md +40 -0
  141. data/client/docs/GetUserPresenceStatuses200Response.md +34 -0
  142. data/client/docs/GetUserPresenceStatusesResponse.md +20 -0
  143. data/client/docs/GetUserReactsPublic200Response.md +34 -0
  144. data/client/docs/GifRating.md +15 -0
  145. data/client/docs/HeaderState.md +26 -0
  146. data/client/docs/IgnoredResponse.md +20 -0
  147. data/client/docs/ImageContentProfanityLevel.md +15 -0
  148. data/client/docs/LiveEvent.md +48 -0
  149. data/client/docs/LiveEventExtraInfo.md +18 -0
  150. data/client/docs/LiveEventType.md +15 -0
  151. data/client/docs/LockComment200Response.md +32 -0
  152. data/client/docs/MediaAsset.md +22 -0
  153. data/client/docs/MetaItem.md +20 -0
  154. data/client/docs/NotificationAndCount.md +20 -0
  155. data/client/docs/NotificationObjectType.md +15 -0
  156. data/client/docs/NotificationType.md +15 -0
  157. data/client/docs/PatchDomainConfigParams.md +30 -0
  158. data/client/docs/PatchPageAPIResponse.md +24 -0
  159. data/client/docs/PatchSSOUserAPIResponse.md +24 -0
  160. data/client/docs/PinComment200Response.md +34 -0
  161. data/client/docs/PubSubComment.md +102 -0
  162. data/client/docs/PubSubCommentBase.md +96 -0
  163. data/client/docs/PubSubVote.md +34 -0
  164. data/client/docs/PublicAPIDeleteCommentResponse.md +22 -0
  165. data/client/docs/PublicAPIGetCommentTextResponse.md +22 -0
  166. data/client/docs/PublicAPISetCommentTextResponse.md +20 -0
  167. data/client/docs/PublicApi.md +2596 -0
  168. data/client/docs/PublicBlockFromCommentParams.md +18 -0
  169. data/client/docs/PublicComment.md +92 -0
  170. data/client/docs/PublicCommentBase.md +72 -0
  171. data/client/docs/PublicFeedPostsResponse.md +30 -0
  172. data/client/docs/PutSSOUserAPIResponse.md +24 -0
  173. data/client/docs/QueryPredicate.md +22 -0
  174. data/client/docs/QueryPredicateValue.md +15 -0
  175. data/client/docs/QuestionDatum.md +20 -0
  176. data/client/docs/QuestionRenderingType.md +15 -0
  177. data/client/docs/QuestionResult.md +38 -0
  178. data/client/docs/QuestionResultAggregationOverall.md +28 -0
  179. data/client/docs/QuestionSubQuestionVisibility.md +15 -0
  180. data/client/docs/QuestionWhenSave.md +15 -0
  181. data/client/docs/ReactBodyParams.md +18 -0
  182. data/client/docs/ReactFeedPostPublic200Response.md +36 -0
  183. data/client/docs/ReactFeedPostResponse.md +22 -0
  184. data/client/docs/RecordStringBeforeStringOrNullAfterStringOrNullValue.md +20 -0
  185. data/client/docs/RecordStringStringOrNumberValue.md +15 -0
  186. data/client/docs/RenderableUserNotification.md +58 -0
  187. data/client/docs/RepeatCommentCheckIgnoredReason.md +15 -0
  188. data/client/docs/RepeatCommentHandlingAction.md +15 -0
  189. data/client/docs/ResetUserNotifications200Response.md +32 -0
  190. data/client/docs/ResetUserNotificationsResponse.md +20 -0
  191. data/client/docs/SORTDIR.md +15 -0
  192. data/client/docs/SSOSecurityLevel.md +15 -0
  193. data/client/docs/SaveComment200Response.md +38 -0
  194. data/client/docs/SaveCommentResponse.md +24 -0
  195. data/client/docs/SaveCommentResponseOptimized.md +24 -0
  196. data/client/docs/SaveCommentsResponseWithPresence.md +26 -0
  197. data/client/docs/SearchUsers200Response.md +34 -0
  198. data/client/docs/SearchUsersResponse.md +20 -0
  199. data/client/docs/SetCommentText200Response.md +34 -0
  200. data/client/docs/SetCommentTextResult.md +20 -0
  201. data/client/docs/SizePreset.md +15 -0
  202. data/client/docs/SortDirections.md +15 -0
  203. data/client/docs/SpamRule.md +20 -0
  204. data/client/docs/UnBlockCommentPublic200Response.md +34 -0
  205. data/client/docs/UnBlockFromCommentParams.md +18 -0
  206. data/client/docs/UnblockSuccess.md +20 -0
  207. data/client/docs/UpdatableCommentParams.md +94 -0
  208. data/client/docs/UpdateAPIPageData.md +26 -0
  209. data/client/docs/UpdateAPISSOUserData.md +56 -0
  210. data/client/docs/UpdateDomainConfigParams.md +30 -0
  211. data/client/docs/UpdateFeedPostParams.md +28 -0
  212. data/client/docs/UpdateUserBadge200Response.md +32 -0
  213. data/client/docs/UpdateUserBadgeParams.md +18 -0
  214. data/client/docs/UpdateUserNotificationStatus200Response.md +38 -0
  215. data/client/docs/UploadImageResponse.md +26 -0
  216. data/client/docs/UserBadge.md +52 -0
  217. data/client/docs/UserBadgeProgress.md +32 -0
  218. data/client/docs/UserNotification.md +64 -0
  219. data/client/docs/UserNotificationWriteResponse.md +22 -0
  220. data/client/docs/UserPresenceData.md +22 -0
  221. data/client/docs/UserReactsResponse.md +20 -0
  222. data/client/docs/UserSearchResult.md +26 -0
  223. data/client/docs/UserSessionInfo.md +42 -0
  224. data/client/docs/VoteBodyParams.md +24 -0
  225. data/client/docs/VoteComment200Response.md +40 -0
  226. data/client/docs/VoteDeleteResponse.md +20 -0
  227. data/client/docs/VoteResponse.md +26 -0
  228. data/client/docs/VoteResponseStatus.md +15 -0
  229. data/client/docs/VoteResponseUser.md +18 -0
  230. data/client/docs/VoteStyle.md +15 -0
  231. data/client/fastcomments-client.gemspec +39 -0
  232. data/client/git_push.sh +57 -0
  233. data/client/lib/fastcomments-client/api/default_api.rb +3463 -0
  234. data/client/lib/fastcomments-client/api/public_api.rb +2858 -0
  235. data/client/lib/fastcomments-client/api_client.rb +393 -0
  236. data/client/lib/fastcomments-client/api_error.rb +58 -0
  237. data/client/lib/fastcomments-client/configuration.rb +312 -0
  238. data/client/lib/fastcomments-client/models/add_domain_config200_response.rb +104 -0
  239. data/client/lib/fastcomments-client/models/add_domain_config200_response_any_of.rb +235 -0
  240. data/client/lib/fastcomments-client/models/add_domain_config_params.rb +294 -0
  241. data/client/lib/fastcomments-client/models/add_page_api_response.rb +264 -0
  242. data/client/lib/fastcomments-client/models/add_sso_user_api_response.rb +264 -0
  243. data/client/lib/fastcomments-client/models/aggregate_question_results200_response.rb +104 -0
  244. data/client/lib/fastcomments-client/models/aggregate_question_results_response.rb +285 -0
  245. data/client/lib/fastcomments-client/models/aggregate_time_bucket.rb +41 -0
  246. data/client/lib/fastcomments-client/models/aggregation_item.rb +223 -0
  247. data/client/lib/fastcomments-client/models/aggregation_op_type.rb +45 -0
  248. data/client/lib/fastcomments-client/models/aggregation_operation.rb +306 -0
  249. data/client/lib/fastcomments-client/models/aggregation_request.rb +297 -0
  250. data/client/lib/fastcomments-client/models/aggregation_request_sort.rb +287 -0
  251. data/client/lib/fastcomments-client/models/aggregation_response.rb +297 -0
  252. data/client/lib/fastcomments-client/models/aggregation_response_stats.rb +263 -0
  253. data/client/lib/fastcomments-client/models/aggregation_value.rb +262 -0
  254. data/client/lib/fastcomments-client/models/api_audit_log.rb +412 -0
  255. data/client/lib/fastcomments-client/models/api_comment.rb +888 -0
  256. data/client/lib/fastcomments-client/models/api_comment_base.rb +881 -0
  257. data/client/lib/fastcomments-client/models/api_create_user_badge_response.rb +285 -0
  258. data/client/lib/fastcomments-client/models/api_empty_response.rb +259 -0
  259. data/client/lib/fastcomments-client/models/api_empty_success_response.rb +259 -0
  260. data/client/lib/fastcomments-client/models/api_error.rb +356 -0
  261. data/client/lib/fastcomments-client/models/api_get_comment_response.rb +285 -0
  262. data/client/lib/fastcomments-client/models/api_get_comments_response.rb +287 -0
  263. data/client/lib/fastcomments-client/models/api_get_user_badge_progress_list_response.rb +287 -0
  264. data/client/lib/fastcomments-client/models/api_get_user_badge_progress_response.rb +285 -0
  265. data/client/lib/fastcomments-client/models/api_get_user_badge_response.rb +285 -0
  266. data/client/lib/fastcomments-client/models/api_get_user_badges_response.rb +287 -0
  267. data/client/lib/fastcomments-client/models/api_page.rb +396 -0
  268. data/client/lib/fastcomments-client/models/api_status.rb +40 -0
  269. data/client/lib/fastcomments-client/models/api_user_subscription.rb +325 -0
  270. data/client/lib/fastcomments-client/models/apisso_user.rb +597 -0
  271. data/client/lib/fastcomments-client/models/block_from_comment_params.rb +222 -0
  272. data/client/lib/fastcomments-client/models/block_from_comment_public200_response.rb +104 -0
  273. data/client/lib/fastcomments-client/models/block_success.rb +288 -0
  274. data/client/lib/fastcomments-client/models/bulk_aggregate_question_item.rb +306 -0
  275. data/client/lib/fastcomments-client/models/bulk_aggregate_question_results200_response.rb +104 -0
  276. data/client/lib/fastcomments-client/models/bulk_aggregate_question_results_request.rb +239 -0
  277. data/client/lib/fastcomments-client/models/bulk_aggregate_question_results_response.rb +288 -0
  278. data/client/lib/fastcomments-client/models/change_comment_pin_status_response.rb +288 -0
  279. data/client/lib/fastcomments-client/models/check_blocked_comments_response.rb +288 -0
  280. data/client/lib/fastcomments-client/models/checked_comments_for_blocked200_response.rb +104 -0
  281. data/client/lib/fastcomments-client/models/combine_comments_with_question_results200_response.rb +104 -0
  282. data/client/lib/fastcomments-client/models/combine_question_results_with_comments_response.rb +285 -0
  283. data/client/lib/fastcomments-client/models/comment_data.rb +511 -0
  284. data/client/lib/fastcomments-client/models/comment_html_rendering_mode.rb +40 -0
  285. data/client/lib/fastcomments-client/models/comment_log_data.rb +642 -0
  286. data/client/lib/fastcomments-client/models/comment_log_entry.rb +294 -0
  287. data/client/lib/fastcomments-client/models/comment_log_type.rb +93 -0
  288. data/client/lib/fastcomments-client/models/comment_question_results_rendering_type.rb +41 -0
  289. data/client/lib/fastcomments-client/models/comment_questions_required.rb +40 -0
  290. data/client/lib/fastcomments-client/models/comment_text_update_request.rb +259 -0
  291. data/client/lib/fastcomments-client/models/comment_thread_deletion_mode.rb +42 -0
  292. data/client/lib/fastcomments-client/models/comment_user_badge_info.rb +349 -0
  293. data/client/lib/fastcomments-client/models/comment_user_hash_tag_info.rb +284 -0
  294. data/client/lib/fastcomments-client/models/comment_user_mention_info.rb +324 -0
  295. data/client/lib/fastcomments-client/models/commenter_name_formats.rb +43 -0
  296. data/client/lib/fastcomments-client/models/create_api_page_data.rb +318 -0
  297. data/client/lib/fastcomments-client/models/create_api_user_subscription_data.rb +273 -0
  298. data/client/lib/fastcomments-client/models/create_apisso_user_data.rb +444 -0
  299. data/client/lib/fastcomments-client/models/create_comment_params.rb +619 -0
  300. data/client/lib/fastcomments-client/models/create_comment_public200_response.rb +104 -0
  301. data/client/lib/fastcomments-client/models/create_feed_post200_response.rb +104 -0
  302. data/client/lib/fastcomments-client/models/create_feed_post_params.rb +292 -0
  303. data/client/lib/fastcomments-client/models/create_feed_post_public200_response.rb +104 -0
  304. data/client/lib/fastcomments-client/models/create_feed_post_response.rb +285 -0
  305. data/client/lib/fastcomments-client/models/create_feed_posts_response.rb +285 -0
  306. data/client/lib/fastcomments-client/models/create_subscription_api_response.rb +264 -0
  307. data/client/lib/fastcomments-client/models/create_user_badge200_response.rb +104 -0
  308. data/client/lib/fastcomments-client/models/create_user_badge_params.rb +272 -0
  309. data/client/lib/fastcomments-client/models/custom_config_parameters.rb +906 -0
  310. data/client/lib/fastcomments-client/models/delete_comment200_response.rb +104 -0
  311. data/client/lib/fastcomments-client/models/delete_comment_action.rb +41 -0
  312. data/client/lib/fastcomments-client/models/delete_comment_public200_response.rb +104 -0
  313. data/client/lib/fastcomments-client/models/delete_comment_result.rb +285 -0
  314. data/client/lib/fastcomments-client/models/delete_comment_vote200_response.rb +104 -0
  315. data/client/lib/fastcomments-client/models/delete_domain_config200_response.rb +223 -0
  316. data/client/lib/fastcomments-client/models/delete_feed_post_public200_response.rb +104 -0
  317. data/client/lib/fastcomments-client/models/delete_feed_post_public200_response_any_of.rb +259 -0
  318. data/client/lib/fastcomments-client/models/delete_page_api_response.rb +255 -0
  319. data/client/lib/fastcomments-client/models/delete_sso_user_api_response.rb +264 -0
  320. data/client/lib/fastcomments-client/models/delete_subscription_api_response.rb +255 -0
  321. data/client/lib/fastcomments-client/models/deleted_comment_result_comment.rb +282 -0
  322. data/client/lib/fastcomments-client/models/event_log_entry.rb +367 -0
  323. data/client/lib/fastcomments-client/models/f_comment.rb +1054 -0
  324. data/client/lib/fastcomments-client/models/f_comment_meta.rb +229 -0
  325. data/client/lib/fastcomments-client/models/feed_post.rb +420 -0
  326. data/client/lib/fastcomments-client/models/feed_post_link.rb +247 -0
  327. data/client/lib/fastcomments-client/models/feed_post_media_item.rb +257 -0
  328. data/client/lib/fastcomments-client/models/feed_post_media_item_asset.rb +289 -0
  329. data/client/lib/fastcomments-client/models/feed_post_stats.rb +231 -0
  330. data/client/lib/fastcomments-client/models/feed_posts_stats_response.rb +287 -0
  331. data/client/lib/fastcomments-client/models/find_comments_by_range_item.rb +249 -0
  332. data/client/lib/fastcomments-client/models/find_comments_by_range_response.rb +265 -0
  333. data/client/lib/fastcomments-client/models/flag_comment200_response.rb +104 -0
  334. data/client/lib/fastcomments-client/models/flag_comment_public200_response.rb +104 -0
  335. data/client/lib/fastcomments-client/models/flag_comment_response.rb +295 -0
  336. data/client/lib/fastcomments-client/models/get_audit_logs200_response.rb +104 -0
  337. data/client/lib/fastcomments-client/models/get_audit_logs_response.rb +287 -0
  338. data/client/lib/fastcomments-client/models/get_comment200_response.rb +104 -0
  339. data/client/lib/fastcomments-client/models/get_comment_text200_response.rb +104 -0
  340. data/client/lib/fastcomments-client/models/get_comment_vote_user_names200_response.rb +104 -0
  341. data/client/lib/fastcomments-client/models/get_comment_vote_user_names_success_response.rb +313 -0
  342. data/client/lib/fastcomments-client/models/get_comments200_response.rb +104 -0
  343. data/client/lib/fastcomments-client/models/get_comments_public200_response.rb +104 -0
  344. data/client/lib/fastcomments-client/models/get_comments_response_public_comment.rb +487 -0
  345. data/client/lib/fastcomments-client/models/get_comments_response_with_presence_public_comment.rb +522 -0
  346. data/client/lib/fastcomments-client/models/get_domain_config200_response.rb +104 -0
  347. data/client/lib/fastcomments-client/models/get_domain_configs200_response.rb +104 -0
  348. data/client/lib/fastcomments-client/models/get_domain_configs200_response_any_of.rb +235 -0
  349. data/client/lib/fastcomments-client/models/get_domain_configs200_response_any_of1.rb +275 -0
  350. data/client/lib/fastcomments-client/models/get_event_log200_response.rb +104 -0
  351. data/client/lib/fastcomments-client/models/get_event_log_response.rb +287 -0
  352. data/client/lib/fastcomments-client/models/get_feed_posts200_response.rb +104 -0
  353. data/client/lib/fastcomments-client/models/get_feed_posts_public200_response.rb +104 -0
  354. data/client/lib/fastcomments-client/models/get_feed_posts_response.rb +287 -0
  355. data/client/lib/fastcomments-client/models/get_feed_posts_stats200_response.rb +104 -0
  356. data/client/lib/fastcomments-client/models/get_my_notifications_response.rb +351 -0
  357. data/client/lib/fastcomments-client/models/get_page_by_urlid_api_response.rb +264 -0
  358. data/client/lib/fastcomments-client/models/get_pages_api_response.rb +266 -0
  359. data/client/lib/fastcomments-client/models/get_public_feed_posts_response.rb +297 -0
  360. data/client/lib/fastcomments-client/models/get_sso_user_by_email_api_response.rb +264 -0
  361. data/client/lib/fastcomments-client/models/get_sso_user_by_id_api_response.rb +264 -0
  362. data/client/lib/fastcomments-client/models/get_sso_users200_response.rb +265 -0
  363. data/client/lib/fastcomments-client/models/get_subscriptions_api_response.rb +266 -0
  364. data/client/lib/fastcomments-client/models/get_user_badge200_response.rb +104 -0
  365. data/client/lib/fastcomments-client/models/get_user_badge_progress_by_id200_response.rb +104 -0
  366. data/client/lib/fastcomments-client/models/get_user_badge_progress_list200_response.rb +104 -0
  367. data/client/lib/fastcomments-client/models/get_user_badges200_response.rb +104 -0
  368. data/client/lib/fastcomments-client/models/get_user_notification_count200_response.rb +104 -0
  369. data/client/lib/fastcomments-client/models/get_user_notification_count_response.rb +285 -0
  370. data/client/lib/fastcomments-client/models/get_user_notifications200_response.rb +104 -0
  371. data/client/lib/fastcomments-client/models/get_user_presence_statuses200_response.rb +104 -0
  372. data/client/lib/fastcomments-client/models/get_user_presence_statuses_response.rb +288 -0
  373. data/client/lib/fastcomments-client/models/get_user_reacts_public200_response.rb +104 -0
  374. data/client/lib/fastcomments-client/models/gif_rating.rb +42 -0
  375. data/client/lib/fastcomments-client/models/header_state.rb +365 -0
  376. data/client/lib/fastcomments-client/models/ignored_response.rb +287 -0
  377. data/client/lib/fastcomments-client/models/image_content_profanity_level.rb +42 -0
  378. data/client/lib/fastcomments-client/models/live_event.rb +402 -0
  379. data/client/lib/fastcomments-client/models/live_event_extra_info.rb +223 -0
  380. data/client/lib/fastcomments-client/models/live_event_type.rb +55 -0
  381. data/client/lib/fastcomments-client/models/lock_comment200_response.rb +104 -0
  382. data/client/lib/fastcomments-client/models/media_asset.rb +289 -0
  383. data/client/lib/fastcomments-client/models/meta_item.rb +265 -0
  384. data/client/lib/fastcomments-client/models/notification_and_count.rb +285 -0
  385. data/client/lib/fastcomments-client/models/notification_object_type.rb +41 -0
  386. data/client/lib/fastcomments-client/models/notification_type.rb +51 -0
  387. data/client/lib/fastcomments-client/models/patch_domain_config_params.rb +277 -0
  388. data/client/lib/fastcomments-client/models/patch_page_api_response.rb +264 -0
  389. data/client/lib/fastcomments-client/models/patch_sso_user_api_response.rb +264 -0
  390. data/client/lib/fastcomments-client/models/pin_comment200_response.rb +104 -0
  391. data/client/lib/fastcomments-client/models/pub_sub_comment.rb +803 -0
  392. data/client/lib/fastcomments-client/models/pub_sub_comment_base.rb +752 -0
  393. data/client/lib/fastcomments-client/models/pub_sub_vote.rb +415 -0
  394. data/client/lib/fastcomments-client/models/public_api_delete_comment_response.rb +294 -0
  395. data/client/lib/fastcomments-client/models/public_api_get_comment_text_response.rb +311 -0
  396. data/client/lib/fastcomments-client/models/public_api_set_comment_text_response.rb +285 -0
  397. data/client/lib/fastcomments-client/models/public_block_from_comment_params.rb +226 -0
  398. data/client/lib/fastcomments-client/models/public_comment.rb +654 -0
  399. data/client/lib/fastcomments-client/models/public_comment_base.rb +552 -0
  400. data/client/lib/fastcomments-client/models/public_feed_posts_response.rb +343 -0
  401. data/client/lib/fastcomments-client/models/put_sso_user_api_response.rb +265 -0
  402. data/client/lib/fastcomments-client/models/query_predicate.rb +313 -0
  403. data/client/lib/fastcomments-client/models/query_predicate_value.rb +105 -0
  404. data/client/lib/fastcomments-client/models/question_datum.rb +266 -0
  405. data/client/lib/fastcomments-client/models/question_rendering_type.rb +40 -0
  406. data/client/lib/fastcomments-client/models/question_result.rb +467 -0
  407. data/client/lib/fastcomments-client/models/question_result_aggregation_overall.rb +307 -0
  408. data/client/lib/fastcomments-client/models/question_sub_question_visibility.rb +40 -0
  409. data/client/lib/fastcomments-client/models/question_when_save.rb +40 -0
  410. data/client/lib/fastcomments-client/models/react_body_params.rb +220 -0
  411. data/client/lib/fastcomments-client/models/react_feed_post_public200_response.rb +104 -0
  412. data/client/lib/fastcomments-client/models/react_feed_post_response.rb +311 -0
  413. data/client/lib/fastcomments-client/models/record_string_before_string_or_null_after_string_or_null_value.rb +263 -0
  414. data/client/lib/fastcomments-client/models/record_string_string_or_number_value.rb +104 -0
  415. data/client/lib/fastcomments-client/models/renderable_user_notification.rb +603 -0
  416. data/client/lib/fastcomments-client/models/repeat_comment_check_ignored_reason.rb +45 -0
  417. data/client/lib/fastcomments-client/models/repeat_comment_handling_action.rb +41 -0
  418. data/client/lib/fastcomments-client/models/reset_user_notifications200_response.rb +104 -0
  419. data/client/lib/fastcomments-client/models/reset_user_notifications_response.rb +280 -0
  420. data/client/lib/fastcomments-client/models/save_comment200_response.rb +104 -0
  421. data/client/lib/fastcomments-client/models/save_comment_response.rb +309 -0
  422. data/client/lib/fastcomments-client/models/save_comment_response_optimized.rb +309 -0
  423. data/client/lib/fastcomments-client/models/save_comments_response_with_presence.rb +325 -0
  424. data/client/lib/fastcomments-client/models/search_users200_response.rb +104 -0
  425. data/client/lib/fastcomments-client/models/search_users_response.rb +287 -0
  426. data/client/lib/fastcomments-client/models/set_comment_text200_response.rb +104 -0
  427. data/client/lib/fastcomments-client/models/set_comment_text_result.rb +263 -0
  428. data/client/lib/fastcomments-client/models/size_preset.rb +40 -0
  429. data/client/lib/fastcomments-client/models/sort_directions.rb +41 -0
  430. data/client/lib/fastcomments-client/models/sortdir.rb +40 -0
  431. data/client/lib/fastcomments-client/models/spam_rule.rb +260 -0
  432. data/client/lib/fastcomments-client/models/sso_security_level.rb +40 -0
  433. data/client/lib/fastcomments-client/models/un_block_comment_public200_response.rb +104 -0
  434. data/client/lib/fastcomments-client/models/un_block_from_comment_params.rb +222 -0
  435. data/client/lib/fastcomments-client/models/unblock_success.rb +288 -0
  436. data/client/lib/fastcomments-client/models/updatable_comment_params.rb +587 -0
  437. data/client/lib/fastcomments-client/models/update_api_page_data.rb +258 -0
  438. data/client/lib/fastcomments-client/models/update_apisso_user_data.rb +393 -0
  439. data/client/lib/fastcomments-client/models/update_domain_config_params.rb +294 -0
  440. data/client/lib/fastcomments-client/models/update_feed_post_params.rb +274 -0
  441. data/client/lib/fastcomments-client/models/update_user_badge200_response.rb +104 -0
  442. data/client/lib/fastcomments-client/models/update_user_badge_params.rb +220 -0
  443. data/client/lib/fastcomments-client/models/update_user_notification_status200_response.rb +105 -0
  444. data/client/lib/fastcomments-client/models/upload_image_response.rb +297 -0
  445. data/client/lib/fastcomments-client/models/user_badge.rb +582 -0
  446. data/client/lib/fastcomments-client/models/user_badge_progress.rb +388 -0
  447. data/client/lib/fastcomments-client/models/user_notification.rb +667 -0
  448. data/client/lib/fastcomments-client/models/user_notification_write_response.rb +311 -0
  449. data/client/lib/fastcomments-client/models/user_presence_data.rb +238 -0
  450. data/client/lib/fastcomments-client/models/user_reacts_response.rb +287 -0
  451. data/client/lib/fastcomments-client/models/user_search_result.rb +332 -0
  452. data/client/lib/fastcomments-client/models/user_session_info.rb +335 -0
  453. data/client/lib/fastcomments-client/models/vote_body_params.rb +297 -0
  454. data/client/lib/fastcomments-client/models/vote_comment200_response.rb +104 -0
  455. data/client/lib/fastcomments-client/models/vote_delete_response.rb +268 -0
  456. data/client/lib/fastcomments-client/models/vote_response.rb +273 -0
  457. data/client/lib/fastcomments-client/models/vote_response_status.rb +104 -0
  458. data/client/lib/fastcomments-client/models/vote_response_user.rb +221 -0
  459. data/client/lib/fastcomments-client/models/vote_style.rb +40 -0
  460. data/client/lib/fastcomments-client/version.rb +15 -0
  461. data/client/lib/fastcomments-client.rb +263 -0
  462. data/client/spec/api/default_api_spec.rb +633 -0
  463. data/client/spec/api/public_api_spec.rb +545 -0
  464. data/client/spec/models/add_domain_config200_response_any_of_spec.rb +42 -0
  465. data/client/spec/models/add_domain_config200_response_spec.rb +21 -0
  466. data/client/spec/models/add_domain_config_params_spec.rb +72 -0
  467. data/client/spec/models/add_page_api_response_spec.rb +54 -0
  468. data/client/spec/models/add_sso_user_api_response_spec.rb +54 -0
  469. data/client/spec/models/aggregate_question_results200_response_spec.rb +21 -0
  470. data/client/spec/models/aggregate_question_results_response_spec.rb +42 -0
  471. data/client/spec/models/aggregate_time_bucket_spec.rb +30 -0
  472. data/client/spec/models/aggregation_item_spec.rb +36 -0
  473. data/client/spec/models/aggregation_op_type_spec.rb +30 -0
  474. data/client/spec/models/aggregation_operation_spec.rb +54 -0
  475. data/client/spec/models/aggregation_request_sort_spec.rb +46 -0
  476. data/client/spec/models/aggregation_request_spec.rb +60 -0
  477. data/client/spec/models/aggregation_response_spec.rb +48 -0
  478. data/client/spec/models/aggregation_response_stats_spec.rb +42 -0
  479. data/client/spec/models/aggregation_value_spec.rb +60 -0
  480. data/client/spec/models/api_audit_log_spec.rb +110 -0
  481. data/client/spec/models/api_comment_base_spec.rb +348 -0
  482. data/client/spec/models/api_comment_spec.rb +348 -0
  483. data/client/spec/models/api_create_user_badge_response_spec.rb +42 -0
  484. data/client/spec/models/api_empty_response_spec.rb +36 -0
  485. data/client/spec/models/api_empty_success_response_spec.rb +36 -0
  486. data/client/spec/models/api_error_spec.rb +78 -0
  487. data/client/spec/models/api_get_comment_response_spec.rb +42 -0
  488. data/client/spec/models/api_get_comments_response_spec.rb +42 -0
  489. data/client/spec/models/api_get_user_badge_progress_list_response_spec.rb +42 -0
  490. data/client/spec/models/api_get_user_badge_progress_response_spec.rb +42 -0
  491. data/client/spec/models/api_get_user_badge_response_spec.rb +42 -0
  492. data/client/spec/models/api_get_user_badges_response_spec.rb +42 -0
  493. data/client/spec/models/api_page_spec.rb +84 -0
  494. data/client/spec/models/api_status_spec.rb +30 -0
  495. data/client/spec/models/api_user_subscription_spec.rb +72 -0
  496. data/client/spec/models/apisso_user_spec.rb +150 -0
  497. data/client/spec/models/block_from_comment_params_spec.rb +36 -0
  498. data/client/spec/models/block_from_comment_public200_response_spec.rb +21 -0
  499. data/client/spec/models/block_success_spec.rb +42 -0
  500. data/client/spec/models/bulk_aggregate_question_item_spec.rb +66 -0
  501. data/client/spec/models/bulk_aggregate_question_results200_response_spec.rb +21 -0
  502. data/client/spec/models/bulk_aggregate_question_results_request_spec.rb +36 -0
  503. data/client/spec/models/bulk_aggregate_question_results_response_spec.rb +42 -0
  504. data/client/spec/models/change_comment_pin_status_response_spec.rb +42 -0
  505. data/client/spec/models/check_blocked_comments_response_spec.rb +42 -0
  506. data/client/spec/models/checked_comments_for_blocked200_response_spec.rb +21 -0
  507. data/client/spec/models/combine_comments_with_question_results200_response_spec.rb +21 -0
  508. data/client/spec/models/combine_question_results_with_comments_response_spec.rb +42 -0
  509. data/client/spec/models/comment_data_spec.rb +174 -0
  510. data/client/spec/models/comment_html_rendering_mode_spec.rb +30 -0
  511. data/client/spec/models/comment_log_data_spec.rb +292 -0
  512. data/client/spec/models/comment_log_entry_spec.rb +48 -0
  513. data/client/spec/models/comment_log_type_spec.rb +30 -0
  514. data/client/spec/models/comment_question_results_rendering_type_spec.rb +30 -0
  515. data/client/spec/models/comment_questions_required_spec.rb +30 -0
  516. data/client/spec/models/comment_text_update_request_spec.rb +48 -0
  517. data/client/spec/models/comment_thread_deletion_mode_spec.rb +30 -0
  518. data/client/spec/models/comment_user_badge_info_spec.rb +84 -0
  519. data/client/spec/models/comment_user_hash_tag_info_spec.rb +54 -0
  520. data/client/spec/models/comment_user_mention_info_spec.rb +64 -0
  521. data/client/spec/models/commenter_name_formats_spec.rb +30 -0
  522. data/client/spec/models/create_api_page_data_spec.rb +66 -0
  523. data/client/spec/models/create_api_user_subscription_data_spec.rb +60 -0
  524. data/client/spec/models/create_apisso_user_data_spec.rb +150 -0
  525. data/client/spec/models/create_comment_params_spec.rb +234 -0
  526. data/client/spec/models/create_comment_public200_response_spec.rb +21 -0
  527. data/client/spec/models/create_feed_post200_response_spec.rb +21 -0
  528. data/client/spec/models/create_feed_post_params_spec.rb +78 -0
  529. data/client/spec/models/create_feed_post_public200_response_spec.rb +21 -0
  530. data/client/spec/models/create_feed_post_response_spec.rb +42 -0
  531. data/client/spec/models/create_feed_posts_response_spec.rb +42 -0
  532. data/client/spec/models/create_subscription_api_response_spec.rb +54 -0
  533. data/client/spec/models/create_user_badge200_response_spec.rb +21 -0
  534. data/client/spec/models/create_user_badge_params_spec.rb +48 -0
  535. data/client/spec/models/custom_config_parameters_spec.rb +462 -0
  536. data/client/spec/models/delete_comment200_response_spec.rb +21 -0
  537. data/client/spec/models/delete_comment_action_spec.rb +30 -0
  538. data/client/spec/models/delete_comment_public200_response_spec.rb +21 -0
  539. data/client/spec/models/delete_comment_result_spec.rb +42 -0
  540. data/client/spec/models/delete_comment_vote200_response_spec.rb +21 -0
  541. data/client/spec/models/delete_domain_config200_response_spec.rb +36 -0
  542. data/client/spec/models/delete_feed_post_public200_response_any_of_spec.rb +36 -0
  543. data/client/spec/models/delete_feed_post_public200_response_spec.rb +21 -0
  544. data/client/spec/models/delete_page_api_response_spec.rb +48 -0
  545. data/client/spec/models/delete_sso_user_api_response_spec.rb +54 -0
  546. data/client/spec/models/delete_subscription_api_response_spec.rb +48 -0
  547. data/client/spec/models/deleted_comment_result_comment_spec.rb +54 -0
  548. data/client/spec/models/event_log_entry_spec.rb +66 -0
  549. data/client/spec/models/f_comment_meta_spec.rb +42 -0
  550. data/client/spec/models/f_comment_spec.rb +456 -0
  551. data/client/spec/models/feed_post_link_spec.rb +54 -0
  552. data/client/spec/models/feed_post_media_item_asset_spec.rb +48 -0
  553. data/client/spec/models/feed_post_media_item_spec.rb +48 -0
  554. data/client/spec/models/feed_post_spec.rb +126 -0
  555. data/client/spec/models/feed_post_stats_spec.rb +42 -0
  556. data/client/spec/models/feed_posts_stats_response_spec.rb +42 -0
  557. data/client/spec/models/find_comments_by_range_item_spec.rb +42 -0
  558. data/client/spec/models/find_comments_by_range_response_spec.rb +42 -0
  559. data/client/spec/models/flag_comment200_response_spec.rb +21 -0
  560. data/client/spec/models/flag_comment_public200_response_spec.rb +21 -0
  561. data/client/spec/models/flag_comment_response_spec.rb +60 -0
  562. data/client/spec/models/get_audit_logs200_response_spec.rb +21 -0
  563. data/client/spec/models/get_audit_logs_response_spec.rb +42 -0
  564. data/client/spec/models/get_comment200_response_spec.rb +21 -0
  565. data/client/spec/models/get_comment_text200_response_spec.rb +21 -0
  566. data/client/spec/models/get_comment_vote_user_names200_response_spec.rb +21 -0
  567. data/client/spec/models/get_comment_vote_user_names_success_response_spec.rb +48 -0
  568. data/client/spec/models/get_comments200_response_spec.rb +21 -0
  569. data/client/spec/models/get_comments_public200_response_spec.rb +21 -0
  570. data/client/spec/models/get_comments_response_public_comment_spec.rb +174 -0
  571. data/client/spec/models/get_comments_response_with_presence_public_comment_spec.rb +192 -0
  572. data/client/spec/models/get_domain_config200_response_spec.rb +21 -0
  573. data/client/spec/models/get_domain_configs200_response_any_of1_spec.rb +48 -0
  574. data/client/spec/models/get_domain_configs200_response_any_of_spec.rb +42 -0
  575. data/client/spec/models/get_domain_configs200_response_spec.rb +21 -0
  576. data/client/spec/models/get_event_log200_response_spec.rb +21 -0
  577. data/client/spec/models/get_event_log_response_spec.rb +42 -0
  578. data/client/spec/models/get_feed_posts200_response_spec.rb +21 -0
  579. data/client/spec/models/get_feed_posts_public200_response_spec.rb +21 -0
  580. data/client/spec/models/get_feed_posts_response_spec.rb +42 -0
  581. data/client/spec/models/get_feed_posts_stats200_response_spec.rb +21 -0
  582. data/client/spec/models/get_my_notifications_response_spec.rb +60 -0
  583. data/client/spec/models/get_page_by_urlid_api_response_spec.rb +54 -0
  584. data/client/spec/models/get_pages_api_response_spec.rb +54 -0
  585. data/client/spec/models/get_public_feed_posts_response_spec.rb +48 -0
  586. data/client/spec/models/get_sso_user_by_email_api_response_spec.rb +54 -0
  587. data/client/spec/models/get_sso_user_by_id_api_response_spec.rb +54 -0
  588. data/client/spec/models/get_sso_users200_response_spec.rb +42 -0
  589. data/client/spec/models/get_subscriptions_api_response_spec.rb +54 -0
  590. data/client/spec/models/get_user_badge200_response_spec.rb +21 -0
  591. data/client/spec/models/get_user_badge_progress_by_id200_response_spec.rb +21 -0
  592. data/client/spec/models/get_user_badge_progress_list200_response_spec.rb +21 -0
  593. data/client/spec/models/get_user_badges200_response_spec.rb +21 -0
  594. data/client/spec/models/get_user_notification_count200_response_spec.rb +21 -0
  595. data/client/spec/models/get_user_notification_count_response_spec.rb +42 -0
  596. data/client/spec/models/get_user_notifications200_response_spec.rb +21 -0
  597. data/client/spec/models/get_user_presence_statuses200_response_spec.rb +21 -0
  598. data/client/spec/models/get_user_presence_statuses_response_spec.rb +42 -0
  599. data/client/spec/models/get_user_reacts_public200_response_spec.rb +21 -0
  600. data/client/spec/models/gif_rating_spec.rb +30 -0
  601. data/client/spec/models/header_state_spec.rb +60 -0
  602. data/client/spec/models/ignored_response_spec.rb +46 -0
  603. data/client/spec/models/image_content_profanity_level_spec.rb +30 -0
  604. data/client/spec/models/live_event_extra_info_spec.rb +36 -0
  605. data/client/spec/models/live_event_spec.rb +126 -0
  606. data/client/spec/models/live_event_type_spec.rb +30 -0
  607. data/client/spec/models/lock_comment200_response_spec.rb +21 -0
  608. data/client/spec/models/media_asset_spec.rb +48 -0
  609. data/client/spec/models/meta_item_spec.rb +42 -0
  610. data/client/spec/models/notification_and_count_spec.rb +42 -0
  611. data/client/spec/models/notification_object_type_spec.rb +30 -0
  612. data/client/spec/models/notification_type_spec.rb +30 -0
  613. data/client/spec/models/patch_domain_config_params_spec.rb +72 -0
  614. data/client/spec/models/patch_page_api_response_spec.rb +54 -0
  615. data/client/spec/models/patch_sso_user_api_response_spec.rb +54 -0
  616. data/client/spec/models/pin_comment200_response_spec.rb +21 -0
  617. data/client/spec/models/pub_sub_comment_base_spec.rb +270 -0
  618. data/client/spec/models/pub_sub_comment_spec.rb +288 -0
  619. data/client/spec/models/pub_sub_vote_spec.rb +84 -0
  620. data/client/spec/models/public_api_delete_comment_response_spec.rb +48 -0
  621. data/client/spec/models/public_api_get_comment_text_response_spec.rb +48 -0
  622. data/client/spec/models/public_api_set_comment_text_response_spec.rb +42 -0
  623. data/client/spec/models/public_block_from_comment_params_spec.rb +36 -0
  624. data/client/spec/models/public_comment_base_spec.rb +198 -0
  625. data/client/spec/models/public_comment_spec.rb +258 -0
  626. data/client/spec/models/public_feed_posts_response_spec.rb +72 -0
  627. data/client/spec/models/put_sso_user_api_response_spec.rb +54 -0
  628. data/client/spec/models/query_predicate_spec.rb +52 -0
  629. data/client/spec/models/query_predicate_value_spec.rb +21 -0
  630. data/client/spec/models/question_datum_spec.rb +42 -0
  631. data/client/spec/models/question_rendering_type_spec.rb +30 -0
  632. data/client/spec/models/question_result_aggregation_overall_spec.rb +66 -0
  633. data/client/spec/models/question_result_spec.rb +96 -0
  634. data/client/spec/models/question_sub_question_visibility_spec.rb +30 -0
  635. data/client/spec/models/question_when_save_spec.rb +30 -0
  636. data/client/spec/models/react_body_params_spec.rb +36 -0
  637. data/client/spec/models/react_feed_post_public200_response_spec.rb +21 -0
  638. data/client/spec/models/react_feed_post_response_spec.rb +48 -0
  639. data/client/spec/models/record_string_before_string_or_null_after_string_or_null_value_spec.rb +42 -0
  640. data/client/spec/models/record_string_string_or_number_value_spec.rb +21 -0
  641. data/client/spec/models/renderable_user_notification_spec.rb +156 -0
  642. data/client/spec/models/repeat_comment_check_ignored_reason_spec.rb +30 -0
  643. data/client/spec/models/repeat_comment_handling_action_spec.rb +30 -0
  644. data/client/spec/models/reset_user_notifications200_response_spec.rb +21 -0
  645. data/client/spec/models/reset_user_notifications_response_spec.rb +46 -0
  646. data/client/spec/models/save_comment200_response_spec.rb +21 -0
  647. data/client/spec/models/save_comment_response_optimized_spec.rb +54 -0
  648. data/client/spec/models/save_comment_response_spec.rb +54 -0
  649. data/client/spec/models/save_comments_response_with_presence_spec.rb +60 -0
  650. data/client/spec/models/search_users200_response_spec.rb +21 -0
  651. data/client/spec/models/search_users_response_spec.rb +42 -0
  652. data/client/spec/models/set_comment_text200_response_spec.rb +21 -0
  653. data/client/spec/models/set_comment_text_result_spec.rb +42 -0
  654. data/client/spec/models/size_preset_spec.rb +30 -0
  655. data/client/spec/models/sort_directions_spec.rb +30 -0
  656. data/client/spec/models/sortdir_spec.rb +30 -0
  657. data/client/spec/models/spam_rule_spec.rb +46 -0
  658. data/client/spec/models/sso_security_level_spec.rb +30 -0
  659. data/client/spec/models/un_block_comment_public200_response_spec.rb +21 -0
  660. data/client/spec/models/un_block_from_comment_params_spec.rb +36 -0
  661. data/client/spec/models/unblock_success_spec.rb +42 -0
  662. data/client/spec/models/updatable_comment_params_spec.rb +264 -0
  663. data/client/spec/models/update_api_page_data_spec.rb +60 -0
  664. data/client/spec/models/update_apisso_user_data_spec.rb +150 -0
  665. data/client/spec/models/update_domain_config_params_spec.rb +72 -0
  666. data/client/spec/models/update_feed_post_params_spec.rb +66 -0
  667. data/client/spec/models/update_user_badge200_response_spec.rb +21 -0
  668. data/client/spec/models/update_user_badge_params_spec.rb +36 -0
  669. data/client/spec/models/update_user_notification_status200_response_spec.rb +21 -0
  670. data/client/spec/models/upload_image_response_spec.rb +60 -0
  671. data/client/spec/models/user_badge_progress_spec.rb +78 -0
  672. data/client/spec/models/user_badge_spec.rb +138 -0
  673. data/client/spec/models/user_notification_spec.rb +174 -0
  674. data/client/spec/models/user_notification_write_response_spec.rb +48 -0
  675. data/client/spec/models/user_presence_data_spec.rb +48 -0
  676. data/client/spec/models/user_reacts_response_spec.rb +42 -0
  677. data/client/spec/models/user_search_result_spec.rb +64 -0
  678. data/client/spec/models/user_session_info_spec.rb +108 -0
  679. data/client/spec/models/vote_body_params_spec.rb +58 -0
  680. data/client/spec/models/vote_comment200_response_spec.rb +21 -0
  681. data/client/spec/models/vote_delete_response_spec.rb +42 -0
  682. data/client/spec/models/vote_response_spec.rb +60 -0
  683. data/client/spec/models/vote_response_status_spec.rb +21 -0
  684. data/client/spec/models/vote_response_user_spec.rb +36 -0
  685. data/client/spec/models/vote_style_spec.rb +30 -0
  686. data/client/spec/spec_helper.rb +111 -0
  687. data/lib/fastcomments/sso/fastcomments_sso.rb +81 -0
  688. data/lib/fastcomments/sso/helpers.rb +26 -0
  689. data/lib/fastcomments/sso/secure_sso_payload.rb +23 -0
  690. data/lib/fastcomments/sso/secure_sso_user_data.rb +31 -0
  691. data/lib/fastcomments/sso/simple_sso_user_data.rb +23 -0
  692. data/lib/fastcomments.rb +9 -0
  693. metadata +787 -0
@@ -0,0 +1,3601 @@
1
+ # FastCommentsClient::DefaultApi
2
+
3
+ All URIs are relative to *https://fastcomments.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**add_domain_config**](DefaultApi.md#add_domain_config) | **POST** /api/v1/domain-configs | |
8
+ | [**add_page**](DefaultApi.md#add_page) | **POST** /api/v1/pages | |
9
+ | [**add_sso_user**](DefaultApi.md#add_sso_user) | **POST** /api/v1/sso-users | |
10
+ | [**aggregate**](DefaultApi.md#aggregate) | **POST** /api/v1/aggregate | |
11
+ | [**aggregate_question_results**](DefaultApi.md#aggregate_question_results) | **GET** /api/v1/question-results-aggregation | |
12
+ | [**block_user_from_comment**](DefaultApi.md#block_user_from_comment) | **POST** /api/v1/comments/{id}/block | |
13
+ | [**bulk_aggregate_question_results**](DefaultApi.md#bulk_aggregate_question_results) | **POST** /api/v1/question-results-aggregation/bulk | |
14
+ | [**combine_comments_with_question_results**](DefaultApi.md#combine_comments_with_question_results) | **GET** /api/v1/question-results-aggregation/combine/comments | |
15
+ | [**create_feed_post**](DefaultApi.md#create_feed_post) | **POST** /api/v1/feed-posts | |
16
+ | [**create_subscription**](DefaultApi.md#create_subscription) | **POST** /api/v1/subscriptions | |
17
+ | [**create_user_badge**](DefaultApi.md#create_user_badge) | **POST** /api/v1/user-badges | |
18
+ | [**delete_comment**](DefaultApi.md#delete_comment) | **DELETE** /api/v1/comments/{id} | |
19
+ | [**delete_domain_config**](DefaultApi.md#delete_domain_config) | **DELETE** /api/v1/domain-configs/{domain} | |
20
+ | [**delete_page**](DefaultApi.md#delete_page) | **DELETE** /api/v1/pages/{id} | |
21
+ | [**delete_sso_user**](DefaultApi.md#delete_sso_user) | **DELETE** /api/v1/sso-users/{id} | |
22
+ | [**delete_subscription**](DefaultApi.md#delete_subscription) | **DELETE** /api/v1/subscriptions/{id} | |
23
+ | [**delete_user_badge**](DefaultApi.md#delete_user_badge) | **DELETE** /api/v1/user-badges/{id} | |
24
+ | [**flag_comment**](DefaultApi.md#flag_comment) | **POST** /api/v1/comments/{id}/flag | |
25
+ | [**get_audit_logs**](DefaultApi.md#get_audit_logs) | **GET** /api/v1/audit-logs | |
26
+ | [**get_comment**](DefaultApi.md#get_comment) | **GET** /api/v1/comments/{id} | |
27
+ | [**get_comments**](DefaultApi.md#get_comments) | **GET** /api/v1/comments | |
28
+ | [**get_domain_config**](DefaultApi.md#get_domain_config) | **GET** /api/v1/domain-configs/{domain} | |
29
+ | [**get_domain_configs**](DefaultApi.md#get_domain_configs) | **GET** /api/v1/domain-configs | |
30
+ | [**get_feed_posts**](DefaultApi.md#get_feed_posts) | **GET** /api/v1/feed-posts | |
31
+ | [**get_page_by_urlid**](DefaultApi.md#get_page_by_urlid) | **GET** /api/v1/pages/by-url-id | |
32
+ | [**get_pages**](DefaultApi.md#get_pages) | **GET** /api/v1/pages | |
33
+ | [**get_sso_user_by_email**](DefaultApi.md#get_sso_user_by_email) | **GET** /api/v1/sso-users/by-email/{email} | |
34
+ | [**get_sso_user_by_id**](DefaultApi.md#get_sso_user_by_id) | **GET** /api/v1/sso-users/by-id/{id} | |
35
+ | [**get_sso_users**](DefaultApi.md#get_sso_users) | **GET** /api/v1/sso-users | |
36
+ | [**get_subscriptions**](DefaultApi.md#get_subscriptions) | **GET** /api/v1/subscriptions | |
37
+ | [**get_user_badge**](DefaultApi.md#get_user_badge) | **GET** /api/v1/user-badges/{id} | |
38
+ | [**get_user_badge_progress_by_id**](DefaultApi.md#get_user_badge_progress_by_id) | **GET** /api/v1/user-badge-progress/{id} | |
39
+ | [**get_user_badge_progress_by_user_id**](DefaultApi.md#get_user_badge_progress_by_user_id) | **GET** /api/v1/user-badge-progress/user/{userId} | |
40
+ | [**get_user_badge_progress_list**](DefaultApi.md#get_user_badge_progress_list) | **GET** /api/v1/user-badge-progress | |
41
+ | [**get_user_badges**](DefaultApi.md#get_user_badges) | **GET** /api/v1/user-badges | |
42
+ | [**patch_domain_config**](DefaultApi.md#patch_domain_config) | **PATCH** /api/v1/domain-configs/{domainToUpdate} | |
43
+ | [**patch_page**](DefaultApi.md#patch_page) | **PATCH** /api/v1/pages/{id} | |
44
+ | [**patch_sso_user**](DefaultApi.md#patch_sso_user) | **PATCH** /api/v1/sso-users/{id} | |
45
+ | [**put_domain_config**](DefaultApi.md#put_domain_config) | **PUT** /api/v1/domain-configs/{domainToUpdate} | |
46
+ | [**put_sso_user**](DefaultApi.md#put_sso_user) | **PUT** /api/v1/sso-users/{id} | |
47
+ | [**save_comment**](DefaultApi.md#save_comment) | **POST** /api/v1/comments | |
48
+ | [**save_comments_bulk**](DefaultApi.md#save_comments_bulk) | **POST** /api/v1/comments/bulk | |
49
+ | [**un_block_user_from_comment**](DefaultApi.md#un_block_user_from_comment) | **POST** /api/v1/comments/{id}/un-block | |
50
+ | [**un_flag_comment**](DefaultApi.md#un_flag_comment) | **POST** /api/v1/comments/{id}/un-flag | |
51
+ | [**update_comment**](DefaultApi.md#update_comment) | **PATCH** /api/v1/comments/{id} | |
52
+ | [**update_feed_post**](DefaultApi.md#update_feed_post) | **PATCH** /api/v1/feed-posts/{id} | |
53
+ | [**update_user_badge**](DefaultApi.md#update_user_badge) | **PUT** /api/v1/user-badges/{id} | |
54
+
55
+
56
+ ## add_domain_config
57
+
58
+ > <AddDomainConfig200Response> add_domain_config(tenant_id, add_domain_config_params)
59
+
60
+
61
+
62
+ ### Examples
63
+
64
+ ```ruby
65
+ require 'time'
66
+ require 'fastcomments-client'
67
+ # setup authorization
68
+ FastCommentsClient.configure do |config|
69
+ # Configure API key authorization: api_key
70
+ config.api_key['x-api-key'] = 'YOUR API KEY'
71
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
72
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
73
+ end
74
+
75
+ api_instance = FastCommentsClient::DefaultApi.new
76
+ tenant_id = 'tenant_id_example' # String |
77
+ add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |
78
+
79
+ begin
80
+
81
+ result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
82
+ p result
83
+ rescue FastCommentsClient::ApiError => e
84
+ puts "Error when calling DefaultApi->add_domain_config: #{e}"
85
+ end
86
+ ```
87
+
88
+ #### Using the add_domain_config_with_http_info variant
89
+
90
+ This returns an Array which contains the response data, status code and headers.
91
+
92
+ > <Array(<AddDomainConfig200Response>, Integer, Hash)> add_domain_config_with_http_info(tenant_id, add_domain_config_params)
93
+
94
+ ```ruby
95
+ begin
96
+
97
+ data, status_code, headers = api_instance.add_domain_config_with_http_info(tenant_id, add_domain_config_params)
98
+ p status_code # => 2xx
99
+ p headers # => { ... }
100
+ p data # => <AddDomainConfig200Response>
101
+ rescue FastCommentsClient::ApiError => e
102
+ puts "Error when calling DefaultApi->add_domain_config_with_http_info: #{e}"
103
+ end
104
+ ```
105
+
106
+ ### Parameters
107
+
108
+ | Name | Type | Description | Notes |
109
+ | ---- | ---- | ----------- | ----- |
110
+ | **tenant_id** | **String** | | |
111
+ | **add_domain_config_params** | [**AddDomainConfigParams**](AddDomainConfigParams.md) | | |
112
+
113
+ ### Return type
114
+
115
+ [**AddDomainConfig200Response**](AddDomainConfig200Response.md)
116
+
117
+ ### Authorization
118
+
119
+ [api_key](../README.md#api_key)
120
+
121
+ ### HTTP request headers
122
+
123
+ - **Content-Type**: application/json
124
+ - **Accept**: application/json
125
+
126
+
127
+ ## add_page
128
+
129
+ > <AddPageAPIResponse> add_page(tenant_id, create_api_page_data)
130
+
131
+
132
+
133
+ ### Examples
134
+
135
+ ```ruby
136
+ require 'time'
137
+ require 'fastcomments-client'
138
+ # setup authorization
139
+ FastCommentsClient.configure do |config|
140
+ # Configure API key authorization: api_key
141
+ config.api_key['x-api-key'] = 'YOUR API KEY'
142
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
143
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
144
+ end
145
+
146
+ api_instance = FastCommentsClient::DefaultApi.new
147
+ tenant_id = 'tenant_id_example' # String |
148
+ create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData |
149
+
150
+ begin
151
+
152
+ result = api_instance.add_page(tenant_id, create_api_page_data)
153
+ p result
154
+ rescue FastCommentsClient::ApiError => e
155
+ puts "Error when calling DefaultApi->add_page: #{e}"
156
+ end
157
+ ```
158
+
159
+ #### Using the add_page_with_http_info variant
160
+
161
+ This returns an Array which contains the response data, status code and headers.
162
+
163
+ > <Array(<AddPageAPIResponse>, Integer, Hash)> add_page_with_http_info(tenant_id, create_api_page_data)
164
+
165
+ ```ruby
166
+ begin
167
+
168
+ data, status_code, headers = api_instance.add_page_with_http_info(tenant_id, create_api_page_data)
169
+ p status_code # => 2xx
170
+ p headers # => { ... }
171
+ p data # => <AddPageAPIResponse>
172
+ rescue FastCommentsClient::ApiError => e
173
+ puts "Error when calling DefaultApi->add_page_with_http_info: #{e}"
174
+ end
175
+ ```
176
+
177
+ ### Parameters
178
+
179
+ | Name | Type | Description | Notes |
180
+ | ---- | ---- | ----------- | ----- |
181
+ | **tenant_id** | **String** | | |
182
+ | **create_api_page_data** | [**CreateAPIPageData**](CreateAPIPageData.md) | | |
183
+
184
+ ### Return type
185
+
186
+ [**AddPageAPIResponse**](AddPageAPIResponse.md)
187
+
188
+ ### Authorization
189
+
190
+ [api_key](../README.md#api_key)
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: application/json
195
+ - **Accept**: application/json
196
+
197
+
198
+ ## add_sso_user
199
+
200
+ > <AddSSOUserAPIResponse> add_sso_user(tenant_id, create_apisso_user_data)
201
+
202
+
203
+
204
+ ### Examples
205
+
206
+ ```ruby
207
+ require 'time'
208
+ require 'fastcomments-client'
209
+ # setup authorization
210
+ FastCommentsClient.configure do |config|
211
+ # Configure API key authorization: api_key
212
+ config.api_key['x-api-key'] = 'YOUR API KEY'
213
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
214
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
215
+ end
216
+
217
+ api_instance = FastCommentsClient::DefaultApi.new
218
+ tenant_id = 'tenant_id_example' # String |
219
+ create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData |
220
+
221
+ begin
222
+
223
+ result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
224
+ p result
225
+ rescue FastCommentsClient::ApiError => e
226
+ puts "Error when calling DefaultApi->add_sso_user: #{e}"
227
+ end
228
+ ```
229
+
230
+ #### Using the add_sso_user_with_http_info variant
231
+
232
+ This returns an Array which contains the response data, status code and headers.
233
+
234
+ > <Array(<AddSSOUserAPIResponse>, Integer, Hash)> add_sso_user_with_http_info(tenant_id, create_apisso_user_data)
235
+
236
+ ```ruby
237
+ begin
238
+
239
+ data, status_code, headers = api_instance.add_sso_user_with_http_info(tenant_id, create_apisso_user_data)
240
+ p status_code # => 2xx
241
+ p headers # => { ... }
242
+ p data # => <AddSSOUserAPIResponse>
243
+ rescue FastCommentsClient::ApiError => e
244
+ puts "Error when calling DefaultApi->add_sso_user_with_http_info: #{e}"
245
+ end
246
+ ```
247
+
248
+ ### Parameters
249
+
250
+ | Name | Type | Description | Notes |
251
+ | ---- | ---- | ----------- | ----- |
252
+ | **tenant_id** | **String** | | |
253
+ | **create_apisso_user_data** | [**CreateAPISSOUserData**](CreateAPISSOUserData.md) | | |
254
+
255
+ ### Return type
256
+
257
+ [**AddSSOUserAPIResponse**](AddSSOUserAPIResponse.md)
258
+
259
+ ### Authorization
260
+
261
+ [api_key](../README.md#api_key)
262
+
263
+ ### HTTP request headers
264
+
265
+ - **Content-Type**: application/json
266
+ - **Accept**: application/json
267
+
268
+
269
+ ## aggregate
270
+
271
+ > <AggregationResponse> aggregate(tenant_id, aggregation_request, opts)
272
+
273
+
274
+
275
+ Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
276
+
277
+ ### Examples
278
+
279
+ ```ruby
280
+ require 'time'
281
+ require 'fastcomments-client'
282
+ # setup authorization
283
+ FastCommentsClient.configure do |config|
284
+ # Configure API key authorization: api_key
285
+ config.api_key['x-api-key'] = 'YOUR API KEY'
286
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
287
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
288
+ end
289
+
290
+ api_instance = FastCommentsClient::DefaultApi.new
291
+ tenant_id = 'tenant_id_example' # String |
292
+ aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |
293
+ opts = {
294
+ parent_tenant_id: 'parent_tenant_id_example', # String |
295
+ include_stats: true # Boolean |
296
+ }
297
+
298
+ begin
299
+
300
+ result = api_instance.aggregate(tenant_id, aggregation_request, opts)
301
+ p result
302
+ rescue FastCommentsClient::ApiError => e
303
+ puts "Error when calling DefaultApi->aggregate: #{e}"
304
+ end
305
+ ```
306
+
307
+ #### Using the aggregate_with_http_info variant
308
+
309
+ This returns an Array which contains the response data, status code and headers.
310
+
311
+ > <Array(<AggregationResponse>, Integer, Hash)> aggregate_with_http_info(tenant_id, aggregation_request, opts)
312
+
313
+ ```ruby
314
+ begin
315
+
316
+ data, status_code, headers = api_instance.aggregate_with_http_info(tenant_id, aggregation_request, opts)
317
+ p status_code # => 2xx
318
+ p headers # => { ... }
319
+ p data # => <AggregationResponse>
320
+ rescue FastCommentsClient::ApiError => e
321
+ puts "Error when calling DefaultApi->aggregate_with_http_info: #{e}"
322
+ end
323
+ ```
324
+
325
+ ### Parameters
326
+
327
+ | Name | Type | Description | Notes |
328
+ | ---- | ---- | ----------- | ----- |
329
+ | **tenant_id** | **String** | | |
330
+ | **aggregation_request** | [**AggregationRequest**](AggregationRequest.md) | | |
331
+ | **parent_tenant_id** | **String** | | [optional] |
332
+ | **include_stats** | **Boolean** | | [optional] |
333
+
334
+ ### Return type
335
+
336
+ [**AggregationResponse**](AggregationResponse.md)
337
+
338
+ ### Authorization
339
+
340
+ [api_key](../README.md#api_key)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: application/json
345
+ - **Accept**: application/json
346
+
347
+
348
+ ## aggregate_question_results
349
+
350
+ > <AggregateQuestionResults200Response> aggregate_question_results(tenant_id, opts)
351
+
352
+
353
+
354
+ ### Examples
355
+
356
+ ```ruby
357
+ require 'time'
358
+ require 'fastcomments-client'
359
+ # setup authorization
360
+ FastCommentsClient.configure do |config|
361
+ # Configure API key authorization: api_key
362
+ config.api_key['x-api-key'] = 'YOUR API KEY'
363
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
364
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
365
+ end
366
+
367
+ api_instance = FastCommentsClient::DefaultApi.new
368
+ tenant_id = 'tenant_id_example' # String |
369
+ opts = {
370
+ question_id: 'question_id_example', # String |
371
+ question_ids: ['inner_example'], # Array<String> |
372
+ url_id: 'url_id_example', # String |
373
+ time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket |
374
+ start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
375
+ force_recalculate: true # Boolean |
376
+ }
377
+
378
+ begin
379
+
380
+ result = api_instance.aggregate_question_results(tenant_id, opts)
381
+ p result
382
+ rescue FastCommentsClient::ApiError => e
383
+ puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
384
+ end
385
+ ```
386
+
387
+ #### Using the aggregate_question_results_with_http_info variant
388
+
389
+ This returns an Array which contains the response data, status code and headers.
390
+
391
+ > <Array(<AggregateQuestionResults200Response>, Integer, Hash)> aggregate_question_results_with_http_info(tenant_id, opts)
392
+
393
+ ```ruby
394
+ begin
395
+
396
+ data, status_code, headers = api_instance.aggregate_question_results_with_http_info(tenant_id, opts)
397
+ p status_code # => 2xx
398
+ p headers # => { ... }
399
+ p data # => <AggregateQuestionResults200Response>
400
+ rescue FastCommentsClient::ApiError => e
401
+ puts "Error when calling DefaultApi->aggregate_question_results_with_http_info: #{e}"
402
+ end
403
+ ```
404
+
405
+ ### Parameters
406
+
407
+ | Name | Type | Description | Notes |
408
+ | ---- | ---- | ----------- | ----- |
409
+ | **tenant_id** | **String** | | |
410
+ | **question_id** | **String** | | [optional] |
411
+ | **question_ids** | [**Array&lt;String&gt;**](String.md) | | [optional] |
412
+ | **url_id** | **String** | | [optional] |
413
+ | **time_bucket** | [**AggregateTimeBucket**](.md) | | [optional] |
414
+ | **start_date** | **Time** | | [optional] |
415
+ | **force_recalculate** | **Boolean** | | [optional] |
416
+
417
+ ### Return type
418
+
419
+ [**AggregateQuestionResults200Response**](AggregateQuestionResults200Response.md)
420
+
421
+ ### Authorization
422
+
423
+ [api_key](../README.md#api_key)
424
+
425
+ ### HTTP request headers
426
+
427
+ - **Content-Type**: Not defined
428
+ - **Accept**: application/json
429
+
430
+
431
+ ## block_user_from_comment
432
+
433
+ > <BlockFromCommentPublic200Response> block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
434
+
435
+
436
+
437
+ ### Examples
438
+
439
+ ```ruby
440
+ require 'time'
441
+ require 'fastcomments-client'
442
+ # setup authorization
443
+ FastCommentsClient.configure do |config|
444
+ # Configure API key authorization: api_key
445
+ config.api_key['x-api-key'] = 'YOUR API KEY'
446
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
447
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
448
+ end
449
+
450
+ api_instance = FastCommentsClient::DefaultApi.new
451
+ tenant_id = 'tenant_id_example' # String |
452
+ id = 'id_example' # String |
453
+ block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams |
454
+ opts = {
455
+ user_id: 'user_id_example', # String |
456
+ anon_user_id: 'anon_user_id_example' # String |
457
+ }
458
+
459
+ begin
460
+
461
+ result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
462
+ p result
463
+ rescue FastCommentsClient::ApiError => e
464
+ puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
465
+ end
466
+ ```
467
+
468
+ #### Using the block_user_from_comment_with_http_info variant
469
+
470
+ This returns an Array which contains the response data, status code and headers.
471
+
472
+ > <Array(<BlockFromCommentPublic200Response>, Integer, Hash)> block_user_from_comment_with_http_info(tenant_id, id, block_from_comment_params, opts)
473
+
474
+ ```ruby
475
+ begin
476
+
477
+ data, status_code, headers = api_instance.block_user_from_comment_with_http_info(tenant_id, id, block_from_comment_params, opts)
478
+ p status_code # => 2xx
479
+ p headers # => { ... }
480
+ p data # => <BlockFromCommentPublic200Response>
481
+ rescue FastCommentsClient::ApiError => e
482
+ puts "Error when calling DefaultApi->block_user_from_comment_with_http_info: #{e}"
483
+ end
484
+ ```
485
+
486
+ ### Parameters
487
+
488
+ | Name | Type | Description | Notes |
489
+ | ---- | ---- | ----------- | ----- |
490
+ | **tenant_id** | **String** | | |
491
+ | **id** | **String** | | |
492
+ | **block_from_comment_params** | [**BlockFromCommentParams**](BlockFromCommentParams.md) | | |
493
+ | **user_id** | **String** | | [optional] |
494
+ | **anon_user_id** | **String** | | [optional] |
495
+
496
+ ### Return type
497
+
498
+ [**BlockFromCommentPublic200Response**](BlockFromCommentPublic200Response.md)
499
+
500
+ ### Authorization
501
+
502
+ [api_key](../README.md#api_key)
503
+
504
+ ### HTTP request headers
505
+
506
+ - **Content-Type**: application/json
507
+ - **Accept**: application/json
508
+
509
+
510
+ ## bulk_aggregate_question_results
511
+
512
+ > <BulkAggregateQuestionResults200Response> bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
513
+
514
+
515
+
516
+ ### Examples
517
+
518
+ ```ruby
519
+ require 'time'
520
+ require 'fastcomments-client'
521
+ # setup authorization
522
+ FastCommentsClient.configure do |config|
523
+ # Configure API key authorization: api_key
524
+ config.api_key['x-api-key'] = 'YOUR API KEY'
525
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
526
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
527
+ end
528
+
529
+ api_instance = FastCommentsClient::DefaultApi.new
530
+ tenant_id = 'tenant_id_example' # String |
531
+ bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest |
532
+ opts = {
533
+ force_recalculate: true # Boolean |
534
+ }
535
+
536
+ begin
537
+
538
+ result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
539
+ p result
540
+ rescue FastCommentsClient::ApiError => e
541
+ puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
542
+ end
543
+ ```
544
+
545
+ #### Using the bulk_aggregate_question_results_with_http_info variant
546
+
547
+ This returns an Array which contains the response data, status code and headers.
548
+
549
+ > <Array(<BulkAggregateQuestionResults200Response>, Integer, Hash)> bulk_aggregate_question_results_with_http_info(tenant_id, bulk_aggregate_question_results_request, opts)
550
+
551
+ ```ruby
552
+ begin
553
+
554
+ data, status_code, headers = api_instance.bulk_aggregate_question_results_with_http_info(tenant_id, bulk_aggregate_question_results_request, opts)
555
+ p status_code # => 2xx
556
+ p headers # => { ... }
557
+ p data # => <BulkAggregateQuestionResults200Response>
558
+ rescue FastCommentsClient::ApiError => e
559
+ puts "Error when calling DefaultApi->bulk_aggregate_question_results_with_http_info: #{e}"
560
+ end
561
+ ```
562
+
563
+ ### Parameters
564
+
565
+ | Name | Type | Description | Notes |
566
+ | ---- | ---- | ----------- | ----- |
567
+ | **tenant_id** | **String** | | |
568
+ | **bulk_aggregate_question_results_request** | [**BulkAggregateQuestionResultsRequest**](BulkAggregateQuestionResultsRequest.md) | | |
569
+ | **force_recalculate** | **Boolean** | | [optional] |
570
+
571
+ ### Return type
572
+
573
+ [**BulkAggregateQuestionResults200Response**](BulkAggregateQuestionResults200Response.md)
574
+
575
+ ### Authorization
576
+
577
+ [api_key](../README.md#api_key)
578
+
579
+ ### HTTP request headers
580
+
581
+ - **Content-Type**: application/json
582
+ - **Accept**: application/json
583
+
584
+
585
+ ## combine_comments_with_question_results
586
+
587
+ > <CombineCommentsWithQuestionResults200Response> combine_comments_with_question_results(tenant_id, opts)
588
+
589
+
590
+
591
+ ### Examples
592
+
593
+ ```ruby
594
+ require 'time'
595
+ require 'fastcomments-client'
596
+ # setup authorization
597
+ FastCommentsClient.configure do |config|
598
+ # Configure API key authorization: api_key
599
+ config.api_key['x-api-key'] = 'YOUR API KEY'
600
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
601
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
602
+ end
603
+
604
+ api_instance = FastCommentsClient::DefaultApi.new
605
+ tenant_id = 'tenant_id_example' # String |
606
+ opts = {
607
+ question_id: 'question_id_example', # String |
608
+ question_ids: ['inner_example'], # Array<String> |
609
+ url_id: 'url_id_example', # String |
610
+ start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
611
+ force_recalculate: true, # Boolean |
612
+ min_value: 1.2, # Float |
613
+ max_value: 1.2, # Float |
614
+ limit: 1.2 # Float |
615
+ }
616
+
617
+ begin
618
+
619
+ result = api_instance.combine_comments_with_question_results(tenant_id, opts)
620
+ p result
621
+ rescue FastCommentsClient::ApiError => e
622
+ puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
623
+ end
624
+ ```
625
+
626
+ #### Using the combine_comments_with_question_results_with_http_info variant
627
+
628
+ This returns an Array which contains the response data, status code and headers.
629
+
630
+ > <Array(<CombineCommentsWithQuestionResults200Response>, Integer, Hash)> combine_comments_with_question_results_with_http_info(tenant_id, opts)
631
+
632
+ ```ruby
633
+ begin
634
+
635
+ data, status_code, headers = api_instance.combine_comments_with_question_results_with_http_info(tenant_id, opts)
636
+ p status_code # => 2xx
637
+ p headers # => { ... }
638
+ p data # => <CombineCommentsWithQuestionResults200Response>
639
+ rescue FastCommentsClient::ApiError => e
640
+ puts "Error when calling DefaultApi->combine_comments_with_question_results_with_http_info: #{e}"
641
+ end
642
+ ```
643
+
644
+ ### Parameters
645
+
646
+ | Name | Type | Description | Notes |
647
+ | ---- | ---- | ----------- | ----- |
648
+ | **tenant_id** | **String** | | |
649
+ | **question_id** | **String** | | [optional] |
650
+ | **question_ids** | [**Array&lt;String&gt;**](String.md) | | [optional] |
651
+ | **url_id** | **String** | | [optional] |
652
+ | **start_date** | **Time** | | [optional] |
653
+ | **force_recalculate** | **Boolean** | | [optional] |
654
+ | **min_value** | **Float** | | [optional] |
655
+ | **max_value** | **Float** | | [optional] |
656
+ | **limit** | **Float** | | [optional] |
657
+
658
+ ### Return type
659
+
660
+ [**CombineCommentsWithQuestionResults200Response**](CombineCommentsWithQuestionResults200Response.md)
661
+
662
+ ### Authorization
663
+
664
+ [api_key](../README.md#api_key)
665
+
666
+ ### HTTP request headers
667
+
668
+ - **Content-Type**: Not defined
669
+ - **Accept**: application/json
670
+
671
+
672
+ ## create_feed_post
673
+
674
+ > <CreateFeedPost200Response> create_feed_post(tenant_id, create_feed_post_params, opts)
675
+
676
+
677
+
678
+ ### Examples
679
+
680
+ ```ruby
681
+ require 'time'
682
+ require 'fastcomments-client'
683
+ # setup authorization
684
+ FastCommentsClient.configure do |config|
685
+ # Configure API key authorization: api_key
686
+ config.api_key['x-api-key'] = 'YOUR API KEY'
687
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
688
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
689
+ end
690
+
691
+ api_instance = FastCommentsClient::DefaultApi.new
692
+ tenant_id = 'tenant_id_example' # String |
693
+ create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
694
+ opts = {
695
+ broadcast_id: 'broadcast_id_example', # String |
696
+ is_live: true, # Boolean |
697
+ do_spam_check: true, # Boolean |
698
+ skip_dup_check: true # Boolean |
699
+ }
700
+
701
+ begin
702
+
703
+ result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
704
+ p result
705
+ rescue FastCommentsClient::ApiError => e
706
+ puts "Error when calling DefaultApi->create_feed_post: #{e}"
707
+ end
708
+ ```
709
+
710
+ #### Using the create_feed_post_with_http_info variant
711
+
712
+ This returns an Array which contains the response data, status code and headers.
713
+
714
+ > <Array(<CreateFeedPost200Response>, Integer, Hash)> create_feed_post_with_http_info(tenant_id, create_feed_post_params, opts)
715
+
716
+ ```ruby
717
+ begin
718
+
719
+ data, status_code, headers = api_instance.create_feed_post_with_http_info(tenant_id, create_feed_post_params, opts)
720
+ p status_code # => 2xx
721
+ p headers # => { ... }
722
+ p data # => <CreateFeedPost200Response>
723
+ rescue FastCommentsClient::ApiError => e
724
+ puts "Error when calling DefaultApi->create_feed_post_with_http_info: #{e}"
725
+ end
726
+ ```
727
+
728
+ ### Parameters
729
+
730
+ | Name | Type | Description | Notes |
731
+ | ---- | ---- | ----------- | ----- |
732
+ | **tenant_id** | **String** | | |
733
+ | **create_feed_post_params** | [**CreateFeedPostParams**](CreateFeedPostParams.md) | | |
734
+ | **broadcast_id** | **String** | | [optional] |
735
+ | **is_live** | **Boolean** | | [optional] |
736
+ | **do_spam_check** | **Boolean** | | [optional] |
737
+ | **skip_dup_check** | **Boolean** | | [optional] |
738
+
739
+ ### Return type
740
+
741
+ [**CreateFeedPost200Response**](CreateFeedPost200Response.md)
742
+
743
+ ### Authorization
744
+
745
+ [api_key](../README.md#api_key)
746
+
747
+ ### HTTP request headers
748
+
749
+ - **Content-Type**: application/json
750
+ - **Accept**: application/json
751
+
752
+
753
+ ## create_subscription
754
+
755
+ > <CreateSubscriptionAPIResponse> create_subscription(tenant_id, create_api_user_subscription_data)
756
+
757
+
758
+
759
+ ### Examples
760
+
761
+ ```ruby
762
+ require 'time'
763
+ require 'fastcomments-client'
764
+ # setup authorization
765
+ FastCommentsClient.configure do |config|
766
+ # Configure API key authorization: api_key
767
+ config.api_key['x-api-key'] = 'YOUR API KEY'
768
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
769
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
770
+ end
771
+
772
+ api_instance = FastCommentsClient::DefaultApi.new
773
+ tenant_id = 'tenant_id_example' # String |
774
+ create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData |
775
+
776
+ begin
777
+
778
+ result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
779
+ p result
780
+ rescue FastCommentsClient::ApiError => e
781
+ puts "Error when calling DefaultApi->create_subscription: #{e}"
782
+ end
783
+ ```
784
+
785
+ #### Using the create_subscription_with_http_info variant
786
+
787
+ This returns an Array which contains the response data, status code and headers.
788
+
789
+ > <Array(<CreateSubscriptionAPIResponse>, Integer, Hash)> create_subscription_with_http_info(tenant_id, create_api_user_subscription_data)
790
+
791
+ ```ruby
792
+ begin
793
+
794
+ data, status_code, headers = api_instance.create_subscription_with_http_info(tenant_id, create_api_user_subscription_data)
795
+ p status_code # => 2xx
796
+ p headers # => { ... }
797
+ p data # => <CreateSubscriptionAPIResponse>
798
+ rescue FastCommentsClient::ApiError => e
799
+ puts "Error when calling DefaultApi->create_subscription_with_http_info: #{e}"
800
+ end
801
+ ```
802
+
803
+ ### Parameters
804
+
805
+ | Name | Type | Description | Notes |
806
+ | ---- | ---- | ----------- | ----- |
807
+ | **tenant_id** | **String** | | |
808
+ | **create_api_user_subscription_data** | [**CreateAPIUserSubscriptionData**](CreateAPIUserSubscriptionData.md) | | |
809
+
810
+ ### Return type
811
+
812
+ [**CreateSubscriptionAPIResponse**](CreateSubscriptionAPIResponse.md)
813
+
814
+ ### Authorization
815
+
816
+ [api_key](../README.md#api_key)
817
+
818
+ ### HTTP request headers
819
+
820
+ - **Content-Type**: application/json
821
+ - **Accept**: application/json
822
+
823
+
824
+ ## create_user_badge
825
+
826
+ > <CreateUserBadge200Response> create_user_badge(tenant_id, create_user_badge_params)
827
+
828
+
829
+
830
+ ### Examples
831
+
832
+ ```ruby
833
+ require 'time'
834
+ require 'fastcomments-client'
835
+ # setup authorization
836
+ FastCommentsClient.configure do |config|
837
+ # Configure API key authorization: api_key
838
+ config.api_key['x-api-key'] = 'YOUR API KEY'
839
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
840
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
841
+ end
842
+
843
+ api_instance = FastCommentsClient::DefaultApi.new
844
+ tenant_id = 'tenant_id_example' # String |
845
+ create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams |
846
+
847
+ begin
848
+
849
+ result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
850
+ p result
851
+ rescue FastCommentsClient::ApiError => e
852
+ puts "Error when calling DefaultApi->create_user_badge: #{e}"
853
+ end
854
+ ```
855
+
856
+ #### Using the create_user_badge_with_http_info variant
857
+
858
+ This returns an Array which contains the response data, status code and headers.
859
+
860
+ > <Array(<CreateUserBadge200Response>, Integer, Hash)> create_user_badge_with_http_info(tenant_id, create_user_badge_params)
861
+
862
+ ```ruby
863
+ begin
864
+
865
+ data, status_code, headers = api_instance.create_user_badge_with_http_info(tenant_id, create_user_badge_params)
866
+ p status_code # => 2xx
867
+ p headers # => { ... }
868
+ p data # => <CreateUserBadge200Response>
869
+ rescue FastCommentsClient::ApiError => e
870
+ puts "Error when calling DefaultApi->create_user_badge_with_http_info: #{e}"
871
+ end
872
+ ```
873
+
874
+ ### Parameters
875
+
876
+ | Name | Type | Description | Notes |
877
+ | ---- | ---- | ----------- | ----- |
878
+ | **tenant_id** | **String** | | |
879
+ | **create_user_badge_params** | [**CreateUserBadgeParams**](CreateUserBadgeParams.md) | | |
880
+
881
+ ### Return type
882
+
883
+ [**CreateUserBadge200Response**](CreateUserBadge200Response.md)
884
+
885
+ ### Authorization
886
+
887
+ [api_key](../README.md#api_key)
888
+
889
+ ### HTTP request headers
890
+
891
+ - **Content-Type**: application/json
892
+ - **Accept**: application/json
893
+
894
+
895
+ ## delete_comment
896
+
897
+ > <DeleteComment200Response> delete_comment(tenant_id, id, opts)
898
+
899
+
900
+
901
+ ### Examples
902
+
903
+ ```ruby
904
+ require 'time'
905
+ require 'fastcomments-client'
906
+ # setup authorization
907
+ FastCommentsClient.configure do |config|
908
+ # Configure API key authorization: api_key
909
+ config.api_key['x-api-key'] = 'YOUR API KEY'
910
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
911
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
912
+ end
913
+
914
+ api_instance = FastCommentsClient::DefaultApi.new
915
+ tenant_id = 'tenant_id_example' # String |
916
+ id = 'id_example' # String |
917
+ opts = {
918
+ context_user_id: 'context_user_id_example', # String |
919
+ is_live: true # Boolean |
920
+ }
921
+
922
+ begin
923
+
924
+ result = api_instance.delete_comment(tenant_id, id, opts)
925
+ p result
926
+ rescue FastCommentsClient::ApiError => e
927
+ puts "Error when calling DefaultApi->delete_comment: #{e}"
928
+ end
929
+ ```
930
+
931
+ #### Using the delete_comment_with_http_info variant
932
+
933
+ This returns an Array which contains the response data, status code and headers.
934
+
935
+ > <Array(<DeleteComment200Response>, Integer, Hash)> delete_comment_with_http_info(tenant_id, id, opts)
936
+
937
+ ```ruby
938
+ begin
939
+
940
+ data, status_code, headers = api_instance.delete_comment_with_http_info(tenant_id, id, opts)
941
+ p status_code # => 2xx
942
+ p headers # => { ... }
943
+ p data # => <DeleteComment200Response>
944
+ rescue FastCommentsClient::ApiError => e
945
+ puts "Error when calling DefaultApi->delete_comment_with_http_info: #{e}"
946
+ end
947
+ ```
948
+
949
+ ### Parameters
950
+
951
+ | Name | Type | Description | Notes |
952
+ | ---- | ---- | ----------- | ----- |
953
+ | **tenant_id** | **String** | | |
954
+ | **id** | **String** | | |
955
+ | **context_user_id** | **String** | | [optional] |
956
+ | **is_live** | **Boolean** | | [optional] |
957
+
958
+ ### Return type
959
+
960
+ [**DeleteComment200Response**](DeleteComment200Response.md)
961
+
962
+ ### Authorization
963
+
964
+ [api_key](../README.md#api_key)
965
+
966
+ ### HTTP request headers
967
+
968
+ - **Content-Type**: Not defined
969
+ - **Accept**: application/json
970
+
971
+
972
+ ## delete_domain_config
973
+
974
+ > <DeleteDomainConfig200Response> delete_domain_config(tenant_id, domain)
975
+
976
+
977
+
978
+ ### Examples
979
+
980
+ ```ruby
981
+ require 'time'
982
+ require 'fastcomments-client'
983
+ # setup authorization
984
+ FastCommentsClient.configure do |config|
985
+ # Configure API key authorization: api_key
986
+ config.api_key['x-api-key'] = 'YOUR API KEY'
987
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
988
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
989
+ end
990
+
991
+ api_instance = FastCommentsClient::DefaultApi.new
992
+ tenant_id = 'tenant_id_example' # String |
993
+ domain = 'domain_example' # String |
994
+
995
+ begin
996
+
997
+ result = api_instance.delete_domain_config(tenant_id, domain)
998
+ p result
999
+ rescue FastCommentsClient::ApiError => e
1000
+ puts "Error when calling DefaultApi->delete_domain_config: #{e}"
1001
+ end
1002
+ ```
1003
+
1004
+ #### Using the delete_domain_config_with_http_info variant
1005
+
1006
+ This returns an Array which contains the response data, status code and headers.
1007
+
1008
+ > <Array(<DeleteDomainConfig200Response>, Integer, Hash)> delete_domain_config_with_http_info(tenant_id, domain)
1009
+
1010
+ ```ruby
1011
+ begin
1012
+
1013
+ data, status_code, headers = api_instance.delete_domain_config_with_http_info(tenant_id, domain)
1014
+ p status_code # => 2xx
1015
+ p headers # => { ... }
1016
+ p data # => <DeleteDomainConfig200Response>
1017
+ rescue FastCommentsClient::ApiError => e
1018
+ puts "Error when calling DefaultApi->delete_domain_config_with_http_info: #{e}"
1019
+ end
1020
+ ```
1021
+
1022
+ ### Parameters
1023
+
1024
+ | Name | Type | Description | Notes |
1025
+ | ---- | ---- | ----------- | ----- |
1026
+ | **tenant_id** | **String** | | |
1027
+ | **domain** | **String** | | |
1028
+
1029
+ ### Return type
1030
+
1031
+ [**DeleteDomainConfig200Response**](DeleteDomainConfig200Response.md)
1032
+
1033
+ ### Authorization
1034
+
1035
+ [api_key](../README.md#api_key)
1036
+
1037
+ ### HTTP request headers
1038
+
1039
+ - **Content-Type**: Not defined
1040
+ - **Accept**: application/json
1041
+
1042
+
1043
+ ## delete_page
1044
+
1045
+ > <DeletePageAPIResponse> delete_page(tenant_id, id)
1046
+
1047
+
1048
+
1049
+ ### Examples
1050
+
1051
+ ```ruby
1052
+ require 'time'
1053
+ require 'fastcomments-client'
1054
+ # setup authorization
1055
+ FastCommentsClient.configure do |config|
1056
+ # Configure API key authorization: api_key
1057
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1058
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1059
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1060
+ end
1061
+
1062
+ api_instance = FastCommentsClient::DefaultApi.new
1063
+ tenant_id = 'tenant_id_example' # String |
1064
+ id = 'id_example' # String |
1065
+
1066
+ begin
1067
+
1068
+ result = api_instance.delete_page(tenant_id, id)
1069
+ p result
1070
+ rescue FastCommentsClient::ApiError => e
1071
+ puts "Error when calling DefaultApi->delete_page: #{e}"
1072
+ end
1073
+ ```
1074
+
1075
+ #### Using the delete_page_with_http_info variant
1076
+
1077
+ This returns an Array which contains the response data, status code and headers.
1078
+
1079
+ > <Array(<DeletePageAPIResponse>, Integer, Hash)> delete_page_with_http_info(tenant_id, id)
1080
+
1081
+ ```ruby
1082
+ begin
1083
+
1084
+ data, status_code, headers = api_instance.delete_page_with_http_info(tenant_id, id)
1085
+ p status_code # => 2xx
1086
+ p headers # => { ... }
1087
+ p data # => <DeletePageAPIResponse>
1088
+ rescue FastCommentsClient::ApiError => e
1089
+ puts "Error when calling DefaultApi->delete_page_with_http_info: #{e}"
1090
+ end
1091
+ ```
1092
+
1093
+ ### Parameters
1094
+
1095
+ | Name | Type | Description | Notes |
1096
+ | ---- | ---- | ----------- | ----- |
1097
+ | **tenant_id** | **String** | | |
1098
+ | **id** | **String** | | |
1099
+
1100
+ ### Return type
1101
+
1102
+ [**DeletePageAPIResponse**](DeletePageAPIResponse.md)
1103
+
1104
+ ### Authorization
1105
+
1106
+ [api_key](../README.md#api_key)
1107
+
1108
+ ### HTTP request headers
1109
+
1110
+ - **Content-Type**: Not defined
1111
+ - **Accept**: application/json
1112
+
1113
+
1114
+ ## delete_sso_user
1115
+
1116
+ > <DeleteSSOUserAPIResponse> delete_sso_user(tenant_id, id, opts)
1117
+
1118
+
1119
+
1120
+ ### Examples
1121
+
1122
+ ```ruby
1123
+ require 'time'
1124
+ require 'fastcomments-client'
1125
+ # setup authorization
1126
+ FastCommentsClient.configure do |config|
1127
+ # Configure API key authorization: api_key
1128
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1129
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1130
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1131
+ end
1132
+
1133
+ api_instance = FastCommentsClient::DefaultApi.new
1134
+ tenant_id = 'tenant_id_example' # String |
1135
+ id = 'id_example' # String |
1136
+ opts = {
1137
+ delete_comments: true, # Boolean |
1138
+ comment_delete_mode: 'comment_delete_mode_example' # String |
1139
+ }
1140
+
1141
+ begin
1142
+
1143
+ result = api_instance.delete_sso_user(tenant_id, id, opts)
1144
+ p result
1145
+ rescue FastCommentsClient::ApiError => e
1146
+ puts "Error when calling DefaultApi->delete_sso_user: #{e}"
1147
+ end
1148
+ ```
1149
+
1150
+ #### Using the delete_sso_user_with_http_info variant
1151
+
1152
+ This returns an Array which contains the response data, status code and headers.
1153
+
1154
+ > <Array(<DeleteSSOUserAPIResponse>, Integer, Hash)> delete_sso_user_with_http_info(tenant_id, id, opts)
1155
+
1156
+ ```ruby
1157
+ begin
1158
+
1159
+ data, status_code, headers = api_instance.delete_sso_user_with_http_info(tenant_id, id, opts)
1160
+ p status_code # => 2xx
1161
+ p headers # => { ... }
1162
+ p data # => <DeleteSSOUserAPIResponse>
1163
+ rescue FastCommentsClient::ApiError => e
1164
+ puts "Error when calling DefaultApi->delete_sso_user_with_http_info: #{e}"
1165
+ end
1166
+ ```
1167
+
1168
+ ### Parameters
1169
+
1170
+ | Name | Type | Description | Notes |
1171
+ | ---- | ---- | ----------- | ----- |
1172
+ | **tenant_id** | **String** | | |
1173
+ | **id** | **String** | | |
1174
+ | **delete_comments** | **Boolean** | | [optional] |
1175
+ | **comment_delete_mode** | **String** | | [optional] |
1176
+
1177
+ ### Return type
1178
+
1179
+ [**DeleteSSOUserAPIResponse**](DeleteSSOUserAPIResponse.md)
1180
+
1181
+ ### Authorization
1182
+
1183
+ [api_key](../README.md#api_key)
1184
+
1185
+ ### HTTP request headers
1186
+
1187
+ - **Content-Type**: Not defined
1188
+ - **Accept**: application/json
1189
+
1190
+
1191
+ ## delete_subscription
1192
+
1193
+ > <DeleteSubscriptionAPIResponse> delete_subscription(tenant_id, id, opts)
1194
+
1195
+
1196
+
1197
+ ### Examples
1198
+
1199
+ ```ruby
1200
+ require 'time'
1201
+ require 'fastcomments-client'
1202
+ # setup authorization
1203
+ FastCommentsClient.configure do |config|
1204
+ # Configure API key authorization: api_key
1205
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1206
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1207
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1208
+ end
1209
+
1210
+ api_instance = FastCommentsClient::DefaultApi.new
1211
+ tenant_id = 'tenant_id_example' # String |
1212
+ id = 'id_example' # String |
1213
+ opts = {
1214
+ user_id: 'user_id_example' # String |
1215
+ }
1216
+
1217
+ begin
1218
+
1219
+ result = api_instance.delete_subscription(tenant_id, id, opts)
1220
+ p result
1221
+ rescue FastCommentsClient::ApiError => e
1222
+ puts "Error when calling DefaultApi->delete_subscription: #{e}"
1223
+ end
1224
+ ```
1225
+
1226
+ #### Using the delete_subscription_with_http_info variant
1227
+
1228
+ This returns an Array which contains the response data, status code and headers.
1229
+
1230
+ > <Array(<DeleteSubscriptionAPIResponse>, Integer, Hash)> delete_subscription_with_http_info(tenant_id, id, opts)
1231
+
1232
+ ```ruby
1233
+ begin
1234
+
1235
+ data, status_code, headers = api_instance.delete_subscription_with_http_info(tenant_id, id, opts)
1236
+ p status_code # => 2xx
1237
+ p headers # => { ... }
1238
+ p data # => <DeleteSubscriptionAPIResponse>
1239
+ rescue FastCommentsClient::ApiError => e
1240
+ puts "Error when calling DefaultApi->delete_subscription_with_http_info: #{e}"
1241
+ end
1242
+ ```
1243
+
1244
+ ### Parameters
1245
+
1246
+ | Name | Type | Description | Notes |
1247
+ | ---- | ---- | ----------- | ----- |
1248
+ | **tenant_id** | **String** | | |
1249
+ | **id** | **String** | | |
1250
+ | **user_id** | **String** | | [optional] |
1251
+
1252
+ ### Return type
1253
+
1254
+ [**DeleteSubscriptionAPIResponse**](DeleteSubscriptionAPIResponse.md)
1255
+
1256
+ ### Authorization
1257
+
1258
+ [api_key](../README.md#api_key)
1259
+
1260
+ ### HTTP request headers
1261
+
1262
+ - **Content-Type**: Not defined
1263
+ - **Accept**: application/json
1264
+
1265
+
1266
+ ## delete_user_badge
1267
+
1268
+ > <UpdateUserBadge200Response> delete_user_badge(tenant_id, id)
1269
+
1270
+
1271
+
1272
+ ### Examples
1273
+
1274
+ ```ruby
1275
+ require 'time'
1276
+ require 'fastcomments-client'
1277
+ # setup authorization
1278
+ FastCommentsClient.configure do |config|
1279
+ # Configure API key authorization: api_key
1280
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1281
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1282
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1283
+ end
1284
+
1285
+ api_instance = FastCommentsClient::DefaultApi.new
1286
+ tenant_id = 'tenant_id_example' # String |
1287
+ id = 'id_example' # String |
1288
+
1289
+ begin
1290
+
1291
+ result = api_instance.delete_user_badge(tenant_id, id)
1292
+ p result
1293
+ rescue FastCommentsClient::ApiError => e
1294
+ puts "Error when calling DefaultApi->delete_user_badge: #{e}"
1295
+ end
1296
+ ```
1297
+
1298
+ #### Using the delete_user_badge_with_http_info variant
1299
+
1300
+ This returns an Array which contains the response data, status code and headers.
1301
+
1302
+ > <Array(<UpdateUserBadge200Response>, Integer, Hash)> delete_user_badge_with_http_info(tenant_id, id)
1303
+
1304
+ ```ruby
1305
+ begin
1306
+
1307
+ data, status_code, headers = api_instance.delete_user_badge_with_http_info(tenant_id, id)
1308
+ p status_code # => 2xx
1309
+ p headers # => { ... }
1310
+ p data # => <UpdateUserBadge200Response>
1311
+ rescue FastCommentsClient::ApiError => e
1312
+ puts "Error when calling DefaultApi->delete_user_badge_with_http_info: #{e}"
1313
+ end
1314
+ ```
1315
+
1316
+ ### Parameters
1317
+
1318
+ | Name | Type | Description | Notes |
1319
+ | ---- | ---- | ----------- | ----- |
1320
+ | **tenant_id** | **String** | | |
1321
+ | **id** | **String** | | |
1322
+
1323
+ ### Return type
1324
+
1325
+ [**UpdateUserBadge200Response**](UpdateUserBadge200Response.md)
1326
+
1327
+ ### Authorization
1328
+
1329
+ [api_key](../README.md#api_key)
1330
+
1331
+ ### HTTP request headers
1332
+
1333
+ - **Content-Type**: Not defined
1334
+ - **Accept**: application/json
1335
+
1336
+
1337
+ ## flag_comment
1338
+
1339
+ > <FlagComment200Response> flag_comment(tenant_id, id, opts)
1340
+
1341
+
1342
+
1343
+ ### Examples
1344
+
1345
+ ```ruby
1346
+ require 'time'
1347
+ require 'fastcomments-client'
1348
+ # setup authorization
1349
+ FastCommentsClient.configure do |config|
1350
+ # Configure API key authorization: api_key
1351
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1352
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1353
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1354
+ end
1355
+
1356
+ api_instance = FastCommentsClient::DefaultApi.new
1357
+ tenant_id = 'tenant_id_example' # String |
1358
+ id = 'id_example' # String |
1359
+ opts = {
1360
+ user_id: 'user_id_example', # String |
1361
+ anon_user_id: 'anon_user_id_example' # String |
1362
+ }
1363
+
1364
+ begin
1365
+
1366
+ result = api_instance.flag_comment(tenant_id, id, opts)
1367
+ p result
1368
+ rescue FastCommentsClient::ApiError => e
1369
+ puts "Error when calling DefaultApi->flag_comment: #{e}"
1370
+ end
1371
+ ```
1372
+
1373
+ #### Using the flag_comment_with_http_info variant
1374
+
1375
+ This returns an Array which contains the response data, status code and headers.
1376
+
1377
+ > <Array(<FlagComment200Response>, Integer, Hash)> flag_comment_with_http_info(tenant_id, id, opts)
1378
+
1379
+ ```ruby
1380
+ begin
1381
+
1382
+ data, status_code, headers = api_instance.flag_comment_with_http_info(tenant_id, id, opts)
1383
+ p status_code # => 2xx
1384
+ p headers # => { ... }
1385
+ p data # => <FlagComment200Response>
1386
+ rescue FastCommentsClient::ApiError => e
1387
+ puts "Error when calling DefaultApi->flag_comment_with_http_info: #{e}"
1388
+ end
1389
+ ```
1390
+
1391
+ ### Parameters
1392
+
1393
+ | Name | Type | Description | Notes |
1394
+ | ---- | ---- | ----------- | ----- |
1395
+ | **tenant_id** | **String** | | |
1396
+ | **id** | **String** | | |
1397
+ | **user_id** | **String** | | [optional] |
1398
+ | **anon_user_id** | **String** | | [optional] |
1399
+
1400
+ ### Return type
1401
+
1402
+ [**FlagComment200Response**](FlagComment200Response.md)
1403
+
1404
+ ### Authorization
1405
+
1406
+ [api_key](../README.md#api_key)
1407
+
1408
+ ### HTTP request headers
1409
+
1410
+ - **Content-Type**: Not defined
1411
+ - **Accept**: application/json
1412
+
1413
+
1414
+ ## get_audit_logs
1415
+
1416
+ > <GetAuditLogs200Response> get_audit_logs(tenant_id, opts)
1417
+
1418
+
1419
+
1420
+ ### Examples
1421
+
1422
+ ```ruby
1423
+ require 'time'
1424
+ require 'fastcomments-client'
1425
+ # setup authorization
1426
+ FastCommentsClient.configure do |config|
1427
+ # Configure API key authorization: api_key
1428
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1429
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1430
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1431
+ end
1432
+
1433
+ api_instance = FastCommentsClient::DefaultApi.new
1434
+ tenant_id = 'tenant_id_example' # String |
1435
+ opts = {
1436
+ limit: 1.2, # Float |
1437
+ skip: 1.2, # Float |
1438
+ order: FastCommentsClient::SORTDIR::ASC, # SORTDIR |
1439
+ after: 1.2, # Float |
1440
+ before: 1.2 # Float |
1441
+ }
1442
+
1443
+ begin
1444
+
1445
+ result = api_instance.get_audit_logs(tenant_id, opts)
1446
+ p result
1447
+ rescue FastCommentsClient::ApiError => e
1448
+ puts "Error when calling DefaultApi->get_audit_logs: #{e}"
1449
+ end
1450
+ ```
1451
+
1452
+ #### Using the get_audit_logs_with_http_info variant
1453
+
1454
+ This returns an Array which contains the response data, status code and headers.
1455
+
1456
+ > <Array(<GetAuditLogs200Response>, Integer, Hash)> get_audit_logs_with_http_info(tenant_id, opts)
1457
+
1458
+ ```ruby
1459
+ begin
1460
+
1461
+ data, status_code, headers = api_instance.get_audit_logs_with_http_info(tenant_id, opts)
1462
+ p status_code # => 2xx
1463
+ p headers # => { ... }
1464
+ p data # => <GetAuditLogs200Response>
1465
+ rescue FastCommentsClient::ApiError => e
1466
+ puts "Error when calling DefaultApi->get_audit_logs_with_http_info: #{e}"
1467
+ end
1468
+ ```
1469
+
1470
+ ### Parameters
1471
+
1472
+ | Name | Type | Description | Notes |
1473
+ | ---- | ---- | ----------- | ----- |
1474
+ | **tenant_id** | **String** | | |
1475
+ | **limit** | **Float** | | [optional] |
1476
+ | **skip** | **Float** | | [optional] |
1477
+ | **order** | [**SORTDIR**](.md) | | [optional] |
1478
+ | **after** | **Float** | | [optional] |
1479
+ | **before** | **Float** | | [optional] |
1480
+
1481
+ ### Return type
1482
+
1483
+ [**GetAuditLogs200Response**](GetAuditLogs200Response.md)
1484
+
1485
+ ### Authorization
1486
+
1487
+ [api_key](../README.md#api_key)
1488
+
1489
+ ### HTTP request headers
1490
+
1491
+ - **Content-Type**: Not defined
1492
+ - **Accept**: application/json
1493
+
1494
+
1495
+ ## get_comment
1496
+
1497
+ > <GetComment200Response> get_comment(tenant_id, id)
1498
+
1499
+
1500
+
1501
+ ### Examples
1502
+
1503
+ ```ruby
1504
+ require 'time'
1505
+ require 'fastcomments-client'
1506
+ # setup authorization
1507
+ FastCommentsClient.configure do |config|
1508
+ # Configure API key authorization: api_key
1509
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1510
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1511
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1512
+ end
1513
+
1514
+ api_instance = FastCommentsClient::DefaultApi.new
1515
+ tenant_id = 'tenant_id_example' # String |
1516
+ id = 'id_example' # String |
1517
+
1518
+ begin
1519
+
1520
+ result = api_instance.get_comment(tenant_id, id)
1521
+ p result
1522
+ rescue FastCommentsClient::ApiError => e
1523
+ puts "Error when calling DefaultApi->get_comment: #{e}"
1524
+ end
1525
+ ```
1526
+
1527
+ #### Using the get_comment_with_http_info variant
1528
+
1529
+ This returns an Array which contains the response data, status code and headers.
1530
+
1531
+ > <Array(<GetComment200Response>, Integer, Hash)> get_comment_with_http_info(tenant_id, id)
1532
+
1533
+ ```ruby
1534
+ begin
1535
+
1536
+ data, status_code, headers = api_instance.get_comment_with_http_info(tenant_id, id)
1537
+ p status_code # => 2xx
1538
+ p headers # => { ... }
1539
+ p data # => <GetComment200Response>
1540
+ rescue FastCommentsClient::ApiError => e
1541
+ puts "Error when calling DefaultApi->get_comment_with_http_info: #{e}"
1542
+ end
1543
+ ```
1544
+
1545
+ ### Parameters
1546
+
1547
+ | Name | Type | Description | Notes |
1548
+ | ---- | ---- | ----------- | ----- |
1549
+ | **tenant_id** | **String** | | |
1550
+ | **id** | **String** | | |
1551
+
1552
+ ### Return type
1553
+
1554
+ [**GetComment200Response**](GetComment200Response.md)
1555
+
1556
+ ### Authorization
1557
+
1558
+ [api_key](../README.md#api_key)
1559
+
1560
+ ### HTTP request headers
1561
+
1562
+ - **Content-Type**: Not defined
1563
+ - **Accept**: application/json
1564
+
1565
+
1566
+ ## get_comments
1567
+
1568
+ > <GetComments200Response> get_comments(tenant_id, opts)
1569
+
1570
+
1571
+
1572
+ ### Examples
1573
+
1574
+ ```ruby
1575
+ require 'time'
1576
+ require 'fastcomments-client'
1577
+ # setup authorization
1578
+ FastCommentsClient.configure do |config|
1579
+ # Configure API key authorization: api_key
1580
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1581
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1582
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1583
+ end
1584
+
1585
+ api_instance = FastCommentsClient::DefaultApi.new
1586
+ tenant_id = 'tenant_id_example' # String |
1587
+ opts = {
1588
+ page: 56, # Integer |
1589
+ limit: 56, # Integer |
1590
+ skip: 56, # Integer |
1591
+ as_tree: true, # Boolean |
1592
+ skip_children: 56, # Integer |
1593
+ limit_children: 56, # Integer |
1594
+ max_tree_depth: 56, # Integer |
1595
+ url_id: 'url_id_example', # String |
1596
+ user_id: 'user_id_example', # String |
1597
+ anon_user_id: 'anon_user_id_example', # String |
1598
+ context_user_id: 'context_user_id_example', # String |
1599
+ hash_tag: 'hash_tag_example', # String |
1600
+ parent_id: 'parent_id_example', # String |
1601
+ direction: FastCommentsClient::SortDirections::OF # SortDirections |
1602
+ }
1603
+
1604
+ begin
1605
+
1606
+ result = api_instance.get_comments(tenant_id, opts)
1607
+ p result
1608
+ rescue FastCommentsClient::ApiError => e
1609
+ puts "Error when calling DefaultApi->get_comments: #{e}"
1610
+ end
1611
+ ```
1612
+
1613
+ #### Using the get_comments_with_http_info variant
1614
+
1615
+ This returns an Array which contains the response data, status code and headers.
1616
+
1617
+ > <Array(<GetComments200Response>, Integer, Hash)> get_comments_with_http_info(tenant_id, opts)
1618
+
1619
+ ```ruby
1620
+ begin
1621
+
1622
+ data, status_code, headers = api_instance.get_comments_with_http_info(tenant_id, opts)
1623
+ p status_code # => 2xx
1624
+ p headers # => { ... }
1625
+ p data # => <GetComments200Response>
1626
+ rescue FastCommentsClient::ApiError => e
1627
+ puts "Error when calling DefaultApi->get_comments_with_http_info: #{e}"
1628
+ end
1629
+ ```
1630
+
1631
+ ### Parameters
1632
+
1633
+ | Name | Type | Description | Notes |
1634
+ | ---- | ---- | ----------- | ----- |
1635
+ | **tenant_id** | **String** | | |
1636
+ | **page** | **Integer** | | [optional] |
1637
+ | **limit** | **Integer** | | [optional] |
1638
+ | **skip** | **Integer** | | [optional] |
1639
+ | **as_tree** | **Boolean** | | [optional] |
1640
+ | **skip_children** | **Integer** | | [optional] |
1641
+ | **limit_children** | **Integer** | | [optional] |
1642
+ | **max_tree_depth** | **Integer** | | [optional] |
1643
+ | **url_id** | **String** | | [optional] |
1644
+ | **user_id** | **String** | | [optional] |
1645
+ | **anon_user_id** | **String** | | [optional] |
1646
+ | **context_user_id** | **String** | | [optional] |
1647
+ | **hash_tag** | **String** | | [optional] |
1648
+ | **parent_id** | **String** | | [optional] |
1649
+ | **direction** | [**SortDirections**](.md) | | [optional] |
1650
+
1651
+ ### Return type
1652
+
1653
+ [**GetComments200Response**](GetComments200Response.md)
1654
+
1655
+ ### Authorization
1656
+
1657
+ [api_key](../README.md#api_key)
1658
+
1659
+ ### HTTP request headers
1660
+
1661
+ - **Content-Type**: Not defined
1662
+ - **Accept**: application/json
1663
+
1664
+
1665
+ ## get_domain_config
1666
+
1667
+ > <GetDomainConfig200Response> get_domain_config(tenant_id, domain)
1668
+
1669
+
1670
+
1671
+ ### Examples
1672
+
1673
+ ```ruby
1674
+ require 'time'
1675
+ require 'fastcomments-client'
1676
+ # setup authorization
1677
+ FastCommentsClient.configure do |config|
1678
+ # Configure API key authorization: api_key
1679
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1680
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1681
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1682
+ end
1683
+
1684
+ api_instance = FastCommentsClient::DefaultApi.new
1685
+ tenant_id = 'tenant_id_example' # String |
1686
+ domain = 'domain_example' # String |
1687
+
1688
+ begin
1689
+
1690
+ result = api_instance.get_domain_config(tenant_id, domain)
1691
+ p result
1692
+ rescue FastCommentsClient::ApiError => e
1693
+ puts "Error when calling DefaultApi->get_domain_config: #{e}"
1694
+ end
1695
+ ```
1696
+
1697
+ #### Using the get_domain_config_with_http_info variant
1698
+
1699
+ This returns an Array which contains the response data, status code and headers.
1700
+
1701
+ > <Array(<GetDomainConfig200Response>, Integer, Hash)> get_domain_config_with_http_info(tenant_id, domain)
1702
+
1703
+ ```ruby
1704
+ begin
1705
+
1706
+ data, status_code, headers = api_instance.get_domain_config_with_http_info(tenant_id, domain)
1707
+ p status_code # => 2xx
1708
+ p headers # => { ... }
1709
+ p data # => <GetDomainConfig200Response>
1710
+ rescue FastCommentsClient::ApiError => e
1711
+ puts "Error when calling DefaultApi->get_domain_config_with_http_info: #{e}"
1712
+ end
1713
+ ```
1714
+
1715
+ ### Parameters
1716
+
1717
+ | Name | Type | Description | Notes |
1718
+ | ---- | ---- | ----------- | ----- |
1719
+ | **tenant_id** | **String** | | |
1720
+ | **domain** | **String** | | |
1721
+
1722
+ ### Return type
1723
+
1724
+ [**GetDomainConfig200Response**](GetDomainConfig200Response.md)
1725
+
1726
+ ### Authorization
1727
+
1728
+ [api_key](../README.md#api_key)
1729
+
1730
+ ### HTTP request headers
1731
+
1732
+ - **Content-Type**: Not defined
1733
+ - **Accept**: application/json
1734
+
1735
+
1736
+ ## get_domain_configs
1737
+
1738
+ > <GetDomainConfigs200Response> get_domain_configs(tenant_id)
1739
+
1740
+
1741
+
1742
+ ### Examples
1743
+
1744
+ ```ruby
1745
+ require 'time'
1746
+ require 'fastcomments-client'
1747
+ # setup authorization
1748
+ FastCommentsClient.configure do |config|
1749
+ # Configure API key authorization: api_key
1750
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1751
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1752
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1753
+ end
1754
+
1755
+ api_instance = FastCommentsClient::DefaultApi.new
1756
+ tenant_id = 'tenant_id_example' # String |
1757
+
1758
+ begin
1759
+
1760
+ result = api_instance.get_domain_configs(tenant_id)
1761
+ p result
1762
+ rescue FastCommentsClient::ApiError => e
1763
+ puts "Error when calling DefaultApi->get_domain_configs: #{e}"
1764
+ end
1765
+ ```
1766
+
1767
+ #### Using the get_domain_configs_with_http_info variant
1768
+
1769
+ This returns an Array which contains the response data, status code and headers.
1770
+
1771
+ > <Array(<GetDomainConfigs200Response>, Integer, Hash)> get_domain_configs_with_http_info(tenant_id)
1772
+
1773
+ ```ruby
1774
+ begin
1775
+
1776
+ data, status_code, headers = api_instance.get_domain_configs_with_http_info(tenant_id)
1777
+ p status_code # => 2xx
1778
+ p headers # => { ... }
1779
+ p data # => <GetDomainConfigs200Response>
1780
+ rescue FastCommentsClient::ApiError => e
1781
+ puts "Error when calling DefaultApi->get_domain_configs_with_http_info: #{e}"
1782
+ end
1783
+ ```
1784
+
1785
+ ### Parameters
1786
+
1787
+ | Name | Type | Description | Notes |
1788
+ | ---- | ---- | ----------- | ----- |
1789
+ | **tenant_id** | **String** | | |
1790
+
1791
+ ### Return type
1792
+
1793
+ [**GetDomainConfigs200Response**](GetDomainConfigs200Response.md)
1794
+
1795
+ ### Authorization
1796
+
1797
+ [api_key](../README.md#api_key)
1798
+
1799
+ ### HTTP request headers
1800
+
1801
+ - **Content-Type**: Not defined
1802
+ - **Accept**: application/json
1803
+
1804
+
1805
+ ## get_feed_posts
1806
+
1807
+ > <GetFeedPosts200Response> get_feed_posts(tenant_id, opts)
1808
+
1809
+
1810
+
1811
+ req tenantId afterId
1812
+
1813
+ ### Examples
1814
+
1815
+ ```ruby
1816
+ require 'time'
1817
+ require 'fastcomments-client'
1818
+ # setup authorization
1819
+ FastCommentsClient.configure do |config|
1820
+ # Configure API key authorization: api_key
1821
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1822
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1823
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1824
+ end
1825
+
1826
+ api_instance = FastCommentsClient::DefaultApi.new
1827
+ tenant_id = 'tenant_id_example' # String |
1828
+ opts = {
1829
+ after_id: 'after_id_example', # String |
1830
+ limit: 56, # Integer |
1831
+ tags: ['inner_example'] # Array<String> |
1832
+ }
1833
+
1834
+ begin
1835
+
1836
+ result = api_instance.get_feed_posts(tenant_id, opts)
1837
+ p result
1838
+ rescue FastCommentsClient::ApiError => e
1839
+ puts "Error when calling DefaultApi->get_feed_posts: #{e}"
1840
+ end
1841
+ ```
1842
+
1843
+ #### Using the get_feed_posts_with_http_info variant
1844
+
1845
+ This returns an Array which contains the response data, status code and headers.
1846
+
1847
+ > <Array(<GetFeedPosts200Response>, Integer, Hash)> get_feed_posts_with_http_info(tenant_id, opts)
1848
+
1849
+ ```ruby
1850
+ begin
1851
+
1852
+ data, status_code, headers = api_instance.get_feed_posts_with_http_info(tenant_id, opts)
1853
+ p status_code # => 2xx
1854
+ p headers # => { ... }
1855
+ p data # => <GetFeedPosts200Response>
1856
+ rescue FastCommentsClient::ApiError => e
1857
+ puts "Error when calling DefaultApi->get_feed_posts_with_http_info: #{e}"
1858
+ end
1859
+ ```
1860
+
1861
+ ### Parameters
1862
+
1863
+ | Name | Type | Description | Notes |
1864
+ | ---- | ---- | ----------- | ----- |
1865
+ | **tenant_id** | **String** | | |
1866
+ | **after_id** | **String** | | [optional] |
1867
+ | **limit** | **Integer** | | [optional] |
1868
+ | **tags** | [**Array&lt;String&gt;**](String.md) | | [optional] |
1869
+
1870
+ ### Return type
1871
+
1872
+ [**GetFeedPosts200Response**](GetFeedPosts200Response.md)
1873
+
1874
+ ### Authorization
1875
+
1876
+ [api_key](../README.md#api_key)
1877
+
1878
+ ### HTTP request headers
1879
+
1880
+ - **Content-Type**: Not defined
1881
+ - **Accept**: application/json
1882
+
1883
+
1884
+ ## get_page_by_urlid
1885
+
1886
+ > <GetPageByURLIdAPIResponse> get_page_by_urlid(tenant_id, url_id)
1887
+
1888
+
1889
+
1890
+ ### Examples
1891
+
1892
+ ```ruby
1893
+ require 'time'
1894
+ require 'fastcomments-client'
1895
+ # setup authorization
1896
+ FastCommentsClient.configure do |config|
1897
+ # Configure API key authorization: api_key
1898
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1899
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1900
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1901
+ end
1902
+
1903
+ api_instance = FastCommentsClient::DefaultApi.new
1904
+ tenant_id = 'tenant_id_example' # String |
1905
+ url_id = 'url_id_example' # String |
1906
+
1907
+ begin
1908
+
1909
+ result = api_instance.get_page_by_urlid(tenant_id, url_id)
1910
+ p result
1911
+ rescue FastCommentsClient::ApiError => e
1912
+ puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
1913
+ end
1914
+ ```
1915
+
1916
+ #### Using the get_page_by_urlid_with_http_info variant
1917
+
1918
+ This returns an Array which contains the response data, status code and headers.
1919
+
1920
+ > <Array(<GetPageByURLIdAPIResponse>, Integer, Hash)> get_page_by_urlid_with_http_info(tenant_id, url_id)
1921
+
1922
+ ```ruby
1923
+ begin
1924
+
1925
+ data, status_code, headers = api_instance.get_page_by_urlid_with_http_info(tenant_id, url_id)
1926
+ p status_code # => 2xx
1927
+ p headers # => { ... }
1928
+ p data # => <GetPageByURLIdAPIResponse>
1929
+ rescue FastCommentsClient::ApiError => e
1930
+ puts "Error when calling DefaultApi->get_page_by_urlid_with_http_info: #{e}"
1931
+ end
1932
+ ```
1933
+
1934
+ ### Parameters
1935
+
1936
+ | Name | Type | Description | Notes |
1937
+ | ---- | ---- | ----------- | ----- |
1938
+ | **tenant_id** | **String** | | |
1939
+ | **url_id** | **String** | | |
1940
+
1941
+ ### Return type
1942
+
1943
+ [**GetPageByURLIdAPIResponse**](GetPageByURLIdAPIResponse.md)
1944
+
1945
+ ### Authorization
1946
+
1947
+ [api_key](../README.md#api_key)
1948
+
1949
+ ### HTTP request headers
1950
+
1951
+ - **Content-Type**: Not defined
1952
+ - **Accept**: application/json
1953
+
1954
+
1955
+ ## get_pages
1956
+
1957
+ > <GetPagesAPIResponse> get_pages(tenant_id)
1958
+
1959
+
1960
+
1961
+ ### Examples
1962
+
1963
+ ```ruby
1964
+ require 'time'
1965
+ require 'fastcomments-client'
1966
+ # setup authorization
1967
+ FastCommentsClient.configure do |config|
1968
+ # Configure API key authorization: api_key
1969
+ config.api_key['x-api-key'] = 'YOUR API KEY'
1970
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1971
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
1972
+ end
1973
+
1974
+ api_instance = FastCommentsClient::DefaultApi.new
1975
+ tenant_id = 'tenant_id_example' # String |
1976
+
1977
+ begin
1978
+
1979
+ result = api_instance.get_pages(tenant_id)
1980
+ p result
1981
+ rescue FastCommentsClient::ApiError => e
1982
+ puts "Error when calling DefaultApi->get_pages: #{e}"
1983
+ end
1984
+ ```
1985
+
1986
+ #### Using the get_pages_with_http_info variant
1987
+
1988
+ This returns an Array which contains the response data, status code and headers.
1989
+
1990
+ > <Array(<GetPagesAPIResponse>, Integer, Hash)> get_pages_with_http_info(tenant_id)
1991
+
1992
+ ```ruby
1993
+ begin
1994
+
1995
+ data, status_code, headers = api_instance.get_pages_with_http_info(tenant_id)
1996
+ p status_code # => 2xx
1997
+ p headers # => { ... }
1998
+ p data # => <GetPagesAPIResponse>
1999
+ rescue FastCommentsClient::ApiError => e
2000
+ puts "Error when calling DefaultApi->get_pages_with_http_info: #{e}"
2001
+ end
2002
+ ```
2003
+
2004
+ ### Parameters
2005
+
2006
+ | Name | Type | Description | Notes |
2007
+ | ---- | ---- | ----------- | ----- |
2008
+ | **tenant_id** | **String** | | |
2009
+
2010
+ ### Return type
2011
+
2012
+ [**GetPagesAPIResponse**](GetPagesAPIResponse.md)
2013
+
2014
+ ### Authorization
2015
+
2016
+ [api_key](../README.md#api_key)
2017
+
2018
+ ### HTTP request headers
2019
+
2020
+ - **Content-Type**: Not defined
2021
+ - **Accept**: application/json
2022
+
2023
+
2024
+ ## get_sso_user_by_email
2025
+
2026
+ > <GetSSOUserByEmailAPIResponse> get_sso_user_by_email(tenant_id, email)
2027
+
2028
+
2029
+
2030
+ ### Examples
2031
+
2032
+ ```ruby
2033
+ require 'time'
2034
+ require 'fastcomments-client'
2035
+ # setup authorization
2036
+ FastCommentsClient.configure do |config|
2037
+ # Configure API key authorization: api_key
2038
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2039
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2040
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2041
+ end
2042
+
2043
+ api_instance = FastCommentsClient::DefaultApi.new
2044
+ tenant_id = 'tenant_id_example' # String |
2045
+ email = 'email_example' # String |
2046
+
2047
+ begin
2048
+
2049
+ result = api_instance.get_sso_user_by_email(tenant_id, email)
2050
+ p result
2051
+ rescue FastCommentsClient::ApiError => e
2052
+ puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
2053
+ end
2054
+ ```
2055
+
2056
+ #### Using the get_sso_user_by_email_with_http_info variant
2057
+
2058
+ This returns an Array which contains the response data, status code and headers.
2059
+
2060
+ > <Array(<GetSSOUserByEmailAPIResponse>, Integer, Hash)> get_sso_user_by_email_with_http_info(tenant_id, email)
2061
+
2062
+ ```ruby
2063
+ begin
2064
+
2065
+ data, status_code, headers = api_instance.get_sso_user_by_email_with_http_info(tenant_id, email)
2066
+ p status_code # => 2xx
2067
+ p headers # => { ... }
2068
+ p data # => <GetSSOUserByEmailAPIResponse>
2069
+ rescue FastCommentsClient::ApiError => e
2070
+ puts "Error when calling DefaultApi->get_sso_user_by_email_with_http_info: #{e}"
2071
+ end
2072
+ ```
2073
+
2074
+ ### Parameters
2075
+
2076
+ | Name | Type | Description | Notes |
2077
+ | ---- | ---- | ----------- | ----- |
2078
+ | **tenant_id** | **String** | | |
2079
+ | **email** | **String** | | |
2080
+
2081
+ ### Return type
2082
+
2083
+ [**GetSSOUserByEmailAPIResponse**](GetSSOUserByEmailAPIResponse.md)
2084
+
2085
+ ### Authorization
2086
+
2087
+ [api_key](../README.md#api_key)
2088
+
2089
+ ### HTTP request headers
2090
+
2091
+ - **Content-Type**: Not defined
2092
+ - **Accept**: application/json
2093
+
2094
+
2095
+ ## get_sso_user_by_id
2096
+
2097
+ > <GetSSOUserByIdAPIResponse> get_sso_user_by_id(tenant_id, id)
2098
+
2099
+
2100
+
2101
+ ### Examples
2102
+
2103
+ ```ruby
2104
+ require 'time'
2105
+ require 'fastcomments-client'
2106
+ # setup authorization
2107
+ FastCommentsClient.configure do |config|
2108
+ # Configure API key authorization: api_key
2109
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2110
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2111
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2112
+ end
2113
+
2114
+ api_instance = FastCommentsClient::DefaultApi.new
2115
+ tenant_id = 'tenant_id_example' # String |
2116
+ id = 'id_example' # String |
2117
+
2118
+ begin
2119
+
2120
+ result = api_instance.get_sso_user_by_id(tenant_id, id)
2121
+ p result
2122
+ rescue FastCommentsClient::ApiError => e
2123
+ puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
2124
+ end
2125
+ ```
2126
+
2127
+ #### Using the get_sso_user_by_id_with_http_info variant
2128
+
2129
+ This returns an Array which contains the response data, status code and headers.
2130
+
2131
+ > <Array(<GetSSOUserByIdAPIResponse>, Integer, Hash)> get_sso_user_by_id_with_http_info(tenant_id, id)
2132
+
2133
+ ```ruby
2134
+ begin
2135
+
2136
+ data, status_code, headers = api_instance.get_sso_user_by_id_with_http_info(tenant_id, id)
2137
+ p status_code # => 2xx
2138
+ p headers # => { ... }
2139
+ p data # => <GetSSOUserByIdAPIResponse>
2140
+ rescue FastCommentsClient::ApiError => e
2141
+ puts "Error when calling DefaultApi->get_sso_user_by_id_with_http_info: #{e}"
2142
+ end
2143
+ ```
2144
+
2145
+ ### Parameters
2146
+
2147
+ | Name | Type | Description | Notes |
2148
+ | ---- | ---- | ----------- | ----- |
2149
+ | **tenant_id** | **String** | | |
2150
+ | **id** | **String** | | |
2151
+
2152
+ ### Return type
2153
+
2154
+ [**GetSSOUserByIdAPIResponse**](GetSSOUserByIdAPIResponse.md)
2155
+
2156
+ ### Authorization
2157
+
2158
+ [api_key](../README.md#api_key)
2159
+
2160
+ ### HTTP request headers
2161
+
2162
+ - **Content-Type**: Not defined
2163
+ - **Accept**: application/json
2164
+
2165
+
2166
+ ## get_sso_users
2167
+
2168
+ > <GetSSOUsers200Response> get_sso_users(tenant_id, opts)
2169
+
2170
+
2171
+
2172
+ ### Examples
2173
+
2174
+ ```ruby
2175
+ require 'time'
2176
+ require 'fastcomments-client'
2177
+ # setup authorization
2178
+ FastCommentsClient.configure do |config|
2179
+ # Configure API key authorization: api_key
2180
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2181
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2182
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2183
+ end
2184
+
2185
+ api_instance = FastCommentsClient::DefaultApi.new
2186
+ tenant_id = 'tenant_id_example' # String |
2187
+ opts = {
2188
+ skip: 56 # Integer |
2189
+ }
2190
+
2191
+ begin
2192
+
2193
+ result = api_instance.get_sso_users(tenant_id, opts)
2194
+ p result
2195
+ rescue FastCommentsClient::ApiError => e
2196
+ puts "Error when calling DefaultApi->get_sso_users: #{e}"
2197
+ end
2198
+ ```
2199
+
2200
+ #### Using the get_sso_users_with_http_info variant
2201
+
2202
+ This returns an Array which contains the response data, status code and headers.
2203
+
2204
+ > <Array(<GetSSOUsers200Response>, Integer, Hash)> get_sso_users_with_http_info(tenant_id, opts)
2205
+
2206
+ ```ruby
2207
+ begin
2208
+
2209
+ data, status_code, headers = api_instance.get_sso_users_with_http_info(tenant_id, opts)
2210
+ p status_code # => 2xx
2211
+ p headers # => { ... }
2212
+ p data # => <GetSSOUsers200Response>
2213
+ rescue FastCommentsClient::ApiError => e
2214
+ puts "Error when calling DefaultApi->get_sso_users_with_http_info: #{e}"
2215
+ end
2216
+ ```
2217
+
2218
+ ### Parameters
2219
+
2220
+ | Name | Type | Description | Notes |
2221
+ | ---- | ---- | ----------- | ----- |
2222
+ | **tenant_id** | **String** | | |
2223
+ | **skip** | **Integer** | | [optional] |
2224
+
2225
+ ### Return type
2226
+
2227
+ [**GetSSOUsers200Response**](GetSSOUsers200Response.md)
2228
+
2229
+ ### Authorization
2230
+
2231
+ [api_key](../README.md#api_key)
2232
+
2233
+ ### HTTP request headers
2234
+
2235
+ - **Content-Type**: Not defined
2236
+ - **Accept**: application/json
2237
+
2238
+
2239
+ ## get_subscriptions
2240
+
2241
+ > <GetSubscriptionsAPIResponse> get_subscriptions(tenant_id, opts)
2242
+
2243
+
2244
+
2245
+ ### Examples
2246
+
2247
+ ```ruby
2248
+ require 'time'
2249
+ require 'fastcomments-client'
2250
+ # setup authorization
2251
+ FastCommentsClient.configure do |config|
2252
+ # Configure API key authorization: api_key
2253
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2254
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2255
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2256
+ end
2257
+
2258
+ api_instance = FastCommentsClient::DefaultApi.new
2259
+ tenant_id = 'tenant_id_example' # String |
2260
+ opts = {
2261
+ user_id: 'user_id_example' # String |
2262
+ }
2263
+
2264
+ begin
2265
+
2266
+ result = api_instance.get_subscriptions(tenant_id, opts)
2267
+ p result
2268
+ rescue FastCommentsClient::ApiError => e
2269
+ puts "Error when calling DefaultApi->get_subscriptions: #{e}"
2270
+ end
2271
+ ```
2272
+
2273
+ #### Using the get_subscriptions_with_http_info variant
2274
+
2275
+ This returns an Array which contains the response data, status code and headers.
2276
+
2277
+ > <Array(<GetSubscriptionsAPIResponse>, Integer, Hash)> get_subscriptions_with_http_info(tenant_id, opts)
2278
+
2279
+ ```ruby
2280
+ begin
2281
+
2282
+ data, status_code, headers = api_instance.get_subscriptions_with_http_info(tenant_id, opts)
2283
+ p status_code # => 2xx
2284
+ p headers # => { ... }
2285
+ p data # => <GetSubscriptionsAPIResponse>
2286
+ rescue FastCommentsClient::ApiError => e
2287
+ puts "Error when calling DefaultApi->get_subscriptions_with_http_info: #{e}"
2288
+ end
2289
+ ```
2290
+
2291
+ ### Parameters
2292
+
2293
+ | Name | Type | Description | Notes |
2294
+ | ---- | ---- | ----------- | ----- |
2295
+ | **tenant_id** | **String** | | |
2296
+ | **user_id** | **String** | | [optional] |
2297
+
2298
+ ### Return type
2299
+
2300
+ [**GetSubscriptionsAPIResponse**](GetSubscriptionsAPIResponse.md)
2301
+
2302
+ ### Authorization
2303
+
2304
+ [api_key](../README.md#api_key)
2305
+
2306
+ ### HTTP request headers
2307
+
2308
+ - **Content-Type**: Not defined
2309
+ - **Accept**: application/json
2310
+
2311
+
2312
+ ## get_user_badge
2313
+
2314
+ > <GetUserBadge200Response> get_user_badge(tenant_id, id)
2315
+
2316
+
2317
+
2318
+ ### Examples
2319
+
2320
+ ```ruby
2321
+ require 'time'
2322
+ require 'fastcomments-client'
2323
+ # setup authorization
2324
+ FastCommentsClient.configure do |config|
2325
+ # Configure API key authorization: api_key
2326
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2327
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2328
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2329
+ end
2330
+
2331
+ api_instance = FastCommentsClient::DefaultApi.new
2332
+ tenant_id = 'tenant_id_example' # String |
2333
+ id = 'id_example' # String |
2334
+
2335
+ begin
2336
+
2337
+ result = api_instance.get_user_badge(tenant_id, id)
2338
+ p result
2339
+ rescue FastCommentsClient::ApiError => e
2340
+ puts "Error when calling DefaultApi->get_user_badge: #{e}"
2341
+ end
2342
+ ```
2343
+
2344
+ #### Using the get_user_badge_with_http_info variant
2345
+
2346
+ This returns an Array which contains the response data, status code and headers.
2347
+
2348
+ > <Array(<GetUserBadge200Response>, Integer, Hash)> get_user_badge_with_http_info(tenant_id, id)
2349
+
2350
+ ```ruby
2351
+ begin
2352
+
2353
+ data, status_code, headers = api_instance.get_user_badge_with_http_info(tenant_id, id)
2354
+ p status_code # => 2xx
2355
+ p headers # => { ... }
2356
+ p data # => <GetUserBadge200Response>
2357
+ rescue FastCommentsClient::ApiError => e
2358
+ puts "Error when calling DefaultApi->get_user_badge_with_http_info: #{e}"
2359
+ end
2360
+ ```
2361
+
2362
+ ### Parameters
2363
+
2364
+ | Name | Type | Description | Notes |
2365
+ | ---- | ---- | ----------- | ----- |
2366
+ | **tenant_id** | **String** | | |
2367
+ | **id** | **String** | | |
2368
+
2369
+ ### Return type
2370
+
2371
+ [**GetUserBadge200Response**](GetUserBadge200Response.md)
2372
+
2373
+ ### Authorization
2374
+
2375
+ [api_key](../README.md#api_key)
2376
+
2377
+ ### HTTP request headers
2378
+
2379
+ - **Content-Type**: Not defined
2380
+ - **Accept**: application/json
2381
+
2382
+
2383
+ ## get_user_badge_progress_by_id
2384
+
2385
+ > <GetUserBadgeProgressById200Response> get_user_badge_progress_by_id(tenant_id, id)
2386
+
2387
+
2388
+
2389
+ ### Examples
2390
+
2391
+ ```ruby
2392
+ require 'time'
2393
+ require 'fastcomments-client'
2394
+ # setup authorization
2395
+ FastCommentsClient.configure do |config|
2396
+ # Configure API key authorization: api_key
2397
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2398
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2399
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2400
+ end
2401
+
2402
+ api_instance = FastCommentsClient::DefaultApi.new
2403
+ tenant_id = 'tenant_id_example' # String |
2404
+ id = 'id_example' # String |
2405
+
2406
+ begin
2407
+
2408
+ result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
2409
+ p result
2410
+ rescue FastCommentsClient::ApiError => e
2411
+ puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
2412
+ end
2413
+ ```
2414
+
2415
+ #### Using the get_user_badge_progress_by_id_with_http_info variant
2416
+
2417
+ This returns an Array which contains the response data, status code and headers.
2418
+
2419
+ > <Array(<GetUserBadgeProgressById200Response>, Integer, Hash)> get_user_badge_progress_by_id_with_http_info(tenant_id, id)
2420
+
2421
+ ```ruby
2422
+ begin
2423
+
2424
+ data, status_code, headers = api_instance.get_user_badge_progress_by_id_with_http_info(tenant_id, id)
2425
+ p status_code # => 2xx
2426
+ p headers # => { ... }
2427
+ p data # => <GetUserBadgeProgressById200Response>
2428
+ rescue FastCommentsClient::ApiError => e
2429
+ puts "Error when calling DefaultApi->get_user_badge_progress_by_id_with_http_info: #{e}"
2430
+ end
2431
+ ```
2432
+
2433
+ ### Parameters
2434
+
2435
+ | Name | Type | Description | Notes |
2436
+ | ---- | ---- | ----------- | ----- |
2437
+ | **tenant_id** | **String** | | |
2438
+ | **id** | **String** | | |
2439
+
2440
+ ### Return type
2441
+
2442
+ [**GetUserBadgeProgressById200Response**](GetUserBadgeProgressById200Response.md)
2443
+
2444
+ ### Authorization
2445
+
2446
+ [api_key](../README.md#api_key)
2447
+
2448
+ ### HTTP request headers
2449
+
2450
+ - **Content-Type**: Not defined
2451
+ - **Accept**: application/json
2452
+
2453
+
2454
+ ## get_user_badge_progress_by_user_id
2455
+
2456
+ > <GetUserBadgeProgressById200Response> get_user_badge_progress_by_user_id(tenant_id, user_id)
2457
+
2458
+
2459
+
2460
+ ### Examples
2461
+
2462
+ ```ruby
2463
+ require 'time'
2464
+ require 'fastcomments-client'
2465
+ # setup authorization
2466
+ FastCommentsClient.configure do |config|
2467
+ # Configure API key authorization: api_key
2468
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2469
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2470
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2471
+ end
2472
+
2473
+ api_instance = FastCommentsClient::DefaultApi.new
2474
+ tenant_id = 'tenant_id_example' # String |
2475
+ user_id = 'user_id_example' # String |
2476
+
2477
+ begin
2478
+
2479
+ result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
2480
+ p result
2481
+ rescue FastCommentsClient::ApiError => e
2482
+ puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
2483
+ end
2484
+ ```
2485
+
2486
+ #### Using the get_user_badge_progress_by_user_id_with_http_info variant
2487
+
2488
+ This returns an Array which contains the response data, status code and headers.
2489
+
2490
+ > <Array(<GetUserBadgeProgressById200Response>, Integer, Hash)> get_user_badge_progress_by_user_id_with_http_info(tenant_id, user_id)
2491
+
2492
+ ```ruby
2493
+ begin
2494
+
2495
+ data, status_code, headers = api_instance.get_user_badge_progress_by_user_id_with_http_info(tenant_id, user_id)
2496
+ p status_code # => 2xx
2497
+ p headers # => { ... }
2498
+ p data # => <GetUserBadgeProgressById200Response>
2499
+ rescue FastCommentsClient::ApiError => e
2500
+ puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id_with_http_info: #{e}"
2501
+ end
2502
+ ```
2503
+
2504
+ ### Parameters
2505
+
2506
+ | Name | Type | Description | Notes |
2507
+ | ---- | ---- | ----------- | ----- |
2508
+ | **tenant_id** | **String** | | |
2509
+ | **user_id** | **String** | | |
2510
+
2511
+ ### Return type
2512
+
2513
+ [**GetUserBadgeProgressById200Response**](GetUserBadgeProgressById200Response.md)
2514
+
2515
+ ### Authorization
2516
+
2517
+ [api_key](../README.md#api_key)
2518
+
2519
+ ### HTTP request headers
2520
+
2521
+ - **Content-Type**: Not defined
2522
+ - **Accept**: application/json
2523
+
2524
+
2525
+ ## get_user_badge_progress_list
2526
+
2527
+ > <GetUserBadgeProgressList200Response> get_user_badge_progress_list(tenant_id, opts)
2528
+
2529
+
2530
+
2531
+ ### Examples
2532
+
2533
+ ```ruby
2534
+ require 'time'
2535
+ require 'fastcomments-client'
2536
+ # setup authorization
2537
+ FastCommentsClient.configure do |config|
2538
+ # Configure API key authorization: api_key
2539
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2540
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2541
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2542
+ end
2543
+
2544
+ api_instance = FastCommentsClient::DefaultApi.new
2545
+ tenant_id = 'tenant_id_example' # String |
2546
+ opts = {
2547
+ user_id: 'user_id_example', # String |
2548
+ limit: 1.2, # Float |
2549
+ skip: 1.2 # Float |
2550
+ }
2551
+
2552
+ begin
2553
+
2554
+ result = api_instance.get_user_badge_progress_list(tenant_id, opts)
2555
+ p result
2556
+ rescue FastCommentsClient::ApiError => e
2557
+ puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
2558
+ end
2559
+ ```
2560
+
2561
+ #### Using the get_user_badge_progress_list_with_http_info variant
2562
+
2563
+ This returns an Array which contains the response data, status code and headers.
2564
+
2565
+ > <Array(<GetUserBadgeProgressList200Response>, Integer, Hash)> get_user_badge_progress_list_with_http_info(tenant_id, opts)
2566
+
2567
+ ```ruby
2568
+ begin
2569
+
2570
+ data, status_code, headers = api_instance.get_user_badge_progress_list_with_http_info(tenant_id, opts)
2571
+ p status_code # => 2xx
2572
+ p headers # => { ... }
2573
+ p data # => <GetUserBadgeProgressList200Response>
2574
+ rescue FastCommentsClient::ApiError => e
2575
+ puts "Error when calling DefaultApi->get_user_badge_progress_list_with_http_info: #{e}"
2576
+ end
2577
+ ```
2578
+
2579
+ ### Parameters
2580
+
2581
+ | Name | Type | Description | Notes |
2582
+ | ---- | ---- | ----------- | ----- |
2583
+ | **tenant_id** | **String** | | |
2584
+ | **user_id** | **String** | | [optional] |
2585
+ | **limit** | **Float** | | [optional] |
2586
+ | **skip** | **Float** | | [optional] |
2587
+
2588
+ ### Return type
2589
+
2590
+ [**GetUserBadgeProgressList200Response**](GetUserBadgeProgressList200Response.md)
2591
+
2592
+ ### Authorization
2593
+
2594
+ [api_key](../README.md#api_key)
2595
+
2596
+ ### HTTP request headers
2597
+
2598
+ - **Content-Type**: Not defined
2599
+ - **Accept**: application/json
2600
+
2601
+
2602
+ ## get_user_badges
2603
+
2604
+ > <GetUserBadges200Response> get_user_badges(tenant_id, opts)
2605
+
2606
+
2607
+
2608
+ ### Examples
2609
+
2610
+ ```ruby
2611
+ require 'time'
2612
+ require 'fastcomments-client'
2613
+ # setup authorization
2614
+ FastCommentsClient.configure do |config|
2615
+ # Configure API key authorization: api_key
2616
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2617
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2618
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2619
+ end
2620
+
2621
+ api_instance = FastCommentsClient::DefaultApi.new
2622
+ tenant_id = 'tenant_id_example' # String |
2623
+ opts = {
2624
+ user_id: 'user_id_example', # String |
2625
+ badge_id: 'badge_id_example', # String |
2626
+ type: 1.2, # Float |
2627
+ displayed_on_comments: true, # Boolean |
2628
+ limit: 1.2, # Float |
2629
+ skip: 1.2 # Float |
2630
+ }
2631
+
2632
+ begin
2633
+
2634
+ result = api_instance.get_user_badges(tenant_id, opts)
2635
+ p result
2636
+ rescue FastCommentsClient::ApiError => e
2637
+ puts "Error when calling DefaultApi->get_user_badges: #{e}"
2638
+ end
2639
+ ```
2640
+
2641
+ #### Using the get_user_badges_with_http_info variant
2642
+
2643
+ This returns an Array which contains the response data, status code and headers.
2644
+
2645
+ > <Array(<GetUserBadges200Response>, Integer, Hash)> get_user_badges_with_http_info(tenant_id, opts)
2646
+
2647
+ ```ruby
2648
+ begin
2649
+
2650
+ data, status_code, headers = api_instance.get_user_badges_with_http_info(tenant_id, opts)
2651
+ p status_code # => 2xx
2652
+ p headers # => { ... }
2653
+ p data # => <GetUserBadges200Response>
2654
+ rescue FastCommentsClient::ApiError => e
2655
+ puts "Error when calling DefaultApi->get_user_badges_with_http_info: #{e}"
2656
+ end
2657
+ ```
2658
+
2659
+ ### Parameters
2660
+
2661
+ | Name | Type | Description | Notes |
2662
+ | ---- | ---- | ----------- | ----- |
2663
+ | **tenant_id** | **String** | | |
2664
+ | **user_id** | **String** | | [optional] |
2665
+ | **badge_id** | **String** | | [optional] |
2666
+ | **type** | **Float** | | [optional] |
2667
+ | **displayed_on_comments** | **Boolean** | | [optional] |
2668
+ | **limit** | **Float** | | [optional] |
2669
+ | **skip** | **Float** | | [optional] |
2670
+
2671
+ ### Return type
2672
+
2673
+ [**GetUserBadges200Response**](GetUserBadges200Response.md)
2674
+
2675
+ ### Authorization
2676
+
2677
+ [api_key](../README.md#api_key)
2678
+
2679
+ ### HTTP request headers
2680
+
2681
+ - **Content-Type**: Not defined
2682
+ - **Accept**: application/json
2683
+
2684
+
2685
+ ## patch_domain_config
2686
+
2687
+ > <GetDomainConfig200Response> patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
2688
+
2689
+
2690
+
2691
+ ### Examples
2692
+
2693
+ ```ruby
2694
+ require 'time'
2695
+ require 'fastcomments-client'
2696
+ # setup authorization
2697
+ FastCommentsClient.configure do |config|
2698
+ # Configure API key authorization: api_key
2699
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2700
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2701
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2702
+ end
2703
+
2704
+ api_instance = FastCommentsClient::DefaultApi.new
2705
+ tenant_id = 'tenant_id_example' # String |
2706
+ domain_to_update = 'domain_to_update_example' # String |
2707
+ patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams |
2708
+
2709
+ begin
2710
+
2711
+ result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
2712
+ p result
2713
+ rescue FastCommentsClient::ApiError => e
2714
+ puts "Error when calling DefaultApi->patch_domain_config: #{e}"
2715
+ end
2716
+ ```
2717
+
2718
+ #### Using the patch_domain_config_with_http_info variant
2719
+
2720
+ This returns an Array which contains the response data, status code and headers.
2721
+
2722
+ > <Array(<GetDomainConfig200Response>, Integer, Hash)> patch_domain_config_with_http_info(tenant_id, domain_to_update, patch_domain_config_params)
2723
+
2724
+ ```ruby
2725
+ begin
2726
+
2727
+ data, status_code, headers = api_instance.patch_domain_config_with_http_info(tenant_id, domain_to_update, patch_domain_config_params)
2728
+ p status_code # => 2xx
2729
+ p headers # => { ... }
2730
+ p data # => <GetDomainConfig200Response>
2731
+ rescue FastCommentsClient::ApiError => e
2732
+ puts "Error when calling DefaultApi->patch_domain_config_with_http_info: #{e}"
2733
+ end
2734
+ ```
2735
+
2736
+ ### Parameters
2737
+
2738
+ | Name | Type | Description | Notes |
2739
+ | ---- | ---- | ----------- | ----- |
2740
+ | **tenant_id** | **String** | | |
2741
+ | **domain_to_update** | **String** | | |
2742
+ | **patch_domain_config_params** | [**PatchDomainConfigParams**](PatchDomainConfigParams.md) | | |
2743
+
2744
+ ### Return type
2745
+
2746
+ [**GetDomainConfig200Response**](GetDomainConfig200Response.md)
2747
+
2748
+ ### Authorization
2749
+
2750
+ [api_key](../README.md#api_key)
2751
+
2752
+ ### HTTP request headers
2753
+
2754
+ - **Content-Type**: application/json
2755
+ - **Accept**: application/json
2756
+
2757
+
2758
+ ## patch_page
2759
+
2760
+ > <PatchPageAPIResponse> patch_page(tenant_id, id, update_api_page_data)
2761
+
2762
+
2763
+
2764
+ ### Examples
2765
+
2766
+ ```ruby
2767
+ require 'time'
2768
+ require 'fastcomments-client'
2769
+ # setup authorization
2770
+ FastCommentsClient.configure do |config|
2771
+ # Configure API key authorization: api_key
2772
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2773
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2774
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2775
+ end
2776
+
2777
+ api_instance = FastCommentsClient::DefaultApi.new
2778
+ tenant_id = 'tenant_id_example' # String |
2779
+ id = 'id_example' # String |
2780
+ update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData |
2781
+
2782
+ begin
2783
+
2784
+ result = api_instance.patch_page(tenant_id, id, update_api_page_data)
2785
+ p result
2786
+ rescue FastCommentsClient::ApiError => e
2787
+ puts "Error when calling DefaultApi->patch_page: #{e}"
2788
+ end
2789
+ ```
2790
+
2791
+ #### Using the patch_page_with_http_info variant
2792
+
2793
+ This returns an Array which contains the response data, status code and headers.
2794
+
2795
+ > <Array(<PatchPageAPIResponse>, Integer, Hash)> patch_page_with_http_info(tenant_id, id, update_api_page_data)
2796
+
2797
+ ```ruby
2798
+ begin
2799
+
2800
+ data, status_code, headers = api_instance.patch_page_with_http_info(tenant_id, id, update_api_page_data)
2801
+ p status_code # => 2xx
2802
+ p headers # => { ... }
2803
+ p data # => <PatchPageAPIResponse>
2804
+ rescue FastCommentsClient::ApiError => e
2805
+ puts "Error when calling DefaultApi->patch_page_with_http_info: #{e}"
2806
+ end
2807
+ ```
2808
+
2809
+ ### Parameters
2810
+
2811
+ | Name | Type | Description | Notes |
2812
+ | ---- | ---- | ----------- | ----- |
2813
+ | **tenant_id** | **String** | | |
2814
+ | **id** | **String** | | |
2815
+ | **update_api_page_data** | [**UpdateAPIPageData**](UpdateAPIPageData.md) | | |
2816
+
2817
+ ### Return type
2818
+
2819
+ [**PatchPageAPIResponse**](PatchPageAPIResponse.md)
2820
+
2821
+ ### Authorization
2822
+
2823
+ [api_key](../README.md#api_key)
2824
+
2825
+ ### HTTP request headers
2826
+
2827
+ - **Content-Type**: application/json
2828
+ - **Accept**: application/json
2829
+
2830
+
2831
+ ## patch_sso_user
2832
+
2833
+ > <PatchSSOUserAPIResponse> patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
2834
+
2835
+
2836
+
2837
+ ### Examples
2838
+
2839
+ ```ruby
2840
+ require 'time'
2841
+ require 'fastcomments-client'
2842
+ # setup authorization
2843
+ FastCommentsClient.configure do |config|
2844
+ # Configure API key authorization: api_key
2845
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2846
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2847
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2848
+ end
2849
+
2850
+ api_instance = FastCommentsClient::DefaultApi.new
2851
+ tenant_id = 'tenant_id_example' # String |
2852
+ id = 'id_example' # String |
2853
+ update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
2854
+ opts = {
2855
+ update_comments: true # Boolean |
2856
+ }
2857
+
2858
+ begin
2859
+
2860
+ result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
2861
+ p result
2862
+ rescue FastCommentsClient::ApiError => e
2863
+ puts "Error when calling DefaultApi->patch_sso_user: #{e}"
2864
+ end
2865
+ ```
2866
+
2867
+ #### Using the patch_sso_user_with_http_info variant
2868
+
2869
+ This returns an Array which contains the response data, status code and headers.
2870
+
2871
+ > <Array(<PatchSSOUserAPIResponse>, Integer, Hash)> patch_sso_user_with_http_info(tenant_id, id, update_apisso_user_data, opts)
2872
+
2873
+ ```ruby
2874
+ begin
2875
+
2876
+ data, status_code, headers = api_instance.patch_sso_user_with_http_info(tenant_id, id, update_apisso_user_data, opts)
2877
+ p status_code # => 2xx
2878
+ p headers # => { ... }
2879
+ p data # => <PatchSSOUserAPIResponse>
2880
+ rescue FastCommentsClient::ApiError => e
2881
+ puts "Error when calling DefaultApi->patch_sso_user_with_http_info: #{e}"
2882
+ end
2883
+ ```
2884
+
2885
+ ### Parameters
2886
+
2887
+ | Name | Type | Description | Notes |
2888
+ | ---- | ---- | ----------- | ----- |
2889
+ | **tenant_id** | **String** | | |
2890
+ | **id** | **String** | | |
2891
+ | **update_apisso_user_data** | [**UpdateAPISSOUserData**](UpdateAPISSOUserData.md) | | |
2892
+ | **update_comments** | **Boolean** | | [optional] |
2893
+
2894
+ ### Return type
2895
+
2896
+ [**PatchSSOUserAPIResponse**](PatchSSOUserAPIResponse.md)
2897
+
2898
+ ### Authorization
2899
+
2900
+ [api_key](../README.md#api_key)
2901
+
2902
+ ### HTTP request headers
2903
+
2904
+ - **Content-Type**: application/json
2905
+ - **Accept**: application/json
2906
+
2907
+
2908
+ ## put_domain_config
2909
+
2910
+ > <GetDomainConfig200Response> put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
2911
+
2912
+
2913
+
2914
+ ### Examples
2915
+
2916
+ ```ruby
2917
+ require 'time'
2918
+ require 'fastcomments-client'
2919
+ # setup authorization
2920
+ FastCommentsClient.configure do |config|
2921
+ # Configure API key authorization: api_key
2922
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2923
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2924
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2925
+ end
2926
+
2927
+ api_instance = FastCommentsClient::DefaultApi.new
2928
+ tenant_id = 'tenant_id_example' # String |
2929
+ domain_to_update = 'domain_to_update_example' # String |
2930
+ update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams |
2931
+
2932
+ begin
2933
+
2934
+ result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
2935
+ p result
2936
+ rescue FastCommentsClient::ApiError => e
2937
+ puts "Error when calling DefaultApi->put_domain_config: #{e}"
2938
+ end
2939
+ ```
2940
+
2941
+ #### Using the put_domain_config_with_http_info variant
2942
+
2943
+ This returns an Array which contains the response data, status code and headers.
2944
+
2945
+ > <Array(<GetDomainConfig200Response>, Integer, Hash)> put_domain_config_with_http_info(tenant_id, domain_to_update, update_domain_config_params)
2946
+
2947
+ ```ruby
2948
+ begin
2949
+
2950
+ data, status_code, headers = api_instance.put_domain_config_with_http_info(tenant_id, domain_to_update, update_domain_config_params)
2951
+ p status_code # => 2xx
2952
+ p headers # => { ... }
2953
+ p data # => <GetDomainConfig200Response>
2954
+ rescue FastCommentsClient::ApiError => e
2955
+ puts "Error when calling DefaultApi->put_domain_config_with_http_info: #{e}"
2956
+ end
2957
+ ```
2958
+
2959
+ ### Parameters
2960
+
2961
+ | Name | Type | Description | Notes |
2962
+ | ---- | ---- | ----------- | ----- |
2963
+ | **tenant_id** | **String** | | |
2964
+ | **domain_to_update** | **String** | | |
2965
+ | **update_domain_config_params** | [**UpdateDomainConfigParams**](UpdateDomainConfigParams.md) | | |
2966
+
2967
+ ### Return type
2968
+
2969
+ [**GetDomainConfig200Response**](GetDomainConfig200Response.md)
2970
+
2971
+ ### Authorization
2972
+
2973
+ [api_key](../README.md#api_key)
2974
+
2975
+ ### HTTP request headers
2976
+
2977
+ - **Content-Type**: application/json
2978
+ - **Accept**: application/json
2979
+
2980
+
2981
+ ## put_sso_user
2982
+
2983
+ > <PutSSOUserAPIResponse> put_sso_user(tenant_id, id, update_apisso_user_data, opts)
2984
+
2985
+
2986
+
2987
+ ### Examples
2988
+
2989
+ ```ruby
2990
+ require 'time'
2991
+ require 'fastcomments-client'
2992
+ # setup authorization
2993
+ FastCommentsClient.configure do |config|
2994
+ # Configure API key authorization: api_key
2995
+ config.api_key['x-api-key'] = 'YOUR API KEY'
2996
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2997
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
2998
+ end
2999
+
3000
+ api_instance = FastCommentsClient::DefaultApi.new
3001
+ tenant_id = 'tenant_id_example' # String |
3002
+ id = 'id_example' # String |
3003
+ update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
3004
+ opts = {
3005
+ update_comments: true # Boolean |
3006
+ }
3007
+
3008
+ begin
3009
+
3010
+ result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
3011
+ p result
3012
+ rescue FastCommentsClient::ApiError => e
3013
+ puts "Error when calling DefaultApi->put_sso_user: #{e}"
3014
+ end
3015
+ ```
3016
+
3017
+ #### Using the put_sso_user_with_http_info variant
3018
+
3019
+ This returns an Array which contains the response data, status code and headers.
3020
+
3021
+ > <Array(<PutSSOUserAPIResponse>, Integer, Hash)> put_sso_user_with_http_info(tenant_id, id, update_apisso_user_data, opts)
3022
+
3023
+ ```ruby
3024
+ begin
3025
+
3026
+ data, status_code, headers = api_instance.put_sso_user_with_http_info(tenant_id, id, update_apisso_user_data, opts)
3027
+ p status_code # => 2xx
3028
+ p headers # => { ... }
3029
+ p data # => <PutSSOUserAPIResponse>
3030
+ rescue FastCommentsClient::ApiError => e
3031
+ puts "Error when calling DefaultApi->put_sso_user_with_http_info: #{e}"
3032
+ end
3033
+ ```
3034
+
3035
+ ### Parameters
3036
+
3037
+ | Name | Type | Description | Notes |
3038
+ | ---- | ---- | ----------- | ----- |
3039
+ | **tenant_id** | **String** | | |
3040
+ | **id** | **String** | | |
3041
+ | **update_apisso_user_data** | [**UpdateAPISSOUserData**](UpdateAPISSOUserData.md) | | |
3042
+ | **update_comments** | **Boolean** | | [optional] |
3043
+
3044
+ ### Return type
3045
+
3046
+ [**PutSSOUserAPIResponse**](PutSSOUserAPIResponse.md)
3047
+
3048
+ ### Authorization
3049
+
3050
+ [api_key](../README.md#api_key)
3051
+
3052
+ ### HTTP request headers
3053
+
3054
+ - **Content-Type**: application/json
3055
+ - **Accept**: application/json
3056
+
3057
+
3058
+ ## save_comment
3059
+
3060
+ > <SaveComment200Response> save_comment(tenant_id, create_comment_params, opts)
3061
+
3062
+
3063
+
3064
+ ### Examples
3065
+
3066
+ ```ruby
3067
+ require 'time'
3068
+ require 'fastcomments-client'
3069
+ # setup authorization
3070
+ FastCommentsClient.configure do |config|
3071
+ # Configure API key authorization: api_key
3072
+ config.api_key['x-api-key'] = 'YOUR API KEY'
3073
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3074
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
3075
+ end
3076
+
3077
+ api_instance = FastCommentsClient::DefaultApi.new
3078
+ tenant_id = 'tenant_id_example' # String |
3079
+ create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams |
3080
+ opts = {
3081
+ is_live: true, # Boolean |
3082
+ do_spam_check: true, # Boolean |
3083
+ send_emails: true, # Boolean |
3084
+ populate_notifications: true # Boolean |
3085
+ }
3086
+
3087
+ begin
3088
+
3089
+ result = api_instance.save_comment(tenant_id, create_comment_params, opts)
3090
+ p result
3091
+ rescue FastCommentsClient::ApiError => e
3092
+ puts "Error when calling DefaultApi->save_comment: #{e}"
3093
+ end
3094
+ ```
3095
+
3096
+ #### Using the save_comment_with_http_info variant
3097
+
3098
+ This returns an Array which contains the response data, status code and headers.
3099
+
3100
+ > <Array(<SaveComment200Response>, Integer, Hash)> save_comment_with_http_info(tenant_id, create_comment_params, opts)
3101
+
3102
+ ```ruby
3103
+ begin
3104
+
3105
+ data, status_code, headers = api_instance.save_comment_with_http_info(tenant_id, create_comment_params, opts)
3106
+ p status_code # => 2xx
3107
+ p headers # => { ... }
3108
+ p data # => <SaveComment200Response>
3109
+ rescue FastCommentsClient::ApiError => e
3110
+ puts "Error when calling DefaultApi->save_comment_with_http_info: #{e}"
3111
+ end
3112
+ ```
3113
+
3114
+ ### Parameters
3115
+
3116
+ | Name | Type | Description | Notes |
3117
+ | ---- | ---- | ----------- | ----- |
3118
+ | **tenant_id** | **String** | | |
3119
+ | **create_comment_params** | [**CreateCommentParams**](CreateCommentParams.md) | | |
3120
+ | **is_live** | **Boolean** | | [optional] |
3121
+ | **do_spam_check** | **Boolean** | | [optional] |
3122
+ | **send_emails** | **Boolean** | | [optional] |
3123
+ | **populate_notifications** | **Boolean** | | [optional] |
3124
+
3125
+ ### Return type
3126
+
3127
+ [**SaveComment200Response**](SaveComment200Response.md)
3128
+
3129
+ ### Authorization
3130
+
3131
+ [api_key](../README.md#api_key)
3132
+
3133
+ ### HTTP request headers
3134
+
3135
+ - **Content-Type**: application/json
3136
+ - **Accept**: application/json
3137
+
3138
+
3139
+ ## save_comments_bulk
3140
+
3141
+ > <Array<SaveComment200Response>> save_comments_bulk(tenant_id, create_comment_params, opts)
3142
+
3143
+
3144
+
3145
+ ### Examples
3146
+
3147
+ ```ruby
3148
+ require 'time'
3149
+ require 'fastcomments-client'
3150
+ # setup authorization
3151
+ FastCommentsClient.configure do |config|
3152
+ # Configure API key authorization: api_key
3153
+ config.api_key['x-api-key'] = 'YOUR API KEY'
3154
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3155
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
3156
+ end
3157
+
3158
+ api_instance = FastCommentsClient::DefaultApi.new
3159
+ tenant_id = 'tenant_id_example' # String |
3160
+ create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> |
3161
+ opts = {
3162
+ is_live: true, # Boolean |
3163
+ do_spam_check: true, # Boolean |
3164
+ send_emails: true, # Boolean |
3165
+ populate_notifications: true # Boolean |
3166
+ }
3167
+
3168
+ begin
3169
+
3170
+ result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
3171
+ p result
3172
+ rescue FastCommentsClient::ApiError => e
3173
+ puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
3174
+ end
3175
+ ```
3176
+
3177
+ #### Using the save_comments_bulk_with_http_info variant
3178
+
3179
+ This returns an Array which contains the response data, status code and headers.
3180
+
3181
+ > <Array(<Array<SaveComment200Response>>, Integer, Hash)> save_comments_bulk_with_http_info(tenant_id, create_comment_params, opts)
3182
+
3183
+ ```ruby
3184
+ begin
3185
+
3186
+ data, status_code, headers = api_instance.save_comments_bulk_with_http_info(tenant_id, create_comment_params, opts)
3187
+ p status_code # => 2xx
3188
+ p headers # => { ... }
3189
+ p data # => <Array<SaveComment200Response>>
3190
+ rescue FastCommentsClient::ApiError => e
3191
+ puts "Error when calling DefaultApi->save_comments_bulk_with_http_info: #{e}"
3192
+ end
3193
+ ```
3194
+
3195
+ ### Parameters
3196
+
3197
+ | Name | Type | Description | Notes |
3198
+ | ---- | ---- | ----------- | ----- |
3199
+ | **tenant_id** | **String** | | |
3200
+ | **create_comment_params** | [**Array&lt;CreateCommentParams&gt;**](CreateCommentParams.md) | | |
3201
+ | **is_live** | **Boolean** | | [optional] |
3202
+ | **do_spam_check** | **Boolean** | | [optional] |
3203
+ | **send_emails** | **Boolean** | | [optional] |
3204
+ | **populate_notifications** | **Boolean** | | [optional] |
3205
+
3206
+ ### Return type
3207
+
3208
+ [**Array&lt;SaveComment200Response&gt;**](SaveComment200Response.md)
3209
+
3210
+ ### Authorization
3211
+
3212
+ [api_key](../README.md#api_key)
3213
+
3214
+ ### HTTP request headers
3215
+
3216
+ - **Content-Type**: application/json
3217
+ - **Accept**: application/json
3218
+
3219
+
3220
+ ## un_block_user_from_comment
3221
+
3222
+ > <UnBlockCommentPublic200Response> un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
3223
+
3224
+
3225
+
3226
+ ### Examples
3227
+
3228
+ ```ruby
3229
+ require 'time'
3230
+ require 'fastcomments-client'
3231
+ # setup authorization
3232
+ FastCommentsClient.configure do |config|
3233
+ # Configure API key authorization: api_key
3234
+ config.api_key['x-api-key'] = 'YOUR API KEY'
3235
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3236
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
3237
+ end
3238
+
3239
+ api_instance = FastCommentsClient::DefaultApi.new
3240
+ tenant_id = 'tenant_id_example' # String |
3241
+ id = 'id_example' # String |
3242
+ un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
3243
+ opts = {
3244
+ user_id: 'user_id_example', # String |
3245
+ anon_user_id: 'anon_user_id_example' # String |
3246
+ }
3247
+
3248
+ begin
3249
+
3250
+ result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
3251
+ p result
3252
+ rescue FastCommentsClient::ApiError => e
3253
+ puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
3254
+ end
3255
+ ```
3256
+
3257
+ #### Using the un_block_user_from_comment_with_http_info variant
3258
+
3259
+ This returns an Array which contains the response data, status code and headers.
3260
+
3261
+ > <Array(<UnBlockCommentPublic200Response>, Integer, Hash)> un_block_user_from_comment_with_http_info(tenant_id, id, un_block_from_comment_params, opts)
3262
+
3263
+ ```ruby
3264
+ begin
3265
+
3266
+ data, status_code, headers = api_instance.un_block_user_from_comment_with_http_info(tenant_id, id, un_block_from_comment_params, opts)
3267
+ p status_code # => 2xx
3268
+ p headers # => { ... }
3269
+ p data # => <UnBlockCommentPublic200Response>
3270
+ rescue FastCommentsClient::ApiError => e
3271
+ puts "Error when calling DefaultApi->un_block_user_from_comment_with_http_info: #{e}"
3272
+ end
3273
+ ```
3274
+
3275
+ ### Parameters
3276
+
3277
+ | Name | Type | Description | Notes |
3278
+ | ---- | ---- | ----------- | ----- |
3279
+ | **tenant_id** | **String** | | |
3280
+ | **id** | **String** | | |
3281
+ | **un_block_from_comment_params** | [**UnBlockFromCommentParams**](UnBlockFromCommentParams.md) | | |
3282
+ | **user_id** | **String** | | [optional] |
3283
+ | **anon_user_id** | **String** | | [optional] |
3284
+
3285
+ ### Return type
3286
+
3287
+ [**UnBlockCommentPublic200Response**](UnBlockCommentPublic200Response.md)
3288
+
3289
+ ### Authorization
3290
+
3291
+ [api_key](../README.md#api_key)
3292
+
3293
+ ### HTTP request headers
3294
+
3295
+ - **Content-Type**: application/json
3296
+ - **Accept**: application/json
3297
+
3298
+
3299
+ ## un_flag_comment
3300
+
3301
+ > <FlagComment200Response> un_flag_comment(tenant_id, id, opts)
3302
+
3303
+
3304
+
3305
+ ### Examples
3306
+
3307
+ ```ruby
3308
+ require 'time'
3309
+ require 'fastcomments-client'
3310
+ # setup authorization
3311
+ FastCommentsClient.configure do |config|
3312
+ # Configure API key authorization: api_key
3313
+ config.api_key['x-api-key'] = 'YOUR API KEY'
3314
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3315
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
3316
+ end
3317
+
3318
+ api_instance = FastCommentsClient::DefaultApi.new
3319
+ tenant_id = 'tenant_id_example' # String |
3320
+ id = 'id_example' # String |
3321
+ opts = {
3322
+ user_id: 'user_id_example', # String |
3323
+ anon_user_id: 'anon_user_id_example' # String |
3324
+ }
3325
+
3326
+ begin
3327
+
3328
+ result = api_instance.un_flag_comment(tenant_id, id, opts)
3329
+ p result
3330
+ rescue FastCommentsClient::ApiError => e
3331
+ puts "Error when calling DefaultApi->un_flag_comment: #{e}"
3332
+ end
3333
+ ```
3334
+
3335
+ #### Using the un_flag_comment_with_http_info variant
3336
+
3337
+ This returns an Array which contains the response data, status code and headers.
3338
+
3339
+ > <Array(<FlagComment200Response>, Integer, Hash)> un_flag_comment_with_http_info(tenant_id, id, opts)
3340
+
3341
+ ```ruby
3342
+ begin
3343
+
3344
+ data, status_code, headers = api_instance.un_flag_comment_with_http_info(tenant_id, id, opts)
3345
+ p status_code # => 2xx
3346
+ p headers # => { ... }
3347
+ p data # => <FlagComment200Response>
3348
+ rescue FastCommentsClient::ApiError => e
3349
+ puts "Error when calling DefaultApi->un_flag_comment_with_http_info: #{e}"
3350
+ end
3351
+ ```
3352
+
3353
+ ### Parameters
3354
+
3355
+ | Name | Type | Description | Notes |
3356
+ | ---- | ---- | ----------- | ----- |
3357
+ | **tenant_id** | **String** | | |
3358
+ | **id** | **String** | | |
3359
+ | **user_id** | **String** | | [optional] |
3360
+ | **anon_user_id** | **String** | | [optional] |
3361
+
3362
+ ### Return type
3363
+
3364
+ [**FlagComment200Response**](FlagComment200Response.md)
3365
+
3366
+ ### Authorization
3367
+
3368
+ [api_key](../README.md#api_key)
3369
+
3370
+ ### HTTP request headers
3371
+
3372
+ - **Content-Type**: Not defined
3373
+ - **Accept**: application/json
3374
+
3375
+
3376
+ ## update_comment
3377
+
3378
+ > <FlagCommentPublic200Response> update_comment(tenant_id, id, updatable_comment_params, opts)
3379
+
3380
+
3381
+
3382
+ ### Examples
3383
+
3384
+ ```ruby
3385
+ require 'time'
3386
+ require 'fastcomments-client'
3387
+ # setup authorization
3388
+ FastCommentsClient.configure do |config|
3389
+ # Configure API key authorization: api_key
3390
+ config.api_key['x-api-key'] = 'YOUR API KEY'
3391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3392
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
3393
+ end
3394
+
3395
+ api_instance = FastCommentsClient::DefaultApi.new
3396
+ tenant_id = 'tenant_id_example' # String |
3397
+ id = 'id_example' # String |
3398
+ updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams |
3399
+ opts = {
3400
+ context_user_id: 'context_user_id_example', # String |
3401
+ do_spam_check: true, # Boolean |
3402
+ is_live: true # Boolean |
3403
+ }
3404
+
3405
+ begin
3406
+
3407
+ result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
3408
+ p result
3409
+ rescue FastCommentsClient::ApiError => e
3410
+ puts "Error when calling DefaultApi->update_comment: #{e}"
3411
+ end
3412
+ ```
3413
+
3414
+ #### Using the update_comment_with_http_info variant
3415
+
3416
+ This returns an Array which contains the response data, status code and headers.
3417
+
3418
+ > <Array(<FlagCommentPublic200Response>, Integer, Hash)> update_comment_with_http_info(tenant_id, id, updatable_comment_params, opts)
3419
+
3420
+ ```ruby
3421
+ begin
3422
+
3423
+ data, status_code, headers = api_instance.update_comment_with_http_info(tenant_id, id, updatable_comment_params, opts)
3424
+ p status_code # => 2xx
3425
+ p headers # => { ... }
3426
+ p data # => <FlagCommentPublic200Response>
3427
+ rescue FastCommentsClient::ApiError => e
3428
+ puts "Error when calling DefaultApi->update_comment_with_http_info: #{e}"
3429
+ end
3430
+ ```
3431
+
3432
+ ### Parameters
3433
+
3434
+ | Name | Type | Description | Notes |
3435
+ | ---- | ---- | ----------- | ----- |
3436
+ | **tenant_id** | **String** | | |
3437
+ | **id** | **String** | | |
3438
+ | **updatable_comment_params** | [**UpdatableCommentParams**](UpdatableCommentParams.md) | | |
3439
+ | **context_user_id** | **String** | | [optional] |
3440
+ | **do_spam_check** | **Boolean** | | [optional] |
3441
+ | **is_live** | **Boolean** | | [optional] |
3442
+
3443
+ ### Return type
3444
+
3445
+ [**FlagCommentPublic200Response**](FlagCommentPublic200Response.md)
3446
+
3447
+ ### Authorization
3448
+
3449
+ [api_key](../README.md#api_key)
3450
+
3451
+ ### HTTP request headers
3452
+
3453
+ - **Content-Type**: application/json
3454
+ - **Accept**: application/json
3455
+
3456
+
3457
+ ## update_feed_post
3458
+
3459
+ > <FlagCommentPublic200Response> update_feed_post(tenant_id, id, feed_post)
3460
+
3461
+
3462
+
3463
+ ### Examples
3464
+
3465
+ ```ruby
3466
+ require 'time'
3467
+ require 'fastcomments-client'
3468
+ # setup authorization
3469
+ FastCommentsClient.configure do |config|
3470
+ # Configure API key authorization: api_key
3471
+ config.api_key['x-api-key'] = 'YOUR API KEY'
3472
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3473
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
3474
+ end
3475
+
3476
+ api_instance = FastCommentsClient::DefaultApi.new
3477
+ tenant_id = 'tenant_id_example' # String |
3478
+ id = 'id_example' # String |
3479
+ feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost |
3480
+
3481
+ begin
3482
+
3483
+ result = api_instance.update_feed_post(tenant_id, id, feed_post)
3484
+ p result
3485
+ rescue FastCommentsClient::ApiError => e
3486
+ puts "Error when calling DefaultApi->update_feed_post: #{e}"
3487
+ end
3488
+ ```
3489
+
3490
+ #### Using the update_feed_post_with_http_info variant
3491
+
3492
+ This returns an Array which contains the response data, status code and headers.
3493
+
3494
+ > <Array(<FlagCommentPublic200Response>, Integer, Hash)> update_feed_post_with_http_info(tenant_id, id, feed_post)
3495
+
3496
+ ```ruby
3497
+ begin
3498
+
3499
+ data, status_code, headers = api_instance.update_feed_post_with_http_info(tenant_id, id, feed_post)
3500
+ p status_code # => 2xx
3501
+ p headers # => { ... }
3502
+ p data # => <FlagCommentPublic200Response>
3503
+ rescue FastCommentsClient::ApiError => e
3504
+ puts "Error when calling DefaultApi->update_feed_post_with_http_info: #{e}"
3505
+ end
3506
+ ```
3507
+
3508
+ ### Parameters
3509
+
3510
+ | Name | Type | Description | Notes |
3511
+ | ---- | ---- | ----------- | ----- |
3512
+ | **tenant_id** | **String** | | |
3513
+ | **id** | **String** | | |
3514
+ | **feed_post** | [**FeedPost**](FeedPost.md) | | |
3515
+
3516
+ ### Return type
3517
+
3518
+ [**FlagCommentPublic200Response**](FlagCommentPublic200Response.md)
3519
+
3520
+ ### Authorization
3521
+
3522
+ [api_key](../README.md#api_key)
3523
+
3524
+ ### HTTP request headers
3525
+
3526
+ - **Content-Type**: application/json
3527
+ - **Accept**: application/json
3528
+
3529
+
3530
+ ## update_user_badge
3531
+
3532
+ > <UpdateUserBadge200Response> update_user_badge(tenant_id, id, update_user_badge_params)
3533
+
3534
+
3535
+
3536
+ ### Examples
3537
+
3538
+ ```ruby
3539
+ require 'time'
3540
+ require 'fastcomments-client'
3541
+ # setup authorization
3542
+ FastCommentsClient.configure do |config|
3543
+ # Configure API key authorization: api_key
3544
+ config.api_key['x-api-key'] = 'YOUR API KEY'
3545
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3546
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
3547
+ end
3548
+
3549
+ api_instance = FastCommentsClient::DefaultApi.new
3550
+ tenant_id = 'tenant_id_example' # String |
3551
+ id = 'id_example' # String |
3552
+ update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams |
3553
+
3554
+ begin
3555
+
3556
+ result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
3557
+ p result
3558
+ rescue FastCommentsClient::ApiError => e
3559
+ puts "Error when calling DefaultApi->update_user_badge: #{e}"
3560
+ end
3561
+ ```
3562
+
3563
+ #### Using the update_user_badge_with_http_info variant
3564
+
3565
+ This returns an Array which contains the response data, status code and headers.
3566
+
3567
+ > <Array(<UpdateUserBadge200Response>, Integer, Hash)> update_user_badge_with_http_info(tenant_id, id, update_user_badge_params)
3568
+
3569
+ ```ruby
3570
+ begin
3571
+
3572
+ data, status_code, headers = api_instance.update_user_badge_with_http_info(tenant_id, id, update_user_badge_params)
3573
+ p status_code # => 2xx
3574
+ p headers # => { ... }
3575
+ p data # => <UpdateUserBadge200Response>
3576
+ rescue FastCommentsClient::ApiError => e
3577
+ puts "Error when calling DefaultApi->update_user_badge_with_http_info: #{e}"
3578
+ end
3579
+ ```
3580
+
3581
+ ### Parameters
3582
+
3583
+ | Name | Type | Description | Notes |
3584
+ | ---- | ---- | ----------- | ----- |
3585
+ | **tenant_id** | **String** | | |
3586
+ | **id** | **String** | | |
3587
+ | **update_user_badge_params** | [**UpdateUserBadgeParams**](UpdateUserBadgeParams.md) | | |
3588
+
3589
+ ### Return type
3590
+
3591
+ [**UpdateUserBadge200Response**](UpdateUserBadge200Response.md)
3592
+
3593
+ ### Authorization
3594
+
3595
+ [api_key](../README.md#api_key)
3596
+
3597
+ ### HTTP request headers
3598
+
3599
+ - **Content-Type**: application/json
3600
+ - **Accept**: application/json
3601
+