@wix/auto_sdk_blog_likes 1.0.0

package/build/internal/cjs/meta.d.ts

@@ -0,0 +1,440 @@
+import { CreateLikeRequest as CreateLikeRequest$1, CreateLikeResponse as CreateLikeResponse$1, GetLikeRequest as GetLikeRequest$1, GetLikeResponse as GetLikeResponse$1, QueryLikesRequest as QueryLikesRequest$1, QueryLikesResponse as QueryLikesResponse$1, DeleteLikeRequest as DeleteLikeRequest$1, DeleteLikeResponse as DeleteLikeResponse$1, DeleteLikeByFqdnAndEntityIdRequest as DeleteLikeByFqdnAndEntityIdRequest$1, DeleteLikeByFqdnAndEntityIdResponse as DeleteLikeByFqdnAndEntityIdResponse$1 } from './index.typings.js';
+import '@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 {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: 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';
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createLike(): __PublicMethodMetaInfo<'POST', {}, CreateLikeRequest$1, CreateLikeRequest, CreateLikeResponse$1, CreateLikeResponse>;
+declare function getLike(): __PublicMethodMetaInfo<'GET', {
+    likeId: string;
+}, GetLikeRequest$1, GetLikeRequest, GetLikeResponse$1, GetLikeResponse>;
+declare function queryLikes(): __PublicMethodMetaInfo<'POST', {}, QueryLikesRequest$1, QueryLikesRequest, QueryLikesResponse$1, QueryLikesResponse>;
+declare function deleteLike(): __PublicMethodMetaInfo<'DELETE', {
+    likeId: string;
+}, DeleteLikeRequest$1, DeleteLikeRequest, DeleteLikeResponse$1, DeleteLikeResponse>;
+declare function deleteLikeByFqdnAndEntityId(): __PublicMethodMetaInfo<'DELETE', {
+    fqdn: string;
+    entityId: string;
+}, DeleteLikeByFqdnAndEntityIdRequest$1, DeleteLikeByFqdnAndEntityIdRequest, DeleteLikeByFqdnAndEntityIdResponse$1, DeleteLikeByFqdnAndEntityIdResponse>;
+
+export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateLikesMigrationRequest as BulkCreateLikesMigrationRequestOriginal, type BulkCreateLikesMigrationResponse as BulkCreateLikesMigrationResponseOriginal, type CountLikesMigrationRequest as CountLikesMigrationRequestOriginal, type CountLikesMigrationResponse as CountLikesMigrationResponseOriginal, type CountLikesRequest as CountLikesRequestOriginal, type CountLikesResponse as CountLikesResponseOriginal, type CreateLikeRequest as CreateLikeRequestOriginal, type CreateLikeResponse as CreateLikeResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteLikeByFqdnAndEntityIdRequest as DeleteLikeByFqdnAndEntityIdRequestOriginal, type DeleteLikeByFqdnAndEntityIdResponse as DeleteLikeByFqdnAndEntityIdResponseOriginal, type DeleteLikeRequest as DeleteLikeRequestOriginal, type DeleteLikeResponse as DeleteLikeResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GetLikeByFqdnAndEntityIdRequest as GetLikeByFqdnAndEntityIdRequestOriginal, type GetLikeByFqdnAndEntityIdResponse as GetLikeByFqdnAndEntityIdResponseOriginal, type GetLikeRequest as GetLikeRequestOriginal, type GetLikeResponse as GetLikeResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type Like as LikeOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MigrationLike as MigrationLikeOriginal, type QueryLikesMigrationRequest as QueryLikesMigrationRequestOriginal, type QueryLikesMigrationResponse as QueryLikesMigrationResponseOriginal, type QueryLikesRequest as QueryLikesRequestOriginal, type QueryLikesResponse as QueryLikesResponseOriginal, type RestoreInfo as RestoreInfoOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createLike, deleteLike, deleteLikeByFqdnAndEntityId, getLike, queryLikes };