@wix/auto_sdk_stores_ribbons-v-3 1.0.14 → 1.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/{stores-catalog-v3-ribbon-ribbons-v-3.universal-DWKP9-aP.d.ts → index.typings.d.ts} +244 -1
- package/build/cjs/index.typings.js +716 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +2 -2
- package/build/es/{stores-catalog-v3-ribbon-ribbons-v-3.universal-DWKP9-aP.d.mts → index.typings.d.mts} +244 -1
- package/build/es/index.typings.mjs +680 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/{stores-catalog-v3-ribbon-ribbons-v-3.universal-DWKP9-aP.d.ts → index.typings.d.ts} +244 -1
- package/build/internal/cjs/index.typings.js +716 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -1
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/{stores-catalog-v3-ribbon-ribbons-v-3.universal-DWKP9-aP.d.mts → index.typings.d.mts} +244 -1
- package/build/internal/es/index.typings.mjs +680 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +3 -3
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export {
|
|
2
|
+
import { Ribbon, GetRibbonOptions, UpdateRibbon, UpdateRibbonOptions, QueryRibbonsOptions, RibbonsQueryBuilder, BulkCreateRibbonsOptions, BulkCreateRibbonsResponse, MaskedRibbon, BulkUpdateRibbonsOptions, BulkUpdateRibbonsResponse, GetOrCreateRibbonOptions, GetOrCreateRibbonResponse, BulkGetOrCreateRibbonsOptions, BulkGetOrCreateRibbonsResponse, BulkDeleteRibbonsResponse, RibbonCreatedEnvelope, RibbonDeletedEnvelope, RibbonUpdatedEnvelope } from './index.typings.js';
|
|
3
|
+
export { ActionEvent, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateRibbonsRequest, BulkDeleteRibbonsRequest, BulkGetOrCreateRibbonsRequest, BulkRibbonResult, BulkUpdateRibbonsRequest, CreateRibbonRequest, CreateRibbonResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, DeleteRibbonRequest, DeleteRibbonResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, GetOrCreateRibbonRequest, GetRibbonRequest, GetRibbonResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, MessageEnvelope, Page, QueryRibbonsRequest, QueryRibbonsResponse, RequestedFields, RestoreInfo, RibbonsQueryResult, SortOrder, Sorting, URI, UpdateRibbonRequest, UpdateRibbonResponse, V3BulkRibbonResult, WebhookIdentityType } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function createRibbon$1(httpClient: HttpClient): CreateRibbonSignature;
|
|
6
6
|
interface CreateRibbonSignature {
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/** A Ribbon is a visual element that you can assign to products to highlight them on your site. */
|
|
2
4
|
interface Ribbon {
|
|
3
5
|
/**
|
|
@@ -660,14 +662,129 @@ interface RibbonCreatedEnvelope {
|
|
|
660
662
|
entity: Ribbon;
|
|
661
663
|
metadata: EventMetadata;
|
|
662
664
|
}
|
|
665
|
+
/** @permissionScope Manage Stores - all permissions
|
|
666
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
667
|
+
* @permissionScope Read ribbons in v3 catalog
|
|
668
|
+
* @permissionScopeId SCOPE.STORES.RIBBON_READ
|
|
669
|
+
* @permissionScope Manage Stores
|
|
670
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
671
|
+
* @permissionScope Read v3 catalog
|
|
672
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
673
|
+
* @permissionScope Manage Products
|
|
674
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
675
|
+
* @permissionScope Read Stores - all read permissions
|
|
676
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
677
|
+
* @permissionScope Read Products
|
|
678
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
679
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
680
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
681
|
+
* @permissionScope Product write in v3 catalog
|
|
682
|
+
* @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
|
|
683
|
+
* @permissionScope Manage v3 catalog
|
|
684
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
685
|
+
* @permissionScope Manage Orders
|
|
686
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
687
|
+
* @permissionId WIX_STORES.RIBBON_READ
|
|
688
|
+
* @webhook
|
|
689
|
+
* @eventType wix.stores.catalog.v3.ribbon_created
|
|
690
|
+
* @slug created
|
|
691
|
+
* @documentationMaturity preview
|
|
692
|
+
*/
|
|
693
|
+
declare function onRibbonCreated(handler: (event: RibbonCreatedEnvelope) => void | Promise<void>): void;
|
|
663
694
|
interface RibbonDeletedEnvelope {
|
|
664
695
|
entity: Ribbon;
|
|
665
696
|
metadata: EventMetadata;
|
|
666
697
|
}
|
|
698
|
+
/** @permissionScope Manage Stores - all permissions
|
|
699
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
700
|
+
* @permissionScope Read ribbons in v3 catalog
|
|
701
|
+
* @permissionScopeId SCOPE.STORES.RIBBON_READ
|
|
702
|
+
* @permissionScope Manage Stores
|
|
703
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
704
|
+
* @permissionScope Read v3 catalog
|
|
705
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
706
|
+
* @permissionScope Manage Products
|
|
707
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
708
|
+
* @permissionScope Read Stores - all read permissions
|
|
709
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
710
|
+
* @permissionScope Read Products
|
|
711
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
712
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
713
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
714
|
+
* @permissionScope Product write in v3 catalog
|
|
715
|
+
* @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
|
|
716
|
+
* @permissionScope Manage v3 catalog
|
|
717
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
718
|
+
* @permissionScope Manage Orders
|
|
719
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
720
|
+
* @permissionId WIX_STORES.RIBBON_READ
|
|
721
|
+
* @webhook
|
|
722
|
+
* @eventType wix.stores.catalog.v3.ribbon_deleted
|
|
723
|
+
* @slug deleted
|
|
724
|
+
* @documentationMaturity preview
|
|
725
|
+
*/
|
|
726
|
+
declare function onRibbonDeleted(handler: (event: RibbonDeletedEnvelope) => void | Promise<void>): void;
|
|
667
727
|
interface RibbonUpdatedEnvelope {
|
|
668
728
|
entity: Ribbon;
|
|
669
729
|
metadata: EventMetadata;
|
|
670
730
|
}
|
|
731
|
+
/** @permissionScope Manage Stores - all permissions
|
|
732
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
733
|
+
* @permissionScope Read ribbons in v3 catalog
|
|
734
|
+
* @permissionScopeId SCOPE.STORES.RIBBON_READ
|
|
735
|
+
* @permissionScope Manage Stores
|
|
736
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
737
|
+
* @permissionScope Read v3 catalog
|
|
738
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
739
|
+
* @permissionScope Manage Products
|
|
740
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
741
|
+
* @permissionScope Read Stores - all read permissions
|
|
742
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
743
|
+
* @permissionScope Read Products
|
|
744
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
745
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
746
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
747
|
+
* @permissionScope Product write in v3 catalog
|
|
748
|
+
* @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
|
|
749
|
+
* @permissionScope Manage v3 catalog
|
|
750
|
+
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
751
|
+
* @permissionScope Manage Orders
|
|
752
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
753
|
+
* @permissionId WIX_STORES.RIBBON_READ
|
|
754
|
+
* @webhook
|
|
755
|
+
* @eventType wix.stores.catalog.v3.ribbon_updated
|
|
756
|
+
* @slug updated
|
|
757
|
+
* @documentationMaturity preview
|
|
758
|
+
*/
|
|
759
|
+
declare function onRibbonUpdated(handler: (event: RibbonUpdatedEnvelope) => void | Promise<void>): void;
|
|
760
|
+
type RibbonNonNullablePaths = `name`;
|
|
761
|
+
/**
|
|
762
|
+
* Creates a ribbon.
|
|
763
|
+
*
|
|
764
|
+
* To assign the ribbon to a product, include the `ribbon.id` or `ribbon.name` when [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or [updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.
|
|
765
|
+
* @param ribbon - Ribbon to create.
|
|
766
|
+
* @public
|
|
767
|
+
* @documentationMaturity preview
|
|
768
|
+
* @requiredField ribbon
|
|
769
|
+
* @requiredField ribbon.name
|
|
770
|
+
* @permissionId WIX_STORES.RIBBON_CREATE
|
|
771
|
+
* @applicableIdentity APP
|
|
772
|
+
* @returns Created ribbon.
|
|
773
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.CreateRibbon
|
|
774
|
+
*/
|
|
775
|
+
declare function createRibbon(ribbon: NonNullablePaths<Ribbon, `name`>): Promise<NonNullablePaths<Ribbon, RibbonNonNullablePaths>>;
|
|
776
|
+
/**
|
|
777
|
+
* Retrieves a ribbon.
|
|
778
|
+
* @param ribbonId - Ribbon ID.
|
|
779
|
+
* @public
|
|
780
|
+
* @documentationMaturity preview
|
|
781
|
+
* @requiredField ribbonId
|
|
782
|
+
* @permissionId WIX_STORES.RIBBON_READ
|
|
783
|
+
* @applicableIdentity APP
|
|
784
|
+
* @returns Ribbon.
|
|
785
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.GetRibbon
|
|
786
|
+
*/
|
|
787
|
+
declare function getRibbon(ribbonId: string, options?: GetRibbonOptions): Promise<NonNullablePaths<Ribbon, RibbonNonNullablePaths>>;
|
|
671
788
|
interface GetRibbonOptions {
|
|
672
789
|
/**
|
|
673
790
|
* Fields to include in the response.
|
|
@@ -677,6 +794,25 @@ interface GetRibbonOptions {
|
|
|
677
794
|
*/
|
|
678
795
|
fields?: RequestedFieldsWithLiterals[];
|
|
679
796
|
}
|
|
797
|
+
/**
|
|
798
|
+
* Updates a ribbon.
|
|
799
|
+
*
|
|
800
|
+
*
|
|
801
|
+
* Each time the ribbon is updated, `revision` increments by 1.
|
|
802
|
+
* The current `revision` must be passed when updating the ribbon.
|
|
803
|
+
* This ensures you're working with the latest ribbon and prevents unintended overwrites.
|
|
804
|
+
* @param _id - Ribbon ID.
|
|
805
|
+
* @public
|
|
806
|
+
* @documentationMaturity preview
|
|
807
|
+
* @requiredField _id
|
|
808
|
+
* @requiredField ribbon
|
|
809
|
+
* @requiredField ribbon.revision
|
|
810
|
+
* @permissionId WIX_STORES.RIBBON_UPDATE
|
|
811
|
+
* @applicableIdentity APP
|
|
812
|
+
* @returns Updated Ribbon.
|
|
813
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.UpdateRibbon
|
|
814
|
+
*/
|
|
815
|
+
declare function updateRibbon(_id: string, ribbon: NonNullablePaths<UpdateRibbon, `revision`>, options?: UpdateRibbonOptions): Promise<NonNullablePaths<Ribbon, RibbonNonNullablePaths>>;
|
|
680
816
|
interface UpdateRibbon {
|
|
681
817
|
/**
|
|
682
818
|
* Ribbon ID.
|
|
@@ -725,6 +861,43 @@ interface UpdateRibbonOptions {
|
|
|
725
861
|
*/
|
|
726
862
|
fields?: RequestedFieldsWithLiterals[];
|
|
727
863
|
}
|
|
864
|
+
/**
|
|
865
|
+
* Deletes a ribbon.
|
|
866
|
+
*
|
|
867
|
+
*
|
|
868
|
+
* > **Note:** Deleting a ribbon will also remove it from all products it is assigned to.
|
|
869
|
+
* @param ribbonId - Ribbon ID.
|
|
870
|
+
* @public
|
|
871
|
+
* @documentationMaturity preview
|
|
872
|
+
* @requiredField ribbonId
|
|
873
|
+
* @permissionId WIX_STORES.RIBBON_DELETE
|
|
874
|
+
* @applicableIdentity APP
|
|
875
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.DeleteRibbon
|
|
876
|
+
*/
|
|
877
|
+
declare function deleteRibbon(ribbonId: string): Promise<void>;
|
|
878
|
+
/**
|
|
879
|
+
* Retrieves a list of up to 100 ribbons, given the provided filtering, sorting, and cursor paging.
|
|
880
|
+
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
881
|
+
*
|
|
882
|
+
*
|
|
883
|
+
* Query Brands runs with these defaults, which you can override:
|
|
884
|
+
*
|
|
885
|
+
* - `createdDate` is sorted in `DESC` order
|
|
886
|
+
* - `cursorPaging.limit` is `100`
|
|
887
|
+
*
|
|
888
|
+
* For field support for filters and sorting,
|
|
889
|
+
* see [Ribbons: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/supported-filters-and-sorting).
|
|
890
|
+
*
|
|
891
|
+
* To learn about working with _Query_ endpoints, see
|
|
892
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
893
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
894
|
+
* @public
|
|
895
|
+
* @documentationMaturity preview
|
|
896
|
+
* @permissionId WIX_STORES.RIBBON_READ
|
|
897
|
+
* @applicableIdentity APP
|
|
898
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.QueryRibbons
|
|
899
|
+
*/
|
|
900
|
+
declare function queryRibbons(options?: QueryRibbonsOptions): RibbonsQueryBuilder;
|
|
728
901
|
interface QueryRibbonsOptions {
|
|
729
902
|
/**
|
|
730
903
|
* Fields to include in the response.
|
|
@@ -811,6 +984,20 @@ interface RibbonsQueryBuilder {
|
|
|
811
984
|
/** @documentationMaturity preview */
|
|
812
985
|
find: () => Promise<RibbonsQueryResult>;
|
|
813
986
|
}
|
|
987
|
+
/**
|
|
988
|
+
* Creates multiple ribbons.
|
|
989
|
+
* @param ribbons - Ribbons to create.
|
|
990
|
+
* @public
|
|
991
|
+
* @documentationMaturity preview
|
|
992
|
+
* @requiredField ribbons
|
|
993
|
+
* @requiredField ribbons.name
|
|
994
|
+
* @permissionId WIX_STORES.RIBBON_CREATE
|
|
995
|
+
* @applicableIdentity APP
|
|
996
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.BulkCreateRibbons
|
|
997
|
+
*/
|
|
998
|
+
declare function bulkCreateRibbons(ribbons: NonNullablePaths<Ribbon, `name`>[], options?: BulkCreateRibbonsOptions): Promise<NonNullablePaths<BulkCreateRibbonsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
999
|
+
[P in RibbonNonNullablePaths]: `results.${number}.item.${P}`;
|
|
1000
|
+
}[RibbonNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
814
1001
|
interface BulkCreateRibbonsOptions {
|
|
815
1002
|
/**
|
|
816
1003
|
* Whether to return the full created ribbon entities in the response.
|
|
@@ -819,6 +1006,25 @@ interface BulkCreateRibbonsOptions {
|
|
|
819
1006
|
*/
|
|
820
1007
|
returnEntity?: boolean;
|
|
821
1008
|
}
|
|
1009
|
+
/**
|
|
1010
|
+
* Updates multiple ribbons.
|
|
1011
|
+
*
|
|
1012
|
+
* Each time a ribbon is updated, `revision` increments by 1.
|
|
1013
|
+
* The current `revision` must be passed when updating a ribbon.
|
|
1014
|
+
* This ensures you're working with the latest ribbon and prevents unintended overwrites.
|
|
1015
|
+
* @param ribbons - List of ribbons to update.
|
|
1016
|
+
* @public
|
|
1017
|
+
* @documentationMaturity preview
|
|
1018
|
+
* @requiredField ribbons
|
|
1019
|
+
* @requiredField ribbons.ribbon._id
|
|
1020
|
+
* @requiredField ribbons.ribbon.revision
|
|
1021
|
+
* @permissionId WIX_STORES.RIBBON_UPDATE
|
|
1022
|
+
* @applicableIdentity APP
|
|
1023
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.BulkUpdateRibbons
|
|
1024
|
+
*/
|
|
1025
|
+
declare function bulkUpdateRibbons(ribbons: NonNullablePaths<MaskedRibbon, `ribbon._id` | `ribbon.revision`>[], options?: BulkUpdateRibbonsOptions): Promise<NonNullablePaths<BulkUpdateRibbonsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
1026
|
+
[P in RibbonNonNullablePaths]: `results.${number}.item.${P}`;
|
|
1027
|
+
}[RibbonNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
822
1028
|
interface BulkUpdateRibbonsOptions {
|
|
823
1029
|
/**
|
|
824
1030
|
* Whether to return the full updated ribbon entities in the response.
|
|
@@ -834,6 +1040,19 @@ interface BulkUpdateRibbonsOptions {
|
|
|
834
1040
|
*/
|
|
835
1041
|
fields?: RequestedFieldsWithLiterals[];
|
|
836
1042
|
}
|
|
1043
|
+
/**
|
|
1044
|
+
* Retrieves a ribbon by name, or creates a ribbon if one with the passed `ribbonName` doesn't exist.
|
|
1045
|
+
* @param ribbonName - Ribbon name to retrieve or create.
|
|
1046
|
+
* @public
|
|
1047
|
+
* @documentationMaturity preview
|
|
1048
|
+
* @requiredField ribbonName
|
|
1049
|
+
* @permissionId WIX_STORES.RIBBON_GET_OR_CREATE
|
|
1050
|
+
* @applicableIdentity APP
|
|
1051
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.GetOrCreateRibbon
|
|
1052
|
+
*/
|
|
1053
|
+
declare function getOrCreateRibbon(ribbonName: string, options?: GetOrCreateRibbonOptions): Promise<NonNullablePaths<GetOrCreateRibbonResponse, {
|
|
1054
|
+
[P in RibbonNonNullablePaths]: `ribbon.${P}`;
|
|
1055
|
+
}[RibbonNonNullablePaths]>>;
|
|
837
1056
|
interface GetOrCreateRibbonOptions {
|
|
838
1057
|
/**
|
|
839
1058
|
* Fields to include in the response.
|
|
@@ -843,6 +1062,19 @@ interface GetOrCreateRibbonOptions {
|
|
|
843
1062
|
*/
|
|
844
1063
|
fields?: RequestedFieldsWithLiterals[];
|
|
845
1064
|
}
|
|
1065
|
+
/**
|
|
1066
|
+
* Retrieves multiple ribbons by name, or creates multiple ribbons if those with the passed `ribbonNames` don't exist.
|
|
1067
|
+
* @param ribbonNames - Ribbon names to retrieve or create.
|
|
1068
|
+
* @public
|
|
1069
|
+
* @documentationMaturity preview
|
|
1070
|
+
* @requiredField ribbonNames
|
|
1071
|
+
* @permissionId WIX_STORES.RIBBON_GET_OR_CREATE
|
|
1072
|
+
* @applicableIdentity APP
|
|
1073
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.BulkGetOrCreateRibbons
|
|
1074
|
+
*/
|
|
1075
|
+
declare function bulkGetOrCreateRibbons(ribbonNames: string[], options?: BulkGetOrCreateRibbonsOptions): Promise<NonNullablePaths<BulkGetOrCreateRibbonsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
1076
|
+
[P in RibbonNonNullablePaths]: `results.${number}.item.${P}`;
|
|
1077
|
+
}[RibbonNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
846
1078
|
interface BulkGetOrCreateRibbonsOptions {
|
|
847
1079
|
/**
|
|
848
1080
|
* Fields to include in the response.
|
|
@@ -852,5 +1084,16 @@ interface BulkGetOrCreateRibbonsOptions {
|
|
|
852
1084
|
*/
|
|
853
1085
|
fields?: RequestedFieldsWithLiterals[];
|
|
854
1086
|
}
|
|
1087
|
+
/**
|
|
1088
|
+
* Deletes multiple ribbons.
|
|
1089
|
+
* @param ribbonIds - IDs of ribbons to delete.
|
|
1090
|
+
* @public
|
|
1091
|
+
* @documentationMaturity preview
|
|
1092
|
+
* @requiredField ribbonIds
|
|
1093
|
+
* @permissionId WIX_STORES.RIBBON_DELETE
|
|
1094
|
+
* @applicableIdentity APP
|
|
1095
|
+
* @fqn wix.stores.catalog.ribbon.v3.RibbonService.BulkDeleteRibbons
|
|
1096
|
+
*/
|
|
1097
|
+
declare function bulkDeleteRibbons(ribbonIds: string[]): Promise<NonNullablePaths<BulkDeleteRibbonsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
855
1098
|
|
|
856
|
-
export { type
|
|
1099
|
+
export { type ActionEvent, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateRibbonsOptions, type BulkCreateRibbonsRequest, type BulkCreateRibbonsResponse, type BulkDeleteRibbonsRequest, type BulkDeleteRibbonsResponse, type BulkGetOrCreateRibbonsOptions, type BulkGetOrCreateRibbonsRequest, type BulkGetOrCreateRibbonsResponse, type BulkRibbonResult, type BulkUpdateRibbonsOptions, type BulkUpdateRibbonsRequest, type BulkUpdateRibbonsResponse, type CreateRibbonRequest, type CreateRibbonResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type DeleteRibbonRequest, type DeleteRibbonResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type File, type GetOrCreateRibbonOptions, type GetOrCreateRibbonRequest, type GetOrCreateRibbonResponse, type GetRibbonOptions, type GetRibbonRequest, type GetRibbonResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type MaskedRibbon, type MessageEnvelope, type Page, type QueryRibbonsOptions, type QueryRibbonsRequest, type QueryRibbonsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type Ribbon, type RibbonCreatedEnvelope, type RibbonDeletedEnvelope, type RibbonUpdatedEnvelope, type RibbonsQueryBuilder, type RibbonsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type UpdateRibbon, type UpdateRibbonOptions, type UpdateRibbonRequest, type UpdateRibbonResponse, type V3BulkRibbonResult, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateRibbons, bulkDeleteRibbons, bulkGetOrCreateRibbons, bulkUpdateRibbons, createRibbon, deleteRibbon, getOrCreateRibbon, getRibbon, onRibbonCreated, onRibbonDeleted, onRibbonUpdated, queryRibbons, updateRibbon };
|