DefaultApi class abstract interface

Annotations

• @RestApi.new(callAdapter: _ResultCallAdapter)

Constructors

DefaultApi(Dio dio, {String? baseUrl})

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

acceptFeedMemberInvite({required String feedId, required String feedGroupId}) → Future<Result<AcceptFeedMemberInviteResponse>>

acceptFollow({required AcceptFollowRequest acceptFollowRequest}) → Future<Result<AcceptFollowResponse>>

activityFeedback({required String activityId, ActivityFeedbackRequest? activityFeedbackRequest}) → Future<Result<ActivityFeedbackResponse>>

addActivity({required AddActivityRequest addActivityRequest}) → Future<Result<AddActivityResponse>>

addActivityReaction({required String activityId, required AddReactionRequest addReactionRequest}) → Future<Result<AddReactionResponse>>

addBookmark({required String activityId, AddBookmarkRequest? addBookmarkRequest}) → Future<Result<AddBookmarkResponse>>

addComment({AddCommentRequest? addCommentRequest}) → Future<Result<AddCommentResponse>>

addCommentBookmark({required String commentId, AddCommentBookmarkRequest? addCommentBookmarkRequest}) → Future<Result<AddCommentBookmarkResponse>>

addCommentReaction({required String id, required AddCommentReactionRequest addCommentReactionRequest}) → Future<Result<AddCommentReactionResponse>>

addCommentsBatch({required AddCommentsBatchRequest addCommentsBatchRequest}) → Future<Result<AddCommentsBatchResponse>>

addUserGroupMembers({required String id, required AddUserGroupMembersRequest addUserGroupMembersRequest}) → Future<Result<AddUserGroupMembersResponse>>

appeal({required AppealRequest appealRequest}) → Future<Result<AppealResponse>>

ban({required BanRequest banRequest}) → Future<Result<ModerationBanResponse>>

batchQueryActivityReactions({required BatchQueryActivityReactionsRequest batchQueryActivityReactionsRequest}) → Future<Result<BatchQueryActivityReactionsResponse>>

batchQueryCommentReactions({required BatchQueryCommentReactionsRequest batchQueryCommentReactionsRequest}) → Future<Result<BatchQueryCommentReactionsResponse>>

blockUsers({required BlockUsersRequest blockUsersRequest}) → Future<Result<BlockUsersResponse>>

bulkActionAppeals({required BulkActionAppealsRequest bulkActionAppealsRequest}) → Future<Result<BulkActionAppealsResponse>>

bulkDeleteActionConfig({required BulkDeleteActionConfigRequest bulkDeleteActionConfigRequest}) → Future<Result<BulkDeleteActionConfigResponse>>

bulkUpsertActionConfig({required BulkUpsertActionConfigRequest bulkUpsertActionConfigRequest}) → Future<Result<BulkUpsertActionConfigResponse>>

castPollVote({required String activityId, required String pollId, CastPollVoteRequest? castPollVoteRequest}) → Future<Result<PollVoteResponse>>

changeFeedVisibility({required String feedGroupId, required String feedId, required ChangeFeedVisibilityRequest changeFeedVisibilityRequest}) → Future<Result<ChangeFeedVisibilityResponse>>

createBlockList({required CreateBlockListRequest createBlockListRequest}) → Future<Result<CreateBlockListResponse>>

createCollections({required CreateCollectionsRequest createCollectionsRequest}) → Future<Result<CreateCollectionsResponse>>

createDevice({required CreateDeviceRequest createDeviceRequest}) → Future<Result<DurationResponse>>

createFeedsBatch({required CreateFeedsBatchRequest createFeedsBatchRequest}) → Future<Result<CreateFeedsBatchResponse>>

createGuest({required CreateGuestRequest createGuestRequest}) → Future<Result<CreateGuestResponse>>

createPoll({required CreatePollRequest createPollRequest}) → Future<Result<PollResponse>>

createPollOption({required String pollId, required CreatePollOptionRequest createPollOptionRequest}) → Future<Result<PollOptionResponse>>

createQueue({required CreateQueueRequest createQueueRequest}) → Future<Result<QueueResponse>>

createUserGroup({required CreateUserGroupRequest createUserGroupRequest}) → Future<Result<CreateUserGroupResponse>>

deleteActionConfig({required String id}) → Future<Result<DeleteActionConfigResponse>>

deleteActivities({required DeleteActivitiesRequest deleteActivitiesRequest}) → Future<Result<DeleteActivitiesResponse>>

deleteActivity({required String id, bool? hardDelete, bool? deleteNotificationActivity}) → Future<Result<DeleteActivityResponse>>

deleteActivityReaction({required String activityId, required String type, bool? deleteNotificationActivity}) → Future<Result<DeleteActivityReactionResponse>>

deleteBlockList({required String name, String? team}) → Future<Result<DurationResponse>>

deleteBookmark({required String activityId, String? folderId}) → Future<Result<DeleteBookmarkResponse>>

deleteBookmarkFolder({required String folderId}) → Future<Result<DeleteBookmarkFolderResponse>>

deleteCollections({required List<String> collectionRefs}) → Future<Result<DeleteCollectionsResponse>>

deleteComment({required String id, bool? hardDelete, bool? deleteNotificationActivity}) → Future<Result<DeleteCommentResponse>>

deleteCommentBookmark({required String commentId, String? folderId}) → Future<Result<DeleteCommentBookmarkResponse>>

deleteCommentReaction({required String id, required String type, bool? deleteNotificationActivity}) → Future<Result<DeleteCommentReactionResponse>>

deleteConfig({required String key, String? team}) → Future<Result<DeleteModerationConfigResponse>>

deleteDevice({required String id}) → Future<Result<DurationResponse>>

deleteFeed({required String feedGroupId, required String feedId, bool? hardDelete, bool? purgeUserActivities}) → Future<Result<DeleteFeedResponse>>

deleteFile({String? url}) → Future<Result<DurationResponse>>

deleteImage({String? url}) → Future<Result<DurationResponse>>

deletePoll({required String pollId}) → Future<Result<DurationResponse>>

deletePollOption({required String pollId, required String optionId}) → Future<Result<DurationResponse>>

deletePollVote({required String activityId, required String pollId, required String voteId}) → Future<Result<PollVoteResponse>>

deleteQueue({required String id}) → Future<Result<QueueResponse>>

deleteUserGroup({required String id, String? teamId}) → Future<Result<DurationResponse>>

deleteUserInterests({required String userId, required List<String> tags}) → Future<Result<DeleteUserInterestsResponse>>

flag({required FlagRequest flagRequest}) → Future<Result<FlagItemResponse>>

follow({required FollowRequest followRequest}) → Future<Result<SingleFollowResponse>>

followBatch({required FollowBatchRequest followBatchRequest}) → Future<Result<FollowBatchResponse>>

getActionConfig({String? queueType, String? entityType, bool? excludeDefaults, bool? onlyDefaults}) → Future<Result<GetActionConfigResponse>>

getActivity({required String id, String? commentSort, int? commentLimit, bool? skipOwnFollowings, String? language, bool? translateText}) → Future<Result<GetActivityResponse>>

getApp() → Future<Result<GetApplicationResponse>>

getAppeal({required String id}) → Future<Result<GetAppealResponse>>

getBlockedUsers() → Future<Result<GetBlockedUsersResponse>>

getComment({required String id, String? language, bool? translateText}) → Future<Result<GetCommentResponse>>

getCommentReplies({required String id, int? depth, String? sort, int? repliesLimit, String? idAround, String? language, bool? translateText, int? limit, String? prev, String? next}) → Future<Result<GetCommentRepliesResponse>>

getComments({required String objectId, required String objectType, int? depth, String? sort, int? repliesLimit, String? idAround, String? language, bool? translateText, int? limit, String? prev, String? next}) → Future<Result<GetCommentsResponse>>

getConfig({required String key, String? team}) → Future<Result<GetConfigResponse>>

getFeedCounts({required String feedGroupId, required String feedId}) → Future<Result<GetFeedCountsResponse>>

getFollowSuggestions({required String feedGroupId, int? limit}) → Future<Result<GetFollowSuggestionsResponse>>

getOG({required String url}) → Future<Result<GetOGResponse>>

getOrCreateFeed({required String feedGroupId, required String feedId, String? language, bool? translateText, GetOrCreateFeedRequest? getOrCreateFeedRequest}) → Future<Result<GetOrCreateFeedResponse>>

getOrCreateFollow({required FollowRequest followRequest}) → Future<Result<GetOrCreateFollowResponse>>

getOrCreateFollows({required FollowBatchRequest followBatchRequest}) → Future<Result<FollowBatchResponse>>

getOrCreateUnfollow({required GetOrCreateUnfollowRequest getOrCreateUnfollowRequest}) → Future<Result<GetOrCreateUnfollowResponse>>

getOrCreateUnfollows({required UnfollowBatchRequest unfollowBatchRequest}) → Future<Result<UnfollowBatchResponse>>

getPoll({required String pollId}) → Future<Result<PollResponse>>

getPollOption({required String pollId, required String optionId}) → Future<Result<PollOptionResponse>>

getQueue({required String id}) → Future<Result<QueueResponse>>

getUserGroup({required String id, String? teamId}) → Future<Result<GetUserGroupResponse>>

getUserInterests({required String userId, int? limit}) → Future<Result<GetUserInterestsResponse>>

getUserLiveLocations() → Future<Result<SharedLocationsResponse>>

importBlockList({required String id, required ImportBlockListRequest importBlockListRequest}) → Future<Result<ImportBlockListResponse>>

listBlockLists({String? team, String? cursor, int? limit}) → Future<Result<ListBlockListResponse>>

listDevices() → Future<Result<ListDevicesResponse>>

listQueues() → Future<Result<ListQueuesResponse>>

listUserGroups({int? limit, String? idGt, String? createdAtGt, String? teamId}) → Future<Result<ListUserGroupsResponse>>

longPoll({WSAuthMessage? json}) → Future<Result<void>>

markActivity({required String feedGroupId, required String feedId, MarkActivityRequest? markActivityRequest}) → Future<Result<DurationResponse>>

mute({required MuteRequest muteRequest}) → Future<Result<MuteResponse>>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

ownBatch({required OwnBatchRequest ownBatchRequest}) → Future<Result<OwnBatchResponse>>

pinActivity({required String feedGroupId, required String feedId, required String activityId, PinActivityRequest? pinActivityRequest}) → Future<Result<PinActivityResponse>>

queryActivities({String? language, bool? translateText, QueryActivitiesRequest? queryActivitiesRequest}) → Future<Result<QueryActivitiesResponse>>

queryActivityReactions({required String activityId, QueryActivityReactionsRequest? queryActivityReactionsRequest}) → Future<Result<QueryActivityReactionsResponse>>

queryActivityShares({required String activityId, int? limit, String? prev, String? next}) → Future<Result<QueryActivitySharesResponse>>

queryAppeals({QueryAppealsRequest? queryAppealsRequest}) → Future<Result<QueryAppealsResponse>>

queryBookmarkFolders({QueryBookmarkFoldersRequest? queryBookmarkFoldersRequest}) → Future<Result<QueryBookmarkFoldersResponse>>

queryBookmarks({String? language, bool? translateText, QueryBookmarksRequest? queryBookmarksRequest}) → Future<Result<QueryBookmarksResponse>>

queryCollections({QueryCollectionsRequest? queryCollectionsRequest}) → Future<Result<QueryCollectionsResponse>>

queryCommentReactions({required String id, QueryCommentReactionsRequest? queryCommentReactionsRequest}) → Future<Result<QueryCommentReactionsResponse>>

queryComments({String? language, bool? translateText, required QueryCommentsRequest queryCommentsRequest}) → Future<Result<QueryCommentsResponse>>

queryFeedMembers({required String feedGroupId, required String feedId, QueryFeedMembersRequest? queryFeedMembersRequest}) → Future<Result<QueryFeedMembersResponse>>

queryFeeds({QueryFeedsRequest? queryFeedsRequest}) → Future<Result<QueryFeedsResponse>>

queryFollows({QueryFollowsRequest? queryFollowsRequest}) → Future<Result<QueryFollowsResponse>>

queryModerationConfigs({QueryModerationConfigsRequest? queryModerationConfigsRequest}) → Future<Result<QueryModerationConfigsResponse>>

queryPinnedActivities({required String feedGroupId, required String feedId, String? language, bool? translateText, QueryPinnedActivitiesRequest? queryPinnedActivitiesRequest}) → Future<Result<QueryPinnedActivitiesResponse>>

queryPolls({QueryPollsRequest? queryPollsRequest}) → Future<Result<QueryPollsResponse>>

queryPollVotes({required String pollId, QueryPollVotesRequest? queryPollVotesRequest}) → Future<Result<PollVotesResponse>>

queryReviewQueue({QueryReviewQueueRequest? queryReviewQueueRequest}) → Future<Result<QueryReviewQueueResponse>>

queryUsers({QueryUsersPayload? payload}) → Future<Result<QueryUsersResponse>>

readCollections({List<String>? collectionRefs}) → Future<Result<ReadCollectionsResponse>>

rejectFeedMemberInvite({required String feedGroupId, required String feedId}) → Future<Result<RejectFeedMemberInviteResponse>>

rejectFollow({required RejectFollowRequest rejectFollowRequest}) → Future<Result<RejectFollowResponse>>

removeUserGroupMembers({required String id, required RemoveUserGroupMembersRequest removeUserGroupMembersRequest}) → Future<Result<RemoveUserGroupMembersResponse>>

restoreActivity({required String id, bool? enrichOwnFields}) → Future<Result<RestoreActivityResponse>>

restoreComment({required String id}) → Future<Result<RestoreCommentResponse>>

searchRoles({required String query, int? limit, String? nameGt, String? roleType, bool? includeGlobalRoles}) → Future<Result<SearchRolesResponse>>

searchUserGroups({required String query, int? limit, String? nameGt, String? idGt, String? teamId}) → Future<Result<SearchUserGroupsResponse>>

stopWatchingFeed({required String feedGroupId, required String feedId}) → Future<Result<DurationResponse>>

submitAction({required SubmitActionRequest submitActionRequest}) → Future<Result<SubmitActionResponse>>

toString() → String

A string representation of this object.

inherited

trackActivityMetrics({required TrackActivityMetricsRequest trackActivityMetricsRequest}) → Future<Result<TrackActivityMetricsResponse>>

translateActivity({required String id, required TranslateActivityRequest translateActivityRequest}) → Future<Result<TranslateActivityResponse>>

translateComment({required String id, required TranslateCommentRequest translateCommentRequest}) → Future<Result<TranslateCommentResponse>>

unban({required String targetUserId, String? channelCid}) → Future<Result<UnbanResponse>>

unblockUsers({required UnblockUsersRequest unblockUsersRequest}) → Future<Result<UnblockUsersResponse>>

unfollow({required String source, required String target, bool? deleteNotificationActivity, bool? keepHistory, bool? enrichOwnFields}) → Future<Result<UnfollowResponse>>

unmute({required UnmuteRequest unmuteRequest}) → Future<Result<UnmuteResponse>>

unpinActivity({required String feedGroupId, required String feedId, required String activityId, bool? enrichOwnFields}) → Future<Result<UnpinActivityResponse>>

updateActivity({required String id, UpdateActivityRequest? updateActivityRequest}) → Future<Result<UpdateActivityResponse>>

updateActivityPartial({required String id, UpdateActivityPartialRequest? updateActivityPartialRequest}) → Future<Result<UpdateActivityPartialResponse>>

updateBlockList({required String name, UpdateBlockListRequest? updateBlockListRequest}) → Future<Result<UpdateBlockListResponse>>

updateBookmark({required String activityId, UpdateBookmarkRequest? updateBookmarkRequest}) → Future<Result<UpdateBookmarkResponse>>

updateBookmarkFolder({required String folderId, UpdateBookmarkFolderRequest? updateBookmarkFolderRequest}) → Future<Result<UpdateBookmarkFolderResponse>>

updateCollections({required UpdateCollectionsRequest updateCollectionsRequest}) → Future<Result<UpdateCollectionsResponse>>

updateComment({required String id, UpdateCommentRequest? updateCommentRequest}) → Future<Result<UpdateCommentResponse>>

updateCommentBookmark({required String commentId, UpdateCommentBookmarkRequest? updateCommentBookmarkRequest}) → Future<Result<UpdateCommentBookmarkResponse>>

updateCommentPartial({required String id, UpdateCommentPartialRequest? updateCommentPartialRequest}) → Future<Result<UpdateCommentPartialResponse>>

updateFeed({required String feedGroupId, required String feedId, UpdateFeedRequest? updateFeedRequest}) → Future<Result<UpdateFeedResponse>>

updateFeedMembers({required String feedGroupId, required String feedId, required UpdateFeedMembersRequest updateFeedMembersRequest}) → Future<Result<UpdateFeedMembersResponse>>

updateFollow({required UpdateFollowRequest updateFollowRequest}) → Future<Result<UpdateFollowResponse>>

updateLiveLocation({required UpdateLiveLocationRequest updateLiveLocationRequest}) → Future<Result<SharedLocationResponse>>

updatePoll({required UpdatePollRequest updatePollRequest}) → Future<Result<PollResponse>>

updatePollOption({required String pollId, required UpdatePollOptionRequest updatePollOptionRequest}) → Future<Result<PollOptionResponse>>

updatePollPartial({required String pollId, UpdatePollPartialRequest? updatePollPartialRequest}) → Future<Result<PollResponse>>

updatePushNotificationPreferences({required UpsertPushPreferencesRequest upsertPushPreferencesRequest}) → Future<Result<UpsertPushPreferencesResponse>>

updateQueue({required String id, UpdateQueueRequest? updateQueueRequest}) → Future<Result<QueueResponse>>

updateUserGroup({required String id, UpdateUserGroupRequest? updateUserGroupRequest}) → Future<Result<UpdateUserGroupResponse>>

updateUsers({required UpdateUsersRequest updateUsersRequest}) → Future<Result<UpdateUsersResponse>>

updateUsersPartial({required UpdateUsersPartialRequest updateUsersPartialRequest}) → Future<Result<UpdateUsersResponse>>

uploadFile({FileUploadRequest? fileUploadRequest}) → Future<Result<FileUploadResponse>>

uploadImage({ImageUploadRequest? imageUploadRequest}) → Future<Result<ImageUploadResponse>>

upsertActionConfig({required UpsertActionConfigRequest upsertActionConfigRequest}) → Future<Result<UpsertActionConfigResponse>>

upsertActivities({required UpsertActivitiesRequest upsertActivitiesRequest}) → Future<Result<UpsertActivitiesResponse>>

upsertConfig({required UpsertConfigRequest upsertConfigRequest}) → Future<Result<UpsertConfigResponse>>

upsertUserInterests({required String userId, required UpsertUserInterestsRequest upsertUserInterestsRequest}) → Future<Result<UpsertUserInterestsResponse>>

Operators

operator ==(Object other) → bool

The equality operator.

inherited