@wix/auto_sdk_comments_votes 1.0.0

package/build/internal/es/index.d.mts

@@ -0,0 +1,60 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { UpvoteOptions, UpvoteResponse, UpvoteApplicationErrors, DownvoteOptions, DownvoteResponse, DownvoteApplicationErrors, RemoveVoteOptions, RemoveVoteResponse, RemoveVoteApplicationErrors, VoteContextResourceVoteChangeEnvelope, VoteCastEnvelope, VoteDeletedEnvelope, VoteQuery, QueryVotesOptions, typedQueryVotes, VotesQueryBuilder } from './index.typings.mjs';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, BaseEventMetadata, CommonQueryWithEntityContext, ContextData, ContextResourceVoteChange, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, DownvoteRequest, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetResourceVoteSummaryRequest, GetResourceVoteSummaryResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, IdentityTypeWithLiterals, ImportVote, ImportVoteRequest, MessageEnvelope, Paging, PagingMetadataV2, QueryV2, QueryV2PagingMethodOneOf, QueryVotesApplicationErrors, QueryVotesRequest, QueryVotesResponse, RemoveVoteRequest, ResourceVoteSummary, RestoreInfo, SocialIdentity, SortOrder, SortOrderWithLiterals, Sorting, Type, TypeWithLiterals, UpdateVoteRequest, UpdateVoteResponse, UpvoteRequest, Vote, VoteCast, VoteContext, VoteDeleted, VoteQuerySpec, VotesQueryResult, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.mjs';
+
+declare function upvote$1(httpClient: HttpClient): UpvoteSignature;
+interface UpvoteSignature {
+    /**
+     * Casts an upvote on a resource for the current identity.
+     * Changes an existing downvote to an upvote. Repeating an upvote does not remove it.
+     * Provide contextData for the app and context. Context voting permissions apply.
+     * Authorization is enforced by the service for the current identity and context.
+     */
+    (options?: NonNullablePaths<UpvoteOptions, `resourceFqdn` | `resourceId`, 2>): Promise<NonNullablePaths<UpvoteResponse, `vote.resourceId` | `vote.resourceFqdn` | `vote.voteId` | `vote.type` | `vote.createdBy.identityId` | `vote.createdBy.identityType` | `vote.context.contextId` | `vote.context.appDefId` | `vote.context.metaSiteId` | `vote.revision`, 4> & {
+        __applicationErrorsType?: UpvoteApplicationErrors;
+    }>;
+}
+declare function downvote$1(httpClient: HttpClient): DownvoteSignature;
+interface DownvoteSignature {
+    /**
+     * Casts a downvote on a resource for the current identity.
+     * Changes an existing upvote to a downvote. Use RemoveVote to clear a vote.
+     * Provide contextData for the app and context. Context voting permissions apply.
+     * Authorization is enforced by the service for the current identity and context.
+     */
+    (options?: NonNullablePaths<DownvoteOptions, `resourceFqdn` | `resourceId`, 2>): Promise<NonNullablePaths<DownvoteResponse, `vote.resourceId` | `vote.resourceFqdn` | `vote.voteId` | `vote.type` | `vote.createdBy.identityId` | `vote.createdBy.identityType` | `vote.context.contextId` | `vote.context.appDefId` | `vote.context.metaSiteId` | `vote.revision`, 4> & {
+        __applicationErrorsType?: DownvoteApplicationErrors;
+    }>;
+}
+declare function removeVote$1(httpClient: HttpClient): RemoveVoteSignature;
+interface RemoveVoteSignature {
+    /**
+     * Removes the current identity's vote in the specified context and returns it.
+     * Obtain voteId from a vote response or QueryVotes. A repeated removal can fail.
+     * Authorization is enforced by the service for the current identity and context.
+     * @param - id of the vote which will be deleted
+     */
+    (voteId: string, options?: RemoveVoteOptions): Promise<NonNullablePaths<RemoveVoteResponse, `vote.resourceId` | `vote.resourceFqdn` | `vote.voteId` | `vote.type` | `vote.createdBy.identityId` | `vote.createdBy.identityType` | `vote.context.contextId` | `vote.context.appDefId` | `vote.context.metaSiteId` | `vote.revision`, 4> & {
+        __applicationErrorsType?: RemoveVoteApplicationErrors;
+    }>;
+}
+declare const onVoteContextResourceVoteChange$1: EventDefinition<VoteContextResourceVoteChangeEnvelope, "wix.comments.v1.vote_context_resource_vote_change">;
+declare const onVoteCast$1: EventDefinition<VoteCastEnvelope, "wix.comments.v1.vote_vote_cast">;
+declare const onVoteDeleted$1: EventDefinition<VoteDeletedEnvelope, "wix.comments.v1.vote_vote_deleted">;
+
+declare function customQueryVotes(httpClient: HttpClient): {
+    (query: VoteQuery, options?: QueryVotesOptions): ReturnType<typeof typedQueryVotes>;
+    (options?: QueryVotesOptions): VotesQueryBuilder;
+};
+declare const upvote: MaybeContext<BuildRESTFunction<typeof upvote$1> & typeof upvote$1>;
+declare const downvote: MaybeContext<BuildRESTFunction<typeof downvote$1> & typeof downvote$1>;
+declare const removeVote: MaybeContext<BuildRESTFunction<typeof removeVote$1> & typeof removeVote$1>;
+declare const queryVotes: MaybeContext<BuildRESTFunction<typeof customQueryVotes> & typeof customQueryVotes>;
+/** */
+declare const onVoteContextResourceVoteChange: BuildEventDefinition<typeof onVoteContextResourceVoteChange$1> & typeof onVoteContextResourceVoteChange$1;
+/** */
+declare const onVoteCast: BuildEventDefinition<typeof onVoteCast$1> & typeof onVoteCast$1;
+/** */
+declare const onVoteDeleted: BuildEventDefinition<typeof onVoteDeleted$1> & typeof onVoteDeleted$1;
+
+export { DownvoteApplicationErrors, DownvoteOptions, DownvoteResponse, QueryVotesOptions, RemoveVoteApplicationErrors, RemoveVoteOptions, RemoveVoteResponse, UpvoteApplicationErrors, UpvoteOptions, UpvoteResponse, VoteCastEnvelope, VoteContextResourceVoteChangeEnvelope, VoteDeletedEnvelope, VoteQuery, VotesQueryBuilder, downvote, onVoteCast, onVoteContextResourceVoteChange, onVoteDeleted, queryVotes, removeVote, upvote };