diff --git a/app/weivdata.d.ts b/app/weivdata.d.ts index 4963a2f1..1c0c9d74 100644 --- a/app/weivdata.d.ts +++ b/app/weivdata.d.ts @@ -2239,6 +2239,31 @@ declare module '@exweiv/weiv-data' { * Basically if you want to find a member by it's _id then use entityId field not _id field. */ namespace SyncWixApps { + /** + * ## Wix Members Sync Plug-in + * + * This plug-in allows you to sync Wix Members collections into your MongoDB cluster. In this was you can perform your data works with WeivData for Wix Members app data. + * You can also perform lookups easily (references/includes) with any other collection you have in your MongoDB. + * + * And there aren't any filtering etc. limit when you use WeivData, you can filter and query data however you want. + * + * Right now you have 6 functions to sync these collections: + * + * - Badges (WixMembersBadges) + * - FullData (WixMembersFullData) + * - PrivateMembersData (WixMembersPrivateData) + * - PublicData (WixMembersPublicData) + * + * The database name depends on your choice. You can configure it with config function. + * + * --- + * + * We do not suggest writing to these collections, use these collections to only read data from it. + * + * --- + * + * Functions are designed to work with `wix-members.v2` APIs Events. Define events inside the `events.js` file and point the functions you import from this plugin. + */ interface wixMembers { onMemberCreated(event: any): Promise; onMemberUpdated(event: any): Promise; @@ -2249,6 +2274,29 @@ declare module '@exweiv/weiv-data' { onBadgeDeleted(event: any): Promise; } + /** + * ## Wix Stores Sync Plug-in + * + * This plug-in allows you to sync some Wix Stores collections into your MongoDB cluster. In this way you can perform queries, lookups and all other things easily with WeivData. + * There isn't any filtering etc. limit for these collections which you may see when you use WixData. + * + * Right now you have 6 functions to sync these collections: + * + * - Collections (WixStoresCollections) + * - InventoryItems (WixStoresInventoryItems) + * - Products (WixStoresProducts) + * - Variants (WixStoresVariants) + * + * The database name depends on your choice. You can configure it with config function. + * + * --- + * + * We do not suggest writing to these collections, use these collections to only read data from it. + * + * --- + * + * Functions are designed to work with `wix-stores-backend` APIs Events. Define events inside the `events.js` file and point the functions you import from this plugin. + */ interface wixStores { onProductCreated(event: any): Promise; onProductUpdated(event: any): Promise; @@ -2259,6 +2307,29 @@ declare module '@exweiv/weiv-data' { onCollectionDeleted(event: any): Promise; } + /** + * ## Wix eCommerce Sync Plug-in + * + * This plug-in allows you to sync orders and abandoned checkouts collections into your MongoDB cluster. In this way you can perform queries, lookups and all other things easily with WeivData. + * There isn't any filtering etc. limit for these collections which you may see when you use WixData. + * + * Right now you have 4 functions to sync these collections: + * + * - Orders (WixeComOrders) + * - AbandonedCheckouts (WixeComAbandonedCheckouts) + * + * > Orders collection is normally inside the Wix Stores database in Wix so the "orders" collection we are referring here is that collection. + * + * The database name depends on your choice. You can configure it with config function. + * + * --- + * + * We do not suggest writing to these collections, use these collections to only read data from it. + * + * --- + * + * Functions are designed to work with `wix-ecom-backend` APIs Events. Define events inside the `events.js` file and point the functions you import from this plugin. + */ interface wixEcom { onOrderCreated(event: any): Promise; onOrderUpdated(event: any): Promise; @@ -2267,18 +2338,80 @@ declare module '@exweiv/weiv-data' { onAbandonedCheckoutRecovered(event: any): Promise; } + /** + * ## Wix Marketing Sync Plug-in + * + * This plug-in allows you to sync coupons collection into your MongoDB cluster. In this way you can perform queries, lookups and all other things easily with WeivData. + * There isn't any filtering etc. limit for these collections which you may see when you use WixData. + * + * Right now you have 3 functions to sync these collections: + * + * - Coupons (WixMarketingCoupons) + * + * The database name depends on your choice. You can configure it with config function. + * + * --- + * + * We do not suggest writing to these collections, use these collections to only read data from it. + * + * --- + * + * Functions are designed to work with `wix-marketing.v2` APIs Events. Define events inside the `events.js` file and point the functions you import from this plugin. + */ interface wixMarketing { onCouponCreated(event: any): Promise; onCouponUpdated(event: any): Promise; onCouponDeleted(event: any): Promise; } + /** + * ## Wix Pricing Plans Sync Plug-in + * + * This plug-in allows you to sync plans collection into your MongoDB cluster. In this way you can perform queries, lookups and all other things easily with WeivData. + * There isn't any filtering etc. limit for these collections which you may see when you use WixData. + * + * Right now you have 3 functions to sync these collections: + * + * - Plans (WixPricingPlansPlans) + * + * The database name depends on your choice. You can configure it with config function. + * + * --- + * + * We do not suggest writing to these collections, use these collections to only read data from it. + * + * --- + * + * Functions are designed to work with `wix-pricing-plans.v2` APIs Events. Define events inside the `events.js` file and point the functions you import from this plugin. + */ interface wixPricingPlans { onPlanCreated(event: any): Promise; onPlanUpdated(event: any): Promise; onPlanArchived(event: any, deletePlan?: boolean): Promise; } + /** + * ## Wix Blog Sync Plug-in + * + * This plug-in allows you to sync some collections into your MongoDB cluster. In this way you can perform queries, lookups and all other things easily with WeivData. + * There isn't any filtering etc. limit for these collections which you may see when you use WixData. + * + * Right now you have 9 functions to sync these collections: + * + * - Posts (WixBlogPosts) + * - Categories (WixBlogCategories) + * - Tags (WixBlogTags) + * + * The database name depends on your choice. You can configure it with config function. + * + * --- + * + * We do not suggest writing to these collections, use these collections to only read data from it. + * + * --- + * + * Functions are designed to work with `wix-blog-backend` APIs Events. Define events inside the `events.js` file and point the functions you import from this plugin. + */ interface wixBlog { onPostCreated(event: any): Promise; onPostUpdated(event: any): Promise;