@wix/auto_sdk_promote-growth-tools-publisher_items 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,157 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { PublishItemOptions, PublishItemResponse, PublishItemApplicationErrors, PublishItemByIdOptions, PublishItemByIdResponse, PublishItemByIdApplicationErrors, CreateDraftItemOptions, Item, GetItemsResponse, Query, QueryItemsResponse, CancelScheduledItemResponse, CancelScheduledItemApplicationErrors, UpdateItem, UpdateItemApplicationErrors, RescheduleItemOptions, RescheduleItemResponse, RescheduleItemApplicationErrors, DeleteItemApplicationErrors, BulkPublishItemsOptions, BulkPublishItemsResponse, ItemPublishFailedEnvelope, ItemPublishScheduledEnvelope, ItemPublishStartedEnvelope, ItemPublishedEnvelope } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkItemsResult, BulkPublishItemsPolicy, BulkPublishItemsPolicyWithLiterals, BulkPublishItemsRequest, CancelScheduledItemRequest, Channel, ChannelName, ChannelNameWithLiterals, ConsumerInfo, ConsumerType, ConsumerTypeWithLiterals, ConversionFunnel, CreateDraftItemRequest, CreateDraftItemResponse, DeleteItemRequest, DeleteItemResponse, DomainEvent, DomainEventBodyOneOf, DraftInfo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FacebokActivity, FacebookImpressions, FacebookInsights, FacebookInteractions, FacebookPost, FacebookPostUrlOneOf, FacebookReactions, FacebookReel, FacebookStory, GbpInsights, GbpPost, GbpPostCallToAction, GbpPostCallToActionType, GbpPostCallToActionTypeWithLiterals, GetItemRequest, GetItemResponse, GetItemsRequest, GetOrCreateWixelBindingByFileRequest, GetOrCreateWixelBindingByFileResponse, IdentificationData, IdentificationDataIdOneOf, InsightsSummary, InstagramInsights, InstagramPost, InstagramPostUrlOneOf, InstagramStory, InstagramStoryInsights, IsEligibleForSchedulingRequest, IsEligibleForSchedulingResponse, ItemDataOneOf, ItemExtras, ItemMetadata, ItemPublishFailed, ItemPublishScheduled, ItemPublishStarted, ItemPublished, ItemType, ItemTypeWithLiterals, LinkMetadata, LinkedinPost, LinkedinPostInsights, LinkedinPostUrlOneOf, Media, MediaType, MediaTypeWithLiterals, MediaWrapper, MessageEnvelope, Paging, PagingMetadata, PinterestInsights, PinterestPost, PublicationErrorDetails, PublishDraftRequest, PublishDraftResponse, PublishItemByIdRequest, PublishItemRequest, PublishingTarget, QueryItemsRequest, RescheduleItemRequest, RestoreInfo, SchedulingInfo, SchedulingRestrictedReason, SchedulingRestrictedReasonWithLiterals, SiteAnalytics, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, TikTokInsights, TikTokPhoto, TikTokPrivacyLevel, TikTokPrivacyLevelWithLiterals, TikTokVideo, TwitterInsights, TwitterPost, TwitterPostUrlOneOf, UpdateItemRequest, UpdateItemResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, YouTubeShort, YouTubeVideo, YoutubeInsights } from './index.typings.js';
+
+declare function publishItem$1(httpClient: HttpClient): PublishItemSignature;
+interface PublishItemSignature {
+    /**
+     * Publishes an item to a connected social channel.
+     *
+     * Use this method to publish a fully-formed post in a single call. To publish a previously created draft, call Publish Item By ID. To save a post without publishing it, call Create Draft Item. To schedule the post, set `item.schedulingInfo.scheduledDate`; otherwise it's published immediately.
+     *
+     * Published items appear on the site's Social Media Marketing page in the dashboard.
+     */
+    (options?: NonNullablePaths<PublishItemOptions, `item.channel` | `item.channel.accountId`, 4>): Promise<NonNullablePaths<PublishItemResponse, `item.instagramPost.mediaWrapper.media` | `item.instagramPost.mediaWrapper.media.${number}.type` | `item.instagramPost.insights.likes` | `item.instagramPost.insights.engagement` | `item.instagramPost.insights.impressions` | `item.instagramPost.insights.plays` | `item.instagramPost.insights.reach` | `item.instagramPost.insights.comments` | `item.instagramPost.insights.shares` | `item.instagramPost.insights.saved` | `item.instagramPost.insights.totalInteractions` | `item.instagramStory.insights.impressions` | `item.instagramStory.insights.reach` | `item.instagramStory.insights.replies` | `item.facebookPost.insights.impressions.unique` | `item.facebookPost.insights.impressions.total` | `item.facebookPost.insights.interactions.unique` | `item.facebookPost.insights.interactions.total` | `item.facebookPost.insights.reactions.like` | `item.facebookPost.insights.reactions.love` | `item.facebookPost.insights.reactions.wow` | `item.facebookPost.insights.reactions.haha` | `item.facebookPost.insights.reactions.sad` | `item.facebookPost.insights.reactions.anger` | `item.facebookPost.insights.activity.share` | `item.facebookPost.insights.activity.like` | `item.facebookPost.insights.activity.comment` | `item.youtubeVideo.notifySubscribers` | `item.youtubeVideo.insights.views` | `item.youtubeVideo.insights.comments` | `item.youtubeVideo.insights.likes` | `item.youtubeVideo.insights.dislikes` | `item.youtubeVideo.insights.shares` | `item.youtubeShort.notifySubscribers` | `item.linkedinPost.insights.uniqueImpressions` | `item.linkedinPost.insights.impression` | `item.linkedinPost.insights.shares` | `item.linkedinPost.insights.engagement` | `item.linkedinPost.insights.clicks` | `item.linkedinPost.insights.likes` | `item.linkedinPost.insights.comments` | `item.twitterPost.insights.retweets` | `item.twitterPost.insights.replies` | `item.twitterPost.insights.likes` | `item.twitterPost.insights.quotes` | `item.twitterPost.insights.bookmarks` | `item.twitterPost.insights.impressions` | `item.pinterestPost.insights.impressions` | `item.pinterestPost.insights.clicks` | `item.pinterestPost.insights.saves` | `item.pinterestPost.insights.comments` | `item.pinterestPost.insights.reactions` | `item.gbpPost.callToAction.actionType` | `item.gbpPost.insights.shares` | `item.tiktokVideo.privacyLevel` | `item.tiktokVideo.disableComment` | `item.tiktokVideo.disableDuet` | `item.tiktokVideo.disableStitch` | `item.tiktokVideo.brandContentToggle` | `item.tiktokVideo.brandOrganicToggle` | `item.tiktokVideo.insights.views` | `item.tiktokVideo.insights.likes` | `item.tiktokVideo.insights.comments` | `item.tiktokVideo.insights.shares` | `item.tiktokPhoto.privacyLevel` | `item.tiktokPhoto.disableComment` | `item.tiktokPhoto.autoAddMusic` | `item.tiktokPhoto.brandContentToggle` | `item.tiktokPhoto.brandOrganicToggle` | `item.channel.name` | `item.type` | `item.status` | `item.siteAnalytics.traffic` | `item.siteAnalytics.pageView` | `item.siteAnalytics.siteBounceRate` | `item.siteAnalytics.revenue` | `item.siteAnalytics.conversionFunnel.cartViewsSessions` | `item.siteAnalytics.conversionFunnel.checkOutSessions` | `item.siteAnalytics.conversionFunnel.storeOrdersSessions` | `item.siteAnalytics.conversionFunnel.bookingsConfirmed` | `item.insightsSummary.impressions` | `item.insightsSummary.interactions` | `item.insightsSummary.impressionsTotal` | `item.suggested` | `item.external`, 7> & {
+        __applicationErrorsType?: PublishItemApplicationErrors;
+    }>;
+}
+declare function publishItemById$1(httpClient: HttpClient): PublishItemByIdSignature;
+interface PublishItemByIdSignature {
+    /**
+     * Publishes a previously created item by its `id`.
+     *
+     * The item can be a draft or a scheduled item. To schedule the item for a future date, set `scheduledDate`; otherwise it's published immediately.
+     *
+     * Published items appear on the site's Social Media Marketing page in the dashboard.
+     * @param - ID of the item to publish.
+     */
+    (_id: string, options?: PublishItemByIdOptions): Promise<NonNullablePaths<PublishItemByIdResponse, `item.instagramPost.mediaWrapper.media` | `item.instagramPost.mediaWrapper.media.${number}.type` | `item.instagramPost.insights.likes` | `item.instagramPost.insights.engagement` | `item.instagramPost.insights.impressions` | `item.instagramPost.insights.plays` | `item.instagramPost.insights.reach` | `item.instagramPost.insights.comments` | `item.instagramPost.insights.shares` | `item.instagramPost.insights.saved` | `item.instagramPost.insights.totalInteractions` | `item.instagramStory.insights.impressions` | `item.instagramStory.insights.reach` | `item.instagramStory.insights.replies` | `item.facebookPost.insights.impressions.unique` | `item.facebookPost.insights.impressions.total` | `item.facebookPost.insights.interactions.unique` | `item.facebookPost.insights.interactions.total` | `item.facebookPost.insights.reactions.like` | `item.facebookPost.insights.reactions.love` | `item.facebookPost.insights.reactions.wow` | `item.facebookPost.insights.reactions.haha` | `item.facebookPost.insights.reactions.sad` | `item.facebookPost.insights.reactions.anger` | `item.facebookPost.insights.activity.share` | `item.facebookPost.insights.activity.like` | `item.facebookPost.insights.activity.comment` | `item.youtubeVideo.notifySubscribers` | `item.youtubeVideo.insights.views` | `item.youtubeVideo.insights.comments` | `item.youtubeVideo.insights.likes` | `item.youtubeVideo.insights.dislikes` | `item.youtubeVideo.insights.shares` | `item.youtubeShort.notifySubscribers` | `item.linkedinPost.insights.uniqueImpressions` | `item.linkedinPost.insights.impression` | `item.linkedinPost.insights.shares` | `item.linkedinPost.insights.engagement` | `item.linkedinPost.insights.clicks` | `item.linkedinPost.insights.likes` | `item.linkedinPost.insights.comments` | `item.twitterPost.insights.retweets` | `item.twitterPost.insights.replies` | `item.twitterPost.insights.likes` | `item.twitterPost.insights.quotes` | `item.twitterPost.insights.bookmarks` | `item.twitterPost.insights.impressions` | `item.pinterestPost.insights.impressions` | `item.pinterestPost.insights.clicks` | `item.pinterestPost.insights.saves` | `item.pinterestPost.insights.comments` | `item.pinterestPost.insights.reactions` | `item.gbpPost.callToAction.actionType` | `item.gbpPost.insights.shares` | `item.tiktokVideo.privacyLevel` | `item.tiktokVideo.disableComment` | `item.tiktokVideo.disableDuet` | `item.tiktokVideo.disableStitch` | `item.tiktokVideo.brandContentToggle` | `item.tiktokVideo.brandOrganicToggle` | `item.tiktokVideo.insights.views` | `item.tiktokVideo.insights.likes` | `item.tiktokVideo.insights.comments` | `item.tiktokVideo.insights.shares` | `item.tiktokPhoto.privacyLevel` | `item.tiktokPhoto.disableComment` | `item.tiktokPhoto.autoAddMusic` | `item.tiktokPhoto.brandContentToggle` | `item.tiktokPhoto.brandOrganicToggle` | `item.channel.name` | `item.type` | `item.status` | `item.siteAnalytics.traffic` | `item.siteAnalytics.pageView` | `item.siteAnalytics.siteBounceRate` | `item.siteAnalytics.revenue` | `item.siteAnalytics.conversionFunnel.cartViewsSessions` | `item.siteAnalytics.conversionFunnel.checkOutSessions` | `item.siteAnalytics.conversionFunnel.storeOrdersSessions` | `item.siteAnalytics.conversionFunnel.bookingsConfirmed` | `item.insightsSummary.impressions` | `item.insightsSummary.interactions` | `item.insightsSummary.impressionsTotal` | `item.suggested` | `item.external`, 7> & {
+        __applicationErrorsType?: PublishItemByIdApplicationErrors;
+    }>;
+}
+declare function createDraftItem$1(httpClient: HttpClient): CreateDraftItemSignature;
+interface CreateDraftItemSignature {
+    /**
+     * Creates a draft item.
+     *
+     * A draft is an item that's saved but not yet published, with a `status` of `DRAFT`. Drafts appear on the site's Social Media Marketing page in the dashboard, where they can be reviewed and published. To publish a draft, call Publish Item By ID.
+     *
+     * The item's `type` and content must match a combination supported by the target channel. See `item.type` for the supported combinations.
+     * @returns Created draft item.
+     */
+    (options?: NonNullablePaths<CreateDraftItemOptions, `item.channel`, 3>): Promise<NonNullablePaths<Item, `instagramPost.mediaWrapper.media` | `instagramPost.mediaWrapper.media.${number}.type` | `instagramPost.insights.likes` | `instagramPost.insights.engagement` | `instagramPost.insights.impressions` | `instagramPost.insights.plays` | `instagramPost.insights.reach` | `instagramPost.insights.comments` | `instagramPost.insights.shares` | `instagramPost.insights.saved` | `instagramPost.insights.totalInteractions` | `instagramStory.insights.impressions` | `instagramStory.insights.reach` | `instagramStory.insights.replies` | `facebookPost.insights.impressions.unique` | `facebookPost.insights.impressions.total` | `facebookPost.insights.interactions.unique` | `facebookPost.insights.interactions.total` | `facebookPost.insights.reactions.like` | `facebookPost.insights.reactions.love` | `facebookPost.insights.reactions.wow` | `facebookPost.insights.reactions.haha` | `facebookPost.insights.reactions.sad` | `facebookPost.insights.reactions.anger` | `facebookPost.insights.activity.share` | `facebookPost.insights.activity.like` | `facebookPost.insights.activity.comment` | `youtubeVideo.notifySubscribers` | `youtubeVideo.insights.views` | `youtubeVideo.insights.comments` | `youtubeVideo.insights.likes` | `youtubeVideo.insights.dislikes` | `youtubeVideo.insights.shares` | `youtubeShort.notifySubscribers` | `linkedinPost.insights.uniqueImpressions` | `linkedinPost.insights.impression` | `linkedinPost.insights.shares` | `linkedinPost.insights.engagement` | `linkedinPost.insights.clicks` | `linkedinPost.insights.likes` | `linkedinPost.insights.comments` | `twitterPost.insights.retweets` | `twitterPost.insights.replies` | `twitterPost.insights.likes` | `twitterPost.insights.quotes` | `twitterPost.insights.bookmarks` | `twitterPost.insights.impressions` | `pinterestPost.insights.impressions` | `pinterestPost.insights.clicks` | `pinterestPost.insights.saves` | `pinterestPost.insights.comments` | `pinterestPost.insights.reactions` | `gbpPost.callToAction.actionType` | `gbpPost.insights.shares` | `tiktokVideo.privacyLevel` | `tiktokVideo.disableComment` | `tiktokVideo.disableDuet` | `tiktokVideo.disableStitch` | `tiktokVideo.brandContentToggle` | `tiktokVideo.brandOrganicToggle` | `tiktokVideo.insights.views` | `tiktokVideo.insights.likes` | `tiktokVideo.insights.comments` | `tiktokVideo.insights.shares` | `tiktokPhoto.privacyLevel` | `tiktokPhoto.disableComment` | `tiktokPhoto.autoAddMusic` | `tiktokPhoto.brandContentToggle` | `tiktokPhoto.brandOrganicToggle` | `channel.name` | `type` | `status` | `siteAnalytics.traffic` | `siteAnalytics.pageView` | `siteAnalytics.siteBounceRate` | `siteAnalytics.revenue` | `siteAnalytics.conversionFunnel.cartViewsSessions` | `siteAnalytics.conversionFunnel.checkOutSessions` | `siteAnalytics.conversionFunnel.storeOrdersSessions` | `siteAnalytics.conversionFunnel.bookingsConfirmed` | `insightsSummary.impressions` | `insightsSummary.interactions` | `insightsSummary.impressionsTotal` | `suggested` | `external`, 6>>;
+}
+declare function getItem$1(httpClient: HttpClient): GetItemSignature;
+interface GetItemSignature {
+    /**
+     * Retrieves an item by ID.
+     * @param - ID of the item to retrieve.
+     * @returns Retrieved item.
+     */
+    (_id: string): Promise<NonNullablePaths<Item, `instagramPost.mediaWrapper.media` | `instagramPost.mediaWrapper.media.${number}.type` | `instagramPost.insights.likes` | `instagramPost.insights.engagement` | `instagramPost.insights.impressions` | `instagramPost.insights.plays` | `instagramPost.insights.reach` | `instagramPost.insights.comments` | `instagramPost.insights.shares` | `instagramPost.insights.saved` | `instagramPost.insights.totalInteractions` | `instagramStory.insights.impressions` | `instagramStory.insights.reach` | `instagramStory.insights.replies` | `facebookPost.insights.impressions.unique` | `facebookPost.insights.impressions.total` | `facebookPost.insights.interactions.unique` | `facebookPost.insights.interactions.total` | `facebookPost.insights.reactions.like` | `facebookPost.insights.reactions.love` | `facebookPost.insights.reactions.wow` | `facebookPost.insights.reactions.haha` | `facebookPost.insights.reactions.sad` | `facebookPost.insights.reactions.anger` | `facebookPost.insights.activity.share` | `facebookPost.insights.activity.like` | `facebookPost.insights.activity.comment` | `youtubeVideo.notifySubscribers` | `youtubeVideo.insights.views` | `youtubeVideo.insights.comments` | `youtubeVideo.insights.likes` | `youtubeVideo.insights.dislikes` | `youtubeVideo.insights.shares` | `youtubeShort.notifySubscribers` | `linkedinPost.insights.uniqueImpressions` | `linkedinPost.insights.impression` | `linkedinPost.insights.shares` | `linkedinPost.insights.engagement` | `linkedinPost.insights.clicks` | `linkedinPost.insights.likes` | `linkedinPost.insights.comments` | `twitterPost.insights.retweets` | `twitterPost.insights.replies` | `twitterPost.insights.likes` | `twitterPost.insights.quotes` | `twitterPost.insights.bookmarks` | `twitterPost.insights.impressions` | `pinterestPost.insights.impressions` | `pinterestPost.insights.clicks` | `pinterestPost.insights.saves` | `pinterestPost.insights.comments` | `pinterestPost.insights.reactions` | `gbpPost.callToAction.actionType` | `gbpPost.insights.shares` | `tiktokVideo.privacyLevel` | `tiktokVideo.disableComment` | `tiktokVideo.disableDuet` | `tiktokVideo.disableStitch` | `tiktokVideo.brandContentToggle` | `tiktokVideo.brandOrganicToggle` | `tiktokVideo.insights.views` | `tiktokVideo.insights.likes` | `tiktokVideo.insights.comments` | `tiktokVideo.insights.shares` | `tiktokPhoto.privacyLevel` | `tiktokPhoto.disableComment` | `tiktokPhoto.autoAddMusic` | `tiktokPhoto.brandContentToggle` | `tiktokPhoto.brandOrganicToggle` | `channel.name` | `type` | `status` | `siteAnalytics.traffic` | `siteAnalytics.pageView` | `siteAnalytics.siteBounceRate` | `siteAnalytics.revenue` | `siteAnalytics.conversionFunnel.cartViewsSessions` | `siteAnalytics.conversionFunnel.checkOutSessions` | `siteAnalytics.conversionFunnel.storeOrdersSessions` | `siteAnalytics.conversionFunnel.bookingsConfirmed` | `insightsSummary.impressions` | `insightsSummary.interactions` | `insightsSummary.impressionsTotal` | `suggested` | `external`, 6>>;
+}
+declare function getItems$1(httpClient: HttpClient): GetItemsSignature;
+interface GetItemsSignature {
+    /**
+     * Retrieves a list of items by their IDs.
+     * @param - IDs of the items to retrieve.
+     */
+    (ids: string[]): Promise<NonNullablePaths<GetItemsResponse, `items` | `items.${number}.instagramPost.insights.likes` | `items.${number}.instagramPost.insights.engagement` | `items.${number}.instagramPost.insights.impressions` | `items.${number}.instagramPost.insights.plays` | `items.${number}.instagramPost.insights.reach` | `items.${number}.instagramPost.insights.comments` | `items.${number}.instagramPost.insights.shares` | `items.${number}.instagramPost.insights.saved` | `items.${number}.instagramPost.insights.totalInteractions` | `items.${number}.instagramStory.insights.impressions` | `items.${number}.instagramStory.insights.reach` | `items.${number}.instagramStory.insights.replies` | `items.${number}.youtubeVideo.notifySubscribers` | `items.${number}.youtubeVideo.insights.views` | `items.${number}.youtubeVideo.insights.comments` | `items.${number}.youtubeVideo.insights.likes` | `items.${number}.youtubeVideo.insights.dislikes` | `items.${number}.youtubeVideo.insights.shares` | `items.${number}.youtubeShort.notifySubscribers` | `items.${number}.linkedinPost.insights.uniqueImpressions` | `items.${number}.linkedinPost.insights.impression` | `items.${number}.linkedinPost.insights.shares` | `items.${number}.linkedinPost.insights.engagement` | `items.${number}.linkedinPost.insights.clicks` | `items.${number}.linkedinPost.insights.likes` | `items.${number}.linkedinPost.insights.comments` | `items.${number}.twitterPost.insights.retweets` | `items.${number}.twitterPost.insights.replies` | `items.${number}.twitterPost.insights.likes` | `items.${number}.twitterPost.insights.quotes` | `items.${number}.twitterPost.insights.bookmarks` | `items.${number}.twitterPost.insights.impressions` | `items.${number}.pinterestPost.insights.impressions` | `items.${number}.pinterestPost.insights.clicks` | `items.${number}.pinterestPost.insights.saves` | `items.${number}.pinterestPost.insights.comments` | `items.${number}.pinterestPost.insights.reactions` | `items.${number}.gbpPost.callToAction.actionType` | `items.${number}.gbpPost.insights.shares` | `items.${number}.tiktokVideo.privacyLevel` | `items.${number}.tiktokVideo.disableComment` | `items.${number}.tiktokVideo.disableDuet` | `items.${number}.tiktokVideo.disableStitch` | `items.${number}.tiktokVideo.brandContentToggle` | `items.${number}.tiktokVideo.brandOrganicToggle` | `items.${number}.tiktokVideo.insights.views` | `items.${number}.tiktokVideo.insights.likes` | `items.${number}.tiktokVideo.insights.comments` | `items.${number}.tiktokVideo.insights.shares` | `items.${number}.tiktokPhoto.privacyLevel` | `items.${number}.tiktokPhoto.disableComment` | `items.${number}.tiktokPhoto.autoAddMusic` | `items.${number}.tiktokPhoto.brandContentToggle` | `items.${number}.tiktokPhoto.brandOrganicToggle` | `items.${number}.channel.name` | `items.${number}.type` | `items.${number}.status` | `items.${number}.siteAnalytics.traffic` | `items.${number}.siteAnalytics.pageView` | `items.${number}.siteAnalytics.siteBounceRate` | `items.${number}.siteAnalytics.revenue` | `items.${number}.siteAnalytics.conversionFunnel.cartViewsSessions` | `items.${number}.siteAnalytics.conversionFunnel.checkOutSessions` | `items.${number}.siteAnalytics.conversionFunnel.storeOrdersSessions` | `items.${number}.siteAnalytics.conversionFunnel.bookingsConfirmed` | `items.${number}.insightsSummary.impressions` | `items.${number}.insightsSummary.interactions` | `items.${number}.insightsSummary.impressionsTotal` | `items.${number}.suggested` | `items.${number}.external`, 6>>;
+}
+declare function queryItems$1(httpClient: HttpClient): QueryItemsSignature;
+interface QueryItemsSignature {
+    /**
+     * Retrieves a list of items, given the provided paging, filtering, and sorting.
+     *
+     * Query Items runs with these defaults, which you can override:
+     * - `paging.limit` is `50`
+     * - `paging.offset` is `0`
+     *
+     * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
+     * @param - Query options, including paging, filtering, and sorting.
+     */
+    (query: Query): Promise<NonNullablePaths<QueryItemsResponse, `items` | `items.${number}.instagramPost.insights.likes` | `items.${number}.instagramPost.insights.engagement` | `items.${number}.instagramPost.insights.impressions` | `items.${number}.instagramPost.insights.plays` | `items.${number}.instagramPost.insights.reach` | `items.${number}.instagramPost.insights.comments` | `items.${number}.instagramPost.insights.shares` | `items.${number}.instagramPost.insights.saved` | `items.${number}.instagramPost.insights.totalInteractions` | `items.${number}.instagramStory.insights.impressions` | `items.${number}.instagramStory.insights.reach` | `items.${number}.instagramStory.insights.replies` | `items.${number}.youtubeVideo.notifySubscribers` | `items.${number}.youtubeVideo.insights.views` | `items.${number}.youtubeVideo.insights.comments` | `items.${number}.youtubeVideo.insights.likes` | `items.${number}.youtubeVideo.insights.dislikes` | `items.${number}.youtubeVideo.insights.shares` | `items.${number}.youtubeShort.notifySubscribers` | `items.${number}.linkedinPost.insights.uniqueImpressions` | `items.${number}.linkedinPost.insights.impression` | `items.${number}.linkedinPost.insights.shares` | `items.${number}.linkedinPost.insights.engagement` | `items.${number}.linkedinPost.insights.clicks` | `items.${number}.linkedinPost.insights.likes` | `items.${number}.linkedinPost.insights.comments` | `items.${number}.twitterPost.insights.retweets` | `items.${number}.twitterPost.insights.replies` | `items.${number}.twitterPost.insights.likes` | `items.${number}.twitterPost.insights.quotes` | `items.${number}.twitterPost.insights.bookmarks` | `items.${number}.twitterPost.insights.impressions` | `items.${number}.pinterestPost.insights.impressions` | `items.${number}.pinterestPost.insights.clicks` | `items.${number}.pinterestPost.insights.saves` | `items.${number}.pinterestPost.insights.comments` | `items.${number}.pinterestPost.insights.reactions` | `items.${number}.gbpPost.callToAction.actionType` | `items.${number}.gbpPost.insights.shares` | `items.${number}.tiktokVideo.privacyLevel` | `items.${number}.tiktokVideo.disableComment` | `items.${number}.tiktokVideo.disableDuet` | `items.${number}.tiktokVideo.disableStitch` | `items.${number}.tiktokVideo.brandContentToggle` | `items.${number}.tiktokVideo.brandOrganicToggle` | `items.${number}.tiktokVideo.insights.views` | `items.${number}.tiktokVideo.insights.likes` | `items.${number}.tiktokVideo.insights.comments` | `items.${number}.tiktokVideo.insights.shares` | `items.${number}.tiktokPhoto.privacyLevel` | `items.${number}.tiktokPhoto.disableComment` | `items.${number}.tiktokPhoto.autoAddMusic` | `items.${number}.tiktokPhoto.brandContentToggle` | `items.${number}.tiktokPhoto.brandOrganicToggle` | `items.${number}.channel.name` | `items.${number}.type` | `items.${number}.status` | `items.${number}.siteAnalytics.traffic` | `items.${number}.siteAnalytics.pageView` | `items.${number}.siteAnalytics.siteBounceRate` | `items.${number}.siteAnalytics.revenue` | `items.${number}.siteAnalytics.conversionFunnel.cartViewsSessions` | `items.${number}.siteAnalytics.conversionFunnel.checkOutSessions` | `items.${number}.siteAnalytics.conversionFunnel.storeOrdersSessions` | `items.${number}.siteAnalytics.conversionFunnel.bookingsConfirmed` | `items.${number}.insightsSummary.impressions` | `items.${number}.insightsSummary.interactions` | `items.${number}.insightsSummary.impressionsTotal` | `items.${number}.suggested` | `items.${number}.external`, 6>>;
+}
+declare function cancelScheduledItem$1(httpClient: HttpClient): CancelScheduledItemSignature;
+interface CancelScheduledItemSignature {
+    /**
+     * Cancels the scheduling of a scheduled item.
+     *
+     * The item is no longer published at its scheduled time. Only an item with a `status` of `SCHEDULED` can be canceled.
+     * @param - ID of the scheduled item to cancel.
+     */
+    (_id: string): Promise<NonNullablePaths<CancelScheduledItemResponse, `item.instagramPost.mediaWrapper.media` | `item.instagramPost.mediaWrapper.media.${number}.type` | `item.instagramPost.insights.likes` | `item.instagramPost.insights.engagement` | `item.instagramPost.insights.impressions` | `item.instagramPost.insights.plays` | `item.instagramPost.insights.reach` | `item.instagramPost.insights.comments` | `item.instagramPost.insights.shares` | `item.instagramPost.insights.saved` | `item.instagramPost.insights.totalInteractions` | `item.instagramStory.insights.impressions` | `item.instagramStory.insights.reach` | `item.instagramStory.insights.replies` | `item.facebookPost.insights.impressions.unique` | `item.facebookPost.insights.impressions.total` | `item.facebookPost.insights.interactions.unique` | `item.facebookPost.insights.interactions.total` | `item.facebookPost.insights.reactions.like` | `item.facebookPost.insights.reactions.love` | `item.facebookPost.insights.reactions.wow` | `item.facebookPost.insights.reactions.haha` | `item.facebookPost.insights.reactions.sad` | `item.facebookPost.insights.reactions.anger` | `item.facebookPost.insights.activity.share` | `item.facebookPost.insights.activity.like` | `item.facebookPost.insights.activity.comment` | `item.youtubeVideo.notifySubscribers` | `item.youtubeVideo.insights.views` | `item.youtubeVideo.insights.comments` | `item.youtubeVideo.insights.likes` | `item.youtubeVideo.insights.dislikes` | `item.youtubeVideo.insights.shares` | `item.youtubeShort.notifySubscribers` | `item.linkedinPost.insights.uniqueImpressions` | `item.linkedinPost.insights.impression` | `item.linkedinPost.insights.shares` | `item.linkedinPost.insights.engagement` | `item.linkedinPost.insights.clicks` | `item.linkedinPost.insights.likes` | `item.linkedinPost.insights.comments` | `item.twitterPost.insights.retweets` | `item.twitterPost.insights.replies` | `item.twitterPost.insights.likes` | `item.twitterPost.insights.quotes` | `item.twitterPost.insights.bookmarks` | `item.twitterPost.insights.impressions` | `item.pinterestPost.insights.impressions` | `item.pinterestPost.insights.clicks` | `item.pinterestPost.insights.saves` | `item.pinterestPost.insights.comments` | `item.pinterestPost.insights.reactions` | `item.gbpPost.callToAction.actionType` | `item.gbpPost.insights.shares` | `item.tiktokVideo.privacyLevel` | `item.tiktokVideo.disableComment` | `item.tiktokVideo.disableDuet` | `item.tiktokVideo.disableStitch` | `item.tiktokVideo.brandContentToggle` | `item.tiktokVideo.brandOrganicToggle` | `item.tiktokVideo.insights.views` | `item.tiktokVideo.insights.likes` | `item.tiktokVideo.insights.comments` | `item.tiktokVideo.insights.shares` | `item.tiktokPhoto.privacyLevel` | `item.tiktokPhoto.disableComment` | `item.tiktokPhoto.autoAddMusic` | `item.tiktokPhoto.brandContentToggle` | `item.tiktokPhoto.brandOrganicToggle` | `item.channel.name` | `item.type` | `item.status` | `item.siteAnalytics.traffic` | `item.siteAnalytics.pageView` | `item.siteAnalytics.siteBounceRate` | `item.siteAnalytics.revenue` | `item.siteAnalytics.conversionFunnel.cartViewsSessions` | `item.siteAnalytics.conversionFunnel.checkOutSessions` | `item.siteAnalytics.conversionFunnel.storeOrdersSessions` | `item.siteAnalytics.conversionFunnel.bookingsConfirmed` | `item.insightsSummary.impressions` | `item.insightsSummary.interactions` | `item.insightsSummary.impressionsTotal` | `item.suggested` | `item.external`, 7> & {
+        __applicationErrorsType?: CancelScheduledItemApplicationErrors;
+    }>;
+}
+declare function updateItem$1(httpClient: HttpClient): UpdateItemSignature;
+interface UpdateItemSignature {
+    /**
+     * Updates an item.
+     *
+     * Provide the `id` of the item to update along with the fields to change. Only the fields you include are changed. To change a scheduled item's publish date, call Reschedule Item instead.
+     * @param - Item ID.
+     * @returns Updated item.
+     */
+    (_id: string, item: UpdateItem): Promise<NonNullablePaths<Item, `instagramPost.mediaWrapper.media` | `instagramPost.mediaWrapper.media.${number}.type` | `instagramPost.insights.likes` | `instagramPost.insights.engagement` | `instagramPost.insights.impressions` | `instagramPost.insights.plays` | `instagramPost.insights.reach` | `instagramPost.insights.comments` | `instagramPost.insights.shares` | `instagramPost.insights.saved` | `instagramPost.insights.totalInteractions` | `instagramStory.insights.impressions` | `instagramStory.insights.reach` | `instagramStory.insights.replies` | `facebookPost.insights.impressions.unique` | `facebookPost.insights.impressions.total` | `facebookPost.insights.interactions.unique` | `facebookPost.insights.interactions.total` | `facebookPost.insights.reactions.like` | `facebookPost.insights.reactions.love` | `facebookPost.insights.reactions.wow` | `facebookPost.insights.reactions.haha` | `facebookPost.insights.reactions.sad` | `facebookPost.insights.reactions.anger` | `facebookPost.insights.activity.share` | `facebookPost.insights.activity.like` | `facebookPost.insights.activity.comment` | `youtubeVideo.notifySubscribers` | `youtubeVideo.insights.views` | `youtubeVideo.insights.comments` | `youtubeVideo.insights.likes` | `youtubeVideo.insights.dislikes` | `youtubeVideo.insights.shares` | `youtubeShort.notifySubscribers` | `linkedinPost.insights.uniqueImpressions` | `linkedinPost.insights.impression` | `linkedinPost.insights.shares` | `linkedinPost.insights.engagement` | `linkedinPost.insights.clicks` | `linkedinPost.insights.likes` | `linkedinPost.insights.comments` | `twitterPost.insights.retweets` | `twitterPost.insights.replies` | `twitterPost.insights.likes` | `twitterPost.insights.quotes` | `twitterPost.insights.bookmarks` | `twitterPost.insights.impressions` | `pinterestPost.insights.impressions` | `pinterestPost.insights.clicks` | `pinterestPost.insights.saves` | `pinterestPost.insights.comments` | `pinterestPost.insights.reactions` | `gbpPost.callToAction.actionType` | `gbpPost.insights.shares` | `tiktokVideo.privacyLevel` | `tiktokVideo.disableComment` | `tiktokVideo.disableDuet` | `tiktokVideo.disableStitch` | `tiktokVideo.brandContentToggle` | `tiktokVideo.brandOrganicToggle` | `tiktokVideo.insights.views` | `tiktokVideo.insights.likes` | `tiktokVideo.insights.comments` | `tiktokVideo.insights.shares` | `tiktokPhoto.privacyLevel` | `tiktokPhoto.disableComment` | `tiktokPhoto.autoAddMusic` | `tiktokPhoto.brandContentToggle` | `tiktokPhoto.brandOrganicToggle` | `channel.name` | `type` | `status` | `siteAnalytics.traffic` | `siteAnalytics.pageView` | `siteAnalytics.siteBounceRate` | `siteAnalytics.revenue` | `siteAnalytics.conversionFunnel.cartViewsSessions` | `siteAnalytics.conversionFunnel.checkOutSessions` | `siteAnalytics.conversionFunnel.storeOrdersSessions` | `siteAnalytics.conversionFunnel.bookingsConfirmed` | `insightsSummary.impressions` | `insightsSummary.interactions` | `insightsSummary.impressionsTotal` | `suggested` | `external`, 6> & {
+        __applicationErrorsType?: UpdateItemApplicationErrors;
+    }>;
+}
+declare function rescheduleItem$1(httpClient: HttpClient): RescheduleItemSignature;
+interface RescheduleItemSignature {
+    /**
+     * Changes the scheduled publish date of a scheduled item.
+     *
+     * Only an item with a `status` of `SCHEDULED` can be rescheduled.
+     * @param - ID of the scheduled item to reschedule.
+     */
+    (_id: string, options?: RescheduleItemOptions): Promise<NonNullablePaths<RescheduleItemResponse, `item.instagramPost.mediaWrapper.media` | `item.instagramPost.mediaWrapper.media.${number}.type` | `item.instagramPost.insights.likes` | `item.instagramPost.insights.engagement` | `item.instagramPost.insights.impressions` | `item.instagramPost.insights.plays` | `item.instagramPost.insights.reach` | `item.instagramPost.insights.comments` | `item.instagramPost.insights.shares` | `item.instagramPost.insights.saved` | `item.instagramPost.insights.totalInteractions` | `item.instagramStory.insights.impressions` | `item.instagramStory.insights.reach` | `item.instagramStory.insights.replies` | `item.facebookPost.insights.impressions.unique` | `item.facebookPost.insights.impressions.total` | `item.facebookPost.insights.interactions.unique` | `item.facebookPost.insights.interactions.total` | `item.facebookPost.insights.reactions.like` | `item.facebookPost.insights.reactions.love` | `item.facebookPost.insights.reactions.wow` | `item.facebookPost.insights.reactions.haha` | `item.facebookPost.insights.reactions.sad` | `item.facebookPost.insights.reactions.anger` | `item.facebookPost.insights.activity.share` | `item.facebookPost.insights.activity.like` | `item.facebookPost.insights.activity.comment` | `item.youtubeVideo.notifySubscribers` | `item.youtubeVideo.insights.views` | `item.youtubeVideo.insights.comments` | `item.youtubeVideo.insights.likes` | `item.youtubeVideo.insights.dislikes` | `item.youtubeVideo.insights.shares` | `item.youtubeShort.notifySubscribers` | `item.linkedinPost.insights.uniqueImpressions` | `item.linkedinPost.insights.impression` | `item.linkedinPost.insights.shares` | `item.linkedinPost.insights.engagement` | `item.linkedinPost.insights.clicks` | `item.linkedinPost.insights.likes` | `item.linkedinPost.insights.comments` | `item.twitterPost.insights.retweets` | `item.twitterPost.insights.replies` | `item.twitterPost.insights.likes` | `item.twitterPost.insights.quotes` | `item.twitterPost.insights.bookmarks` | `item.twitterPost.insights.impressions` | `item.pinterestPost.insights.impressions` | `item.pinterestPost.insights.clicks` | `item.pinterestPost.insights.saves` | `item.pinterestPost.insights.comments` | `item.pinterestPost.insights.reactions` | `item.gbpPost.callToAction.actionType` | `item.gbpPost.insights.shares` | `item.tiktokVideo.privacyLevel` | `item.tiktokVideo.disableComment` | `item.tiktokVideo.disableDuet` | `item.tiktokVideo.disableStitch` | `item.tiktokVideo.brandContentToggle` | `item.tiktokVideo.brandOrganicToggle` | `item.tiktokVideo.insights.views` | `item.tiktokVideo.insights.likes` | `item.tiktokVideo.insights.comments` | `item.tiktokVideo.insights.shares` | `item.tiktokPhoto.privacyLevel` | `item.tiktokPhoto.disableComment` | `item.tiktokPhoto.autoAddMusic` | `item.tiktokPhoto.brandContentToggle` | `item.tiktokPhoto.brandOrganicToggle` | `item.channel.name` | `item.type` | `item.status` | `item.siteAnalytics.traffic` | `item.siteAnalytics.pageView` | `item.siteAnalytics.siteBounceRate` | `item.siteAnalytics.revenue` | `item.siteAnalytics.conversionFunnel.cartViewsSessions` | `item.siteAnalytics.conversionFunnel.checkOutSessions` | `item.siteAnalytics.conversionFunnel.storeOrdersSessions` | `item.siteAnalytics.conversionFunnel.bookingsConfirmed` | `item.insightsSummary.impressions` | `item.insightsSummary.interactions` | `item.insightsSummary.impressionsTotal` | `item.suggested` | `item.external`, 7> & {
+        __applicationErrorsType?: RescheduleItemApplicationErrors;
+    }>;
+}
+declare function deleteItem$1(httpClient: HttpClient): DeleteItemSignature;
+interface DeleteItemSignature {
+    /**
+     * Deletes an item.
+     * @returns DeleteItemResponse
+     */
+    (_id: string): Promise<void & {
+        __applicationErrorsType?: DeleteItemApplicationErrors;
+    }>;
+}
+declare function bulkPublishItems$1(httpClient: HttpClient): BulkPublishItemsSignature;
+interface BulkPublishItemsSignature {
+    /**
+     * Publishes multiple items in a single call.
+     *
+     * Each item is published independently. To publish a single item, call Publish Item.
+     * @param - Items to publish.
+     */
+    (items: NonNullablePaths<Item, `channel` | `channel.accountId`, 3>[], options?: BulkPublishItemsOptions): Promise<NonNullablePaths<BulkPublishItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.youtubeVideo.notifySubscribers` | `results.${number}.item.youtubeShort.notifySubscribers` | `results.${number}.item.tiktokVideo.privacyLevel` | `results.${number}.item.tiktokVideo.disableComment` | `results.${number}.item.tiktokVideo.disableDuet` | `results.${number}.item.tiktokVideo.disableStitch` | `results.${number}.item.tiktokVideo.brandContentToggle` | `results.${number}.item.tiktokVideo.brandOrganicToggle` | `results.${number}.item.tiktokPhoto.privacyLevel` | `results.${number}.item.tiktokPhoto.disableComment` | `results.${number}.item.tiktokPhoto.autoAddMusic` | `results.${number}.item.tiktokPhoto.brandContentToggle` | `results.${number}.item.tiktokPhoto.brandOrganicToggle` | `results.${number}.item.channel.name` | `results.${number}.item.type` | `results.${number}.item.status` | `results.${number}.item.siteAnalytics.traffic` | `results.${number}.item.siteAnalytics.pageView` | `results.${number}.item.siteAnalytics.siteBounceRate` | `results.${number}.item.siteAnalytics.revenue` | `results.${number}.item.insightsSummary.impressions` | `results.${number}.item.insightsSummary.interactions` | `results.${number}.item.insightsSummary.impressionsTotal` | `results.${number}.item.suggested` | `results.${number}.item.external` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare const onItemPublishFailed$1: EventDefinition<ItemPublishFailedEnvelope, "wix.promote.publisher.v1.item_item_publish_failed">;
+declare const onItemPublishScheduled$1: EventDefinition<ItemPublishScheduledEnvelope, "wix.promote.publisher.v1.item_item_publish_scheduled">;
+declare const onItemPublishStarted$1: EventDefinition<ItemPublishStartedEnvelope, "wix.promote.publisher.v1.item_item_publish_started">;
+declare const onItemPublished$1: EventDefinition<ItemPublishedEnvelope, "wix.promote.publisher.v1.item_item_published">;
+
+declare const publishItem: MaybeContext<BuildRESTFunction<typeof publishItem$1> & typeof publishItem$1>;
+declare const publishItemById: MaybeContext<BuildRESTFunction<typeof publishItemById$1> & typeof publishItemById$1>;
+declare const createDraftItem: MaybeContext<BuildRESTFunction<typeof createDraftItem$1> & typeof createDraftItem$1>;
+declare const getItem: MaybeContext<BuildRESTFunction<typeof getItem$1> & typeof getItem$1>;
+declare const getItems: MaybeContext<BuildRESTFunction<typeof getItems$1> & typeof getItems$1>;
+declare const queryItems: MaybeContext<BuildRESTFunction<typeof queryItems$1> & typeof queryItems$1>;
+declare const cancelScheduledItem: MaybeContext<BuildRESTFunction<typeof cancelScheduledItem$1> & typeof cancelScheduledItem$1>;
+declare const updateItem: MaybeContext<BuildRESTFunction<typeof updateItem$1> & typeof updateItem$1>;
+declare const rescheduleItem: MaybeContext<BuildRESTFunction<typeof rescheduleItem$1> & typeof rescheduleItem$1>;
+declare const deleteItem: MaybeContext<BuildRESTFunction<typeof deleteItem$1> & typeof deleteItem$1>;
+declare const bulkPublishItems: MaybeContext<BuildRESTFunction<typeof bulkPublishItems$1> & typeof bulkPublishItems$1>;
+/** */
+declare const onItemPublishFailed: BuildEventDefinition<typeof onItemPublishFailed$1> & typeof onItemPublishFailed$1;
+/** */
+declare const onItemPublishScheduled: BuildEventDefinition<typeof onItemPublishScheduled$1> & typeof onItemPublishScheduled$1;
+/** */
+declare const onItemPublishStarted: BuildEventDefinition<typeof onItemPublishStarted$1> & typeof onItemPublishStarted$1;
+/** */
+declare const onItemPublished: BuildEventDefinition<typeof onItemPublished$1> & typeof onItemPublished$1;
+
+export { BulkPublishItemsOptions, BulkPublishItemsResponse, CancelScheduledItemApplicationErrors, CancelScheduledItemResponse, CreateDraftItemOptions, DeleteItemApplicationErrors, GetItemsResponse, Item, ItemPublishFailedEnvelope, ItemPublishScheduledEnvelope, ItemPublishStartedEnvelope, ItemPublishedEnvelope, PublishItemApplicationErrors, PublishItemByIdApplicationErrors, PublishItemByIdOptions, PublishItemByIdResponse, PublishItemOptions, PublishItemResponse, Query, QueryItemsResponse, RescheduleItemApplicationErrors, RescheduleItemOptions, RescheduleItemResponse, UpdateItem, UpdateItemApplicationErrors, bulkPublishItems, cancelScheduledItem, createDraftItem, deleteItem, getItem, getItems, onItemPublishFailed, onItemPublishScheduled, onItemPublishStarted, onItemPublished, publishItem, publishItemById, queryItems, rescheduleItem, updateItem };