@wix/auto_sdk_blog_likes 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,629 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A like represents a user's positive reaction to blog content.
+ *
+ * Likes are associated with specific blog content using their FQDN (fully qualified domain name) and entity ID,
+ * allowing likes to be created for various types of blog content such as posts or comments.
+ */
+interface Like {
+    /**
+     * Like ID.
+     * @immutable
+     * @format GUID
+     */
+    _id?: string | null;
+    /**
+     * Date and time the like was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * ID of the specific blog content being liked, such as a blog post or comment.
+     * @format GUID
+     */
+    entityId?: string | null;
+    /**
+     * Fully qualified domain name that identifies the type of blog content being liked. For example, `wix.blog.v3.post` for blog posts.
+     * @maxLength 256
+     */
+    fqdn?: string | null;
+}
+interface CreateLikeRequest {
+    /** Like to create. */
+    like?: Like;
+}
+interface CreateLikeResponse {
+    /** Created like. */
+    like?: Like;
+}
+interface GetLikeRequest {
+    /**
+     * Like ID.
+     * @format GUID
+     */
+    likeId: string | null;
+}
+interface GetLikeResponse {
+    /** Retrieved like. */
+    like?: Like;
+}
+interface GetLikeByFqdnAndEntityIdRequest {
+    /**
+     * Fully qualified domain name that identifies the type of blog content being liked. For example, `wix.blog.v3.post` for blog posts.
+     * @maxLength 256
+     */
+    fqdn?: string | null;
+    /**
+     * ID of the liked entity.
+     * @format GUID
+     */
+    entityId?: string | null;
+}
+interface GetLikeByFqdnAndEntityIdResponse {
+    /** Retrieved like. */
+    like?: Like;
+}
+interface QueryLikesRequest {
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryLikesResponse {
+    /** Retrieved likes. */
+    likes?: Like[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface CountLikesRequest {
+    /**
+     * Fully qualified domain name of the liked entity. For example, `wix.blog.v3.post`.
+     * @maxLength 256
+     */
+    fqdn?: string | null;
+    /**
+     * User identity ID.
+     * @format GUID
+     */
+    identityId?: string | null;
+}
+interface CountLikesResponse {
+    /** Number of likes. */
+    count?: number;
+}
+interface DeleteLikeRequest {
+    /**
+     * ID of the like to delete.
+     * @format GUID
+     */
+    likeId: string | null;
+}
+interface DeleteLikeResponse {
+}
+interface DeleteLikeByFqdnAndEntityIdRequest {
+    /**
+     * Fully qualified domain name that identifies the type of blog content being liked. For example, `wix.blog.v3.post` for blog posts.
+     * @maxLength 256
+     */
+    fqdn: string | null;
+    /**
+     * ID of the specific blog content being liked.
+     * @format GUID
+     */
+    entityId: string | null;
+}
+interface DeleteLikeByFqdnAndEntityIdResponse {
+}
+interface BulkCreateLikesMigrationRequest {
+    /**
+     * Likes to create.
+     * @minSize 1
+     * @maxSize 50
+     */
+    likes?: MigrationLike[];
+}
+/** Like object used for migration purposes with additional user identity fields. */
+interface MigrationLike {
+    /** Date and time the like was created. */
+    _createdDate?: Date | null;
+    /**
+     * ID of the liked entity.
+     * @format GUID
+     */
+    entityId?: string | null;
+    /**
+     * ID of the member who created the like.
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * ID of the anonymous user who created the like.
+     * @format GUID
+     */
+    anonymousUserId?: string | null;
+}
+interface BulkCreateLikesMigrationResponse {
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+    /** Metadata for each created like. */
+    itemMetadata?: ItemMetadata[];
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface CountLikesMigrationRequest {
+}
+interface CountLikesMigrationResponse {
+    /** Total number of likes. */
+    count?: number;
+}
+interface QueryLikesMigrationRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+interface QueryLikesMigrationResponse {
+    /** Retrieved likes. */
+    likes?: Like[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface LikeCreatedEnvelope {
+    entity: Like;
+    metadata: EventMetadata;
+}
+/**
+ * Triggers when a like is created.
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @permissionId BLOG.LIKE_READ
+ * @webhook
+ * @eventType wix.blog.v1.like_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onLikeCreated(handler: (event: LikeCreatedEnvelope) => void | Promise<void>): void;
+interface LikeDeletedEnvelope {
+    entity: Like;
+    metadata: EventMetadata;
+}
+/**
+ * Triggers when a like is deleted.
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @permissionId BLOG.LIKE_READ
+ * @webhook
+ * @eventType wix.blog.v1.like_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onLikeDeleted(handler: (event: LikeDeletedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a like for blog content.
+ *
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/make-api-calls-with-oauth).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.like.entityId
+ * @requiredField options.like.fqdn
+ * @permissionId BLOG.LIKE_CREATE
+ * @applicableIdentity APP
+ * @returns Created like.
+ * @fqn wix.blog.v1.LikeService.CreateLike
+ */
+declare function createLike(options?: NonNullablePaths<CreateLikeOptions, `like.entityId` | `like.fqdn`, 3>): Promise<Like>;
+interface CreateLikeOptions {
+    /** Like to create. */
+    like?: Like;
+}
+/**
+ * Retrieves a like.
+ * @param likeId - Like ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField likeId
+ * @permissionId BLOG.LIKE_READ
+ * @applicableIdentity APP
+ * @returns Retrieved like.
+ * @fqn wix.blog.v1.LikeService.GetLike
+ */
+declare function getLike(likeId: string): Promise<Like>;
+/**
+ * Retrieves a list of likes, given the provided paging, filtering, and sorting.
+ *
+ * Up to 100 likes can be returned per request.
+ *
+ * Query Likes runs with these defaults, which you can override:
+ *
+ * - `createdDate` is sorted in `DESC` order
+ * - `paging.limit` is `50`
+ * - `paging.offset` is `0`
+ *
+ * For field support for filters and sorting, see [Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/blog/likes/supported-filters-and-sorting).
+ *
+ * To learn how to query likes, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BLOG.LIKE_READ
+ * @applicableIdentity APP
+ * @fqn wix.blog.v1.LikeService.QueryLikes
+ */
+declare function queryLikes(): LikesQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface LikesQueryResult extends QueryCursorResult {
+    items: Like[];
+    query: LikesQueryBuilder;
+    next: () => Promise<LikesQueryResult>;
+    prev: () => Promise<LikesQueryResult>;
+}
+interface LikesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'entityId' | 'fqdn', value: any) => LikesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | 'entityId' | 'fqdn', value: any) => LikesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'entityId' | 'fqdn', value: any) => LikesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => LikesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => LikesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<LikesQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.blog.v1.LikeService.QueryLikes
+ * @requiredField query
+ */
+declare function typedQueryLikes(query: CursorQuery): Promise<NonNullablePaths<QueryLikesResponse, `likes`, 2>>;
+/**
+ * Deletes a like.
+ * @param likeId - ID of the like to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField likeId
+ * @permissionId BLOG.LIKE_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.blog.v1.LikeService.DeleteLike
+ */
+declare function deleteLike(likeId: string): Promise<void>;
+/**
+ * Deletes a site visitors' or members' like by blog content FQDN and entity ID.
+ *
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/make-api-calls-with-oauth).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.entityId
+ * @requiredField identifiers.fqdn
+ * @permissionId BLOG.LIKE_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.blog.v1.LikeService.DeleteLikeByFqdnAndEntityId
+ */
+declare function deleteLikeByFqdnAndEntityId(identifiers: NonNullablePaths<DeleteLikeByFqdnAndEntityIdIdentifiers, `entityId` | `fqdn`, 2>): Promise<void>;
+interface DeleteLikeByFqdnAndEntityIdIdentifiers {
+    /**
+     * Fully qualified domain name that identifies the type of blog content being liked. For example, `wix.blog.v3.post` for blog posts.
+     * @maxLength 256
+     */
+    fqdn: string | null;
+    /**
+     * ID of the specific blog content being liked.
+     * @format GUID
+     */
+    entityId: string | null;
+}
+
+export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateLikesMigrationRequest, type BulkCreateLikesMigrationResponse, type CountLikesMigrationRequest, type CountLikesMigrationResponse, type CountLikesRequest, type CountLikesResponse, type CreateLikeOptions, type CreateLikeRequest, type CreateLikeResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteLikeByFqdnAndEntityIdIdentifiers, type DeleteLikeByFqdnAndEntityIdRequest, type DeleteLikeByFqdnAndEntityIdResponse, type DeleteLikeRequest, type DeleteLikeResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetLikeByFqdnAndEntityIdRequest, type GetLikeByFqdnAndEntityIdResponse, type GetLikeRequest, type GetLikeResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type Like, type LikeCreatedEnvelope, type LikeDeletedEnvelope, type LikesQueryBuilder, type LikesQueryResult, type MessageEnvelope, type MigrationLike, type QueryLikesMigrationRequest, type QueryLikesMigrationResponse, type QueryLikesRequest, type QueryLikesResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createLike, deleteLike, deleteLikeByFqdnAndEntityId, getLike, onLikeCreated, onLikeDeleted, queryLikes, typedQueryLikes };