@wix/pro-gallery 1.0.31 → 1.0.33

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.
Files changed (46) hide show
  1. package/build/cjs/index.js +5 -1
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +1 -0
  4. package/build/cjs/index.typings.js +28 -0
  5. package/build/cjs/index.typings.js.map +1 -0
  6. package/build/cjs/meta.d.ts +1 -0
  7. package/build/cjs/meta.js +28 -0
  8. package/build/cjs/meta.js.map +1 -0
  9. package/build/cjs/src/pro-gallery-v2-gallery.http.d.ts +11 -11
  10. package/build/cjs/src/pro-gallery-v2-gallery.http.js +464 -240
  11. package/build/cjs/src/pro-gallery-v2-gallery.http.js.map +1 -1
  12. package/build/cjs/src/pro-gallery-v2-gallery.meta.d.ts +41 -0
  13. package/build/cjs/src/pro-gallery-v2-gallery.meta.js +218 -0
  14. package/build/cjs/src/pro-gallery-v2-gallery.meta.js.map +1 -0
  15. package/build/cjs/src/pro-gallery-v2-gallery.public.d.ts +114 -12
  16. package/build/cjs/src/pro-gallery-v2-gallery.public.js +2 -1
  17. package/build/cjs/src/pro-gallery-v2-gallery.public.js.map +1 -1
  18. package/build/cjs/src/pro-gallery-v2-gallery.types.d.ts +987 -69
  19. package/build/cjs/src/pro-gallery-v2-gallery.types.js +26 -8
  20. package/build/cjs/src/pro-gallery-v2-gallery.types.js.map +1 -1
  21. package/build/cjs/src/pro-gallery-v2-gallery.universal.d.ts +299 -75
  22. package/build/cjs/src/pro-gallery-v2-gallery.universal.js +124 -44
  23. package/build/cjs/src/pro-gallery-v2-gallery.universal.js.map +1 -1
  24. package/build/es/index.typings.d.ts +1 -0
  25. package/build/es/index.typings.js +2 -0
  26. package/build/es/index.typings.js.map +1 -0
  27. package/build/es/meta.d.ts +1 -0
  28. package/build/es/meta.js +2 -0
  29. package/build/es/meta.js.map +1 -0
  30. package/build/es/src/pro-gallery-v2-gallery.http.d.ts +11 -11
  31. package/build/es/src/pro-gallery-v2-gallery.http.js +464 -240
  32. package/build/es/src/pro-gallery-v2-gallery.http.js.map +1 -1
  33. package/build/es/src/pro-gallery-v2-gallery.meta.d.ts +41 -0
  34. package/build/es/src/pro-gallery-v2-gallery.meta.js +182 -0
  35. package/build/es/src/pro-gallery-v2-gallery.meta.js.map +1 -0
  36. package/build/es/src/pro-gallery-v2-gallery.public.d.ts +114 -12
  37. package/build/es/src/pro-gallery-v2-gallery.public.js +1 -1
  38. package/build/es/src/pro-gallery-v2-gallery.public.js.map +1 -1
  39. package/build/es/src/pro-gallery-v2-gallery.types.d.ts +987 -69
  40. package/build/es/src/pro-gallery-v2-gallery.types.js +18 -0
  41. package/build/es/src/pro-gallery-v2-gallery.types.js.map +1 -1
  42. package/build/es/src/pro-gallery-v2-gallery.universal.d.ts +299 -75
  43. package/build/es/src/pro-gallery-v2-gallery.universal.js +112 -36
  44. package/build/es/src/pro-gallery-v2-gallery.universal.js.map +1 -1
  45. package/meta/package.json +6 -0
  46. package/package.json +11 -6
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.State = exports.SearchIndexingNotificationState = exports.Enum = exports.VideoType = exports.ImageType = exports.Type = exports.LinkType = void 0;
3
+ exports.State = exports.SearchIndexingNotificationState = exports.Enum = exports.VideoType = exports.ImageType = exports.Type = exports.LinkRel = exports.LinkType = void 0;
4
4
  var LinkType;
5
5
  (function (LinkType) {
6
6
  LinkType["UNDEFINED"] = "UNDEFINED";
@@ -8,27 +8,45 @@ var LinkType;
8
8
  LinkType["EXTERNAL"] = "EXTERNAL";
9
9
  /** for internal usage using wixLinkData */
10
10
  LinkType["INTERNAL"] = "INTERNAL";
11
- })(LinkType = exports.LinkType || (exports.LinkType = {}));
11
+ })(LinkType || (exports.LinkType = LinkType = {}));
12
+ /**
13
+ * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
14
+ * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
15
+ * Following are the accepted 'rel' types by Wix applications.
16
+ */
17
+ var LinkRel;
18
+ (function (LinkRel) {
19
+ /** default (not implemented) */
20
+ LinkRel["unknown_link_rel"] = "unknown_link_rel";
21
+ /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
22
+ LinkRel["nofollow"] = "nofollow";
23
+ /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
24
+ LinkRel["noopener"] = "noopener";
25
+ /** No Referer header will be included. Additionally, has the same effect as noopener. */
26
+ LinkRel["noreferrer"] = "noreferrer";
27
+ /** Indicates a link that resulted from advertisements or paid placements. */
28
+ LinkRel["sponsored"] = "sponsored";
29
+ })(LinkRel || (exports.LinkRel = LinkRel = {}));
12
30
  var Type;
13
31
  (function (Type) {
14
32
  Type["UNDEFINED"] = "UNDEFINED";
15
33
  Type["IMAGE"] = "IMAGE";
16
34
  Type["VIDEO"] = "VIDEO";
17
35
  Type["TEXT"] = "TEXT";
18
- })(Type = exports.Type || (exports.Type = {}));
36
+ })(Type || (exports.Type = Type = {}));
19
37
  var ImageType;
20
38
  (function (ImageType) {
21
39
  ImageType["UNDEFINED"] = "UNDEFINED";
22
40
  ImageType["WIX_MEDIA"] = "WIX_MEDIA";
23
41
  ImageType["EXTERNAL"] = "EXTERNAL";
24
- })(ImageType = exports.ImageType || (exports.ImageType = {}));
42
+ })(ImageType || (exports.ImageType = ImageType = {}));
25
43
  var VideoType;
26
44
  (function (VideoType) {
27
45
  VideoType["UNDEFINED"] = "UNDEFINED";
28
46
  VideoType["WIX_MEDIA"] = "WIX_MEDIA";
29
47
  VideoType["YOUTUBE"] = "YOUTUBE";
30
48
  VideoType["VIMEO"] = "VIMEO";
31
- })(VideoType = exports.VideoType || (exports.VideoType = {}));
49
+ })(VideoType || (exports.VideoType = VideoType = {}));
32
50
  var Enum;
33
51
  (function (Enum) {
34
52
  /** Default value. Means that permission not set */
@@ -43,7 +61,7 @@ var Enum;
43
61
  Enum["UNCHANGED"] = "UNCHANGED";
44
62
  /** Protected to members of permitted groups and owners */
45
63
  Enum["GROUP_PROTECTED"] = "GROUP_PROTECTED";
46
- })(Enum = exports.Enum || (exports.Enum = {}));
64
+ })(Enum || (exports.Enum = Enum = {}));
47
65
  var SearchIndexingNotificationState;
48
66
  (function (SearchIndexingNotificationState) {
49
67
  /** default state */
@@ -52,7 +70,7 @@ var SearchIndexingNotificationState;
52
70
  SearchIndexingNotificationState["Off"] = "Off";
53
71
  /** metasite requires site search indexing */
54
72
  SearchIndexingNotificationState["On"] = "On";
55
- })(SearchIndexingNotificationState = exports.SearchIndexingNotificationState || (exports.SearchIndexingNotificationState = {}));
73
+ })(SearchIndexingNotificationState || (exports.SearchIndexingNotificationState = SearchIndexingNotificationState = {}));
56
74
  var State;
57
75
  (function (State) {
58
76
  State["UNDEFINED"] = "UNDEFINED";
@@ -60,5 +78,5 @@ var State;
60
78
  State["SAVED"] = "SAVED";
61
79
  /** The gallery in the LiveSite segment */
62
80
  State["PUBLISHED"] = "PUBLISHED";
63
- })(State = exports.State || (exports.State = {}));
81
+ })(State || (exports.State = State = {}));
64
82
  //# sourceMappingURL=pro-gallery-v2-gallery.types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"pro-gallery-v2-gallery.types.js","sourceRoot":"","sources":["../../../src/pro-gallery-v2-gallery.types.ts"],"names":[],"mappings":";;;AAuFA,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,mCAAuB,CAAA;IACvB,oBAAoB;IACpB,iCAAqB,CAAA;IACrB,2CAA2C;IAC3C,iCAAqB,CAAA;AACvB,CAAC,EANW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAMnB;AA+GD,IAAY,IAKX;AALD,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,uBAAe,CAAA;IACf,uBAAe,CAAA;IACf,qBAAa,CAAA;AACf,CAAC,EALW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKf;AAoBD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AAsDD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA+QD,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,mDAAmD;IACnD,2BAAmB,CAAA;IACnB,wDAAwD;IACxD,+BAAuB,CAAA;IACvB,0CAA0C;IAC1C,2BAAmB,CAAA;IACnB,2CAA2C;IAC3C,yBAAiB,CAAA;IACjB,uEAAuE;IACvE,+BAAuB,CAAA;IACvB,0DAA0D;IAC1D,2CAAmC,CAAA;AACrC,CAAC,EAbW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAaf;AAmCD,IAAY,+BAOX;AAPD,WAAY,+BAA+B;IACzC,oBAAoB;IACpB,sDAAmB,CAAA;IACnB,qDAAqD;IACrD,8CAAW,CAAA;IACX,6CAA6C;IAC7C,4CAAS,CAAA;AACX,CAAC,EAPW,+BAA+B,GAA/B,uCAA+B,KAA/B,uCAA+B,QAO1C;AAkED,IAAY,KAMX;AAND,WAAY,KAAK;IACf,gCAAuB,CAAA;IACvB,wCAAwC;IACxC,wBAAe,CAAA;IACf,0CAA0C;IAC1C,gCAAuB,CAAA;AACzB,CAAC,EANW,KAAK,GAAL,aAAK,KAAL,aAAK,QAMhB"}
1
+ {"version":3,"file":"pro-gallery-v2-gallery.types.js","sourceRoot":"","sources":["../../../src/pro-gallery-v2-gallery.types.ts"],"names":[],"mappings":";;;AAuFA,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,mCAAuB,CAAA;IACvB,oBAAoB;IACpB,iCAAqB,CAAA;IACrB,2CAA2C;IAC3C,iCAAqB,CAAA;AACvB,CAAC,EANW,QAAQ,wBAAR,QAAQ,QAMnB;AAkED;;;;GAIG;AACH,IAAY,OAWX;AAXD,WAAY,OAAO;IACjB,gCAAgC;IAChC,gDAAqC,CAAA;IACrC,mHAAmH;IACnH,gCAAqB,CAAA;IACrB,gJAAgJ;IAChJ,gCAAqB,CAAA;IACrB,yFAAyF;IACzF,oCAAyB,CAAA;IACzB,6EAA6E;IAC7E,kCAAuB,CAAA;AACzB,CAAC,EAXW,OAAO,uBAAP,OAAO,QAWlB;AAyED,IAAY,IAKX;AALD,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,uBAAe,CAAA;IACf,uBAAe,CAAA;IACf,qBAAa,CAAA;AACf,CAAC,EALW,IAAI,oBAAJ,IAAI,QAKf;AAoBD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAsDD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA0VD,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,mDAAmD;IACnD,2BAAmB,CAAA;IACnB,wDAAwD;IACxD,+BAAuB,CAAA;IACvB,0CAA0C;IAC1C,2BAAmB,CAAA;IACnB,2CAA2C;IAC3C,yBAAiB,CAAA;IACjB,uEAAuE;IACvE,+BAAuB,CAAA;IACvB,0DAA0D;IAC1D,2CAAmC,CAAA;AACrC,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAmCD,IAAY,+BAOX;AAPD,WAAY,+BAA+B;IACzC,oBAAoB;IACpB,sDAAmB,CAAA;IACnB,qDAAqD;IACrD,8CAAW,CAAA;IACX,6CAA6C;IAC7C,4CAAS,CAAA;AACX,CAAC,EAPW,+BAA+B,+CAA/B,+BAA+B,QAO1C;AAkED,IAAY,KAMX;AAND,WAAY,KAAK;IACf,gCAAuB,CAAA;IACvB,wCAAwC;IACxC,wBAAe,CAAA;IACf,0CAA0C;IAC1C,gCAAuB,CAAA;AACzB,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB"}
@@ -114,6 +114,8 @@ export interface WixLink extends WixLinkLinkOneOf {
114
114
  address?: AddressLink;
115
115
  /** WhatsApp link type */
116
116
  whatsApp?: WhatsAppLink;
117
+ /** TPA link type */
118
+ tpaPage?: TpaPageLink;
117
119
  }
118
120
  /** @oneof */
119
121
  export interface WixLinkLinkOneOf {
@@ -135,6 +137,8 @@ export interface WixLinkLinkOneOf {
135
137
  address?: AddressLink;
136
138
  /** WhatsApp link type */
137
139
  whatsApp?: WhatsAppLink;
140
+ /** TPA link type */
141
+ tpaPage?: TpaPageLink;
138
142
  }
139
143
  export interface ExternalLink {
140
144
  /** The url of the page */
@@ -147,6 +151,25 @@ export interface PageLink {
147
151
  pageId?: string;
148
152
  /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
149
153
  target?: string | null;
154
+ /** rel of link */
155
+ rel?: LinkRel[];
156
+ }
157
+ /**
158
+ * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
159
+ * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
160
+ * Following are the accepted 'rel' types by Wix applications.
161
+ */
162
+ export declare enum LinkRel {
163
+ /** default (not implemented) */
164
+ unknown_link_rel = "unknown_link_rel",
165
+ /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
166
+ nofollow = "nofollow",
167
+ /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
168
+ noopener = "noopener",
169
+ /** No Referer header will be included. Additionally, has the same effect as noopener. */
170
+ noreferrer = "noreferrer",
171
+ /** Indicates a link that resulted from advertisements or paid placements. */
172
+ sponsored = "sponsored"
150
173
  }
151
174
  export interface AnchorLink {
152
175
  /** The name of the anchor */
@@ -155,6 +178,8 @@ export interface AnchorLink {
155
178
  anchorDataId?: string;
156
179
  /** The page id we want from the site */
157
180
  pageId?: string;
181
+ /** rel of link */
182
+ rel?: LinkRel[];
158
183
  }
159
184
  export interface DynamicPageLink {
160
185
  /** The router that handles this link */
@@ -163,6 +188,8 @@ export interface DynamicPageLink {
163
188
  innerRoute?: string;
164
189
  /** The data id (from the JSON page) of the anchor that should be used */
165
190
  anchorDataId?: string | null;
191
+ /** rel of link */
192
+ rel?: LinkRel[];
166
193
  }
167
194
  export interface DocumentLink {
168
195
  /** The id of the document */
@@ -192,6 +219,21 @@ export interface WhatsAppLink {
192
219
  /** The whatsApp phone number we want to connect with */
193
220
  phoneNumber?: string;
194
221
  }
222
+ /** Link to a TPA page */
223
+ export interface TpaPageLink {
224
+ /** Type of item (e.g. 'wix.stores.sub_pages.product') */
225
+ itemTypeIdentifier?: string;
226
+ /** Id of linked item */
227
+ itemId?: string;
228
+ /** Id of linked page */
229
+ pageId?: string;
230
+ /** Id of app being linked to (AppDefId) */
231
+ appDefinitionId?: string;
232
+ /** The relativepath of linked page */
233
+ path?: string;
234
+ /** rel of link */
235
+ rel?: LinkRel[];
236
+ }
195
237
  export declare enum Type {
196
238
  UNDEFINED = "UNDEFINED",
197
239
  IMAGE = "IMAGE",
@@ -433,6 +475,74 @@ export interface HtmlSiteRCPublished {
433
475
  /** Optional branch Id */
434
476
  branchId?: string | null;
435
477
  }
478
+ export interface DomainEvent extends DomainEventBodyOneOf {
479
+ /** Information about a newly-created gallery. */
480
+ createdEvent?: EntityCreatedEvent;
481
+ updatedEvent?: EntityUpdatedEvent;
482
+ deletedEvent?: EntityDeletedEvent;
483
+ actionEvent?: ActionEvent;
484
+ /**
485
+ * Unique event ID.
486
+ * Allows clients to ignore duplicate webhooks.
487
+ */
488
+ _id?: string;
489
+ /**
490
+ * Assumes actions are also always typed to an entity_type
491
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
492
+ */
493
+ entityFqdn?: string;
494
+ /**
495
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
496
+ * This is although the created/updated/deleted notion is duplication of the oneof types
497
+ * Example: created/updated/deleted/started/completed/email_opened
498
+ */
499
+ slug?: string;
500
+ /** ID of the entity associated with the event. */
501
+ entityId?: string;
502
+ /** Event timestamp. */
503
+ eventTime?: Date;
504
+ /**
505
+ * Whether the event was triggered as a result of a privacy regulation application
506
+ * (for example, GDPR).
507
+ */
508
+ triggeredByAnonymizeRequest?: boolean | null;
509
+ /** If present, indicates the action that triggered the event. */
510
+ originatedFrom?: string | null;
511
+ /**
512
+ * A sequence number defining the order of updates to the underlying entity.
513
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
514
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
515
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
516
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
517
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
518
+ */
519
+ entityEventSequence?: string | null;
520
+ }
521
+ /** @oneof */
522
+ export interface DomainEventBodyOneOf {
523
+ createdEvent?: EntityCreatedEvent;
524
+ updatedEvent?: EntityUpdatedEvent;
525
+ deletedEvent?: EntityDeletedEvent;
526
+ actionEvent?: ActionEvent;
527
+ }
528
+ export interface EntityCreatedEvent {
529
+ entityAsJson?: string;
530
+ }
531
+ export interface EntityUpdatedEvent {
532
+ /**
533
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
534
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
535
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
536
+ */
537
+ currentEntityAsJson?: string;
538
+ }
539
+ export interface EntityDeletedEvent {
540
+ /** Entity that was deleted */
541
+ deletedEntityAsJson?: string | null;
542
+ }
543
+ export interface ActionEvent {
544
+ bodyAsJson?: string;
545
+ }
436
546
  export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
437
547
  /** insert/update documents */
438
548
  update?: DocumentUpdateOperation;
@@ -481,6 +591,8 @@ export interface IndexDocument {
481
591
  permittedMemberGroups?: string[];
482
592
  /** if true SEO is disabled for this document */
483
593
  seoHidden?: boolean | null;
594
+ /** if true the page is a lightbox popup */
595
+ isPopup?: boolean | null;
484
596
  }
485
597
  export interface DocumentPayload {
486
598
  /** url of the page representing the document */
@@ -738,77 +850,171 @@ export interface PublishGalleryResponse {
738
850
  /** Published gallery. */
739
851
  gallery?: Gallery;
740
852
  }
741
- export interface DomainEvent extends DomainEventBodyOneOf {
742
- /** Information about a newly-created gallery. */
743
- createdEvent?: EntityCreatedEvent;
744
- updatedEvent?: EntityUpdatedEvent;
745
- deletedEvent?: EntityDeletedEvent;
746
- actionEvent?: ActionEvent;
747
- extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
748
- /** random GUID so clients can tell if event was already handled */
749
- _id?: string;
750
- /**
751
- * Assumes actions are also always typed to an entity_type
752
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
753
- */
754
- entityFqdn?: string;
755
- /**
756
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
757
- * This is although the created/updated/deleted notion is duplication of the oneof types
758
- * Example: created/updated/deleted/started/completed/email_opened
759
- */
760
- slug?: string;
761
- /**
762
- * Assuming that all messages including Actions have id
763
- * Example: The id of the specific order, the id of a specific campaign
764
- */
765
- entityId?: string;
766
- /** The time of the event. Useful if there was a delay in dispatching */
767
- eventTime?: Date;
768
- /**
769
- * A field that should be set if this event was triggered by an anonymize request.
770
- * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
771
- * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
772
- */
773
- triggeredByAnonymizeRequest?: boolean | null;
774
- /** If present, indicates the action that triggered the event. */
775
- originatedFrom?: string | null;
776
- /**
777
- * A sequence number defining the order of updates to the underlying entity.
778
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
779
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
780
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
781
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
782
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
783
- */
784
- entityEventSequence?: string | null;
853
+ export interface ListGalleriesResponseNonNullableFields {
854
+ galleries: {
855
+ items: {
856
+ image?: {
857
+ imageInfo: string;
858
+ focalPoint?: {
859
+ x: number;
860
+ y: number;
861
+ };
862
+ };
863
+ video?: {
864
+ type: VideoType;
865
+ videoInfo: string;
866
+ };
867
+ type: Type;
868
+ tags?: {
869
+ values: string[];
870
+ };
871
+ }[];
872
+ }[];
873
+ }
874
+ export interface GetGalleryResponseNonNullableFields {
875
+ gallery?: {
876
+ items: {
877
+ image?: {
878
+ imageInfo: string;
879
+ focalPoint?: {
880
+ x: number;
881
+ y: number;
882
+ };
883
+ };
884
+ video?: {
885
+ type: VideoType;
886
+ videoInfo: string;
887
+ };
888
+ type: Type;
889
+ tags?: {
890
+ values: string[];
891
+ };
892
+ }[];
893
+ };
785
894
  }
786
- /** @oneof */
787
- export interface DomainEventBodyOneOf {
788
- createdEvent?: EntityCreatedEvent;
789
- updatedEvent?: EntityUpdatedEvent;
790
- deletedEvent?: EntityDeletedEvent;
791
- actionEvent?: ActionEvent;
792
- extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
895
+ export interface ListGalleryItemsResponseNonNullableFields {
896
+ items: {
897
+ image?: {
898
+ imageInfo: string;
899
+ focalPoint?: {
900
+ x: number;
901
+ y: number;
902
+ };
903
+ };
904
+ video?: {
905
+ type: VideoType;
906
+ videoInfo: string;
907
+ };
908
+ type: Type;
909
+ tags?: {
910
+ values: string[];
911
+ };
912
+ }[];
913
+ }
914
+ export interface GetGalleryItemResponseNonNullableFields {
915
+ item?: {
916
+ image?: {
917
+ imageInfo: string;
918
+ focalPoint?: {
919
+ x: number;
920
+ y: number;
921
+ };
922
+ };
923
+ video?: {
924
+ type: VideoType;
925
+ videoInfo: string;
926
+ };
927
+ type: Type;
928
+ tags?: {
929
+ values: string[];
930
+ };
931
+ };
793
932
  }
794
- export interface EntityCreatedEvent {
795
- entityAsJson?: string;
933
+ export interface CreateGalleryResponseNonNullableFields {
934
+ gallery?: {
935
+ items: {
936
+ image?: {
937
+ imageInfo: string;
938
+ focalPoint?: {
939
+ x: number;
940
+ y: number;
941
+ };
942
+ };
943
+ video?: {
944
+ type: VideoType;
945
+ videoInfo: string;
946
+ };
947
+ type: Type;
948
+ tags?: {
949
+ values: string[];
950
+ };
951
+ }[];
952
+ };
796
953
  }
797
- export interface EntityUpdatedEvent {
798
- /**
799
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
800
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
801
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
802
- */
803
- currentEntityAsJson?: string;
954
+ export interface UpdateGalleryResponseNonNullableFields {
955
+ gallery?: {
956
+ items: {
957
+ image?: {
958
+ imageInfo: string;
959
+ focalPoint?: {
960
+ x: number;
961
+ y: number;
962
+ };
963
+ };
964
+ video?: {
965
+ type: VideoType;
966
+ videoInfo: string;
967
+ };
968
+ type: Type;
969
+ tags?: {
970
+ values: string[];
971
+ };
972
+ }[];
973
+ };
804
974
  }
805
- export interface EntityDeletedEvent {
975
+ export interface DeleteGalleryResponseNonNullableFields {
976
+ galleryId: string;
806
977
  }
807
- export interface ActionEvent {
808
- bodyAsJson?: string;
978
+ export interface CreateGalleryItemResponseNonNullableFields {
979
+ item?: {
980
+ image?: {
981
+ imageInfo: string;
982
+ focalPoint?: {
983
+ x: number;
984
+ y: number;
985
+ };
986
+ };
987
+ video?: {
988
+ type: VideoType;
989
+ videoInfo: string;
990
+ };
991
+ type: Type;
992
+ tags?: {
993
+ values: string[];
994
+ };
995
+ };
809
996
  }
810
- export interface ExtendedFieldsUpdatedEvent {
811
- currentEntityAsJson?: string;
997
+ export interface UpdateGalleryItemResponseNonNullableFields {
998
+ item?: {
999
+ image?: {
1000
+ imageInfo: string;
1001
+ focalPoint?: {
1002
+ x: number;
1003
+ y: number;
1004
+ };
1005
+ };
1006
+ video?: {
1007
+ type: VideoType;
1008
+ videoInfo: string;
1009
+ };
1010
+ type: Type;
1011
+ tags?: {
1012
+ values: string[];
1013
+ };
1014
+ };
1015
+ }
1016
+ export interface DeleteGalleryItemResponseNonNullableFields {
1017
+ itemId: string;
812
1018
  }
813
1019
  /**
814
1020
  * Retrieves a list of galleries.
@@ -817,12 +1023,15 @@ export interface ExtendedFieldsUpdatedEvent {
817
1023
  * @public
818
1024
  * @documentationMaturity preview
819
1025
  * @param options - Options to use when getting the list of galleries.
1026
+ * @permissionScope Manage Galleries
1027
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
820
1028
  * @permissionScope Read Galleries
1029
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
821
1030
  * @applicableIdentity APP
822
1031
  * @applicableIdentity MEMBER
823
1032
  * @applicableIdentity VISITOR
824
1033
  */
825
- export declare function listGalleries(options?: ListGalleriesOptions): Promise<ListGalleriesResponse>;
1034
+ export declare function listGalleries(options?: ListGalleriesOptions): Promise<ListGalleriesResponse & ListGalleriesResponseNonNullableFields>;
826
1035
  export interface ListGalleriesOptions {
827
1036
  /** Number of galleries to list. Defaults to 10. */
828
1037
  itemLimit?: number | null;
@@ -840,13 +1049,16 @@ export interface ListGalleriesOptions {
840
1049
  * @documentationMaturity preview
841
1050
  * @requiredField galleryId
842
1051
  * @param options - Options to use when getting the gallery.
1052
+ * @permissionScope Manage Galleries
1053
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
843
1054
  * @permissionScope Read Galleries
1055
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
844
1056
  * @applicableIdentity APP
845
1057
  * @applicableIdentity MEMBER
846
1058
  * @applicableIdentity VISITOR
847
1059
  * @returns Returned gallery.
848
1060
  */
849
- export declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<Gallery>;
1061
+ export declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<Gallery & NonNullable<GetGalleryResponseNonNullableFields>['gallery']>;
850
1062
  export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
851
1063
  /** Number of media items to skip in the returns. Defaults to 0. */
852
1064
  itemOffset?: number | null;
@@ -868,12 +1080,15 @@ export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
868
1080
  * @documentationMaturity preview
869
1081
  * @requiredField galleryId
870
1082
  * @param options - Options to use when getting the list of gallery items.
1083
+ * @permissionScope Manage Galleries
1084
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
871
1085
  * @permissionScope Read Galleries
1086
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
872
1087
  * @applicableIdentity APP
873
1088
  * @applicableIdentity MEMBER
874
1089
  * @applicableIdentity VISITOR
875
1090
  */
876
- export declare function listGalleryItems(galleryId: string, options?: ListGalleryItemsOptions): Promise<ListGalleryItemsResponse>;
1091
+ export declare function listGalleryItems(galleryId: string, options?: ListGalleryItemsOptions): Promise<ListGalleryItemsResponse & ListGalleryItemsResponseNonNullableFields>;
877
1092
  export interface ListGalleryItemsOptions {
878
1093
  /** Number of media items to skip in the returns. Defaults to 0. */
879
1094
  itemOffset?: number | null;
@@ -896,13 +1111,16 @@ export interface ListGalleryItemsOptions {
896
1111
  * @requiredField identifiers.galleryId
897
1112
  * @requiredField identifiers.itemId
898
1113
  * @param identifiers - Gallery ID and Item ID.
1114
+ * @permissionScope Manage Galleries
1115
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
899
1116
  * @permissionScope Read Galleries
1117
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
900
1118
  * @applicableIdentity APP
901
1119
  * @applicableIdentity MEMBER
902
1120
  * @applicableIdentity VISITOR
903
1121
  * @returns Returned media item.
904
1122
  */
905
- export declare function getGalleryItem(identifiers: GetGalleryItemIdentifiers): Promise<Item>;
1123
+ export declare function getGalleryItem(identifiers: GetGalleryItemIdentifiers): Promise<Item & NonNullable<GetGalleryItemResponseNonNullableFields>['item']>;
906
1124
  export interface GetGalleryItemIdentifiers {
907
1125
  /** Gallery ID. */
908
1126
  galleryId: string;
@@ -937,10 +1155,11 @@ export interface GetGalleryItemIdentifiers {
937
1155
  * @requiredField options.gallery.items.video.videoInfo
938
1156
  * @param options - Options to use when creating the gallery.
939
1157
  * @permissionScope Manage Galleries
1158
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
940
1159
  * @applicableIdentity APP
941
1160
  * @returns Created gallery.
942
1161
  */
943
- export declare function createGallery(options?: CreateGalleryOptions): Promise<Gallery>;
1162
+ export declare function createGallery(options?: CreateGalleryOptions): Promise<Gallery & NonNullable<CreateGalleryResponseNonNullableFields>['gallery']>;
944
1163
  export interface CreateGalleryOptions {
945
1164
  /** Gallery to create. */
946
1165
  gallery?: Gallery;
@@ -974,10 +1193,11 @@ export interface CreateGalleryOptions {
974
1193
  * @param _id - ID of the gallery to update.
975
1194
  * @param gallery - The information for the gallery being updated.
976
1195
  * @permissionScope Manage Galleries
1196
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
977
1197
  * @applicableIdentity APP
978
1198
  * @returns Updated gallery.
979
1199
  */
980
- export declare function updateGallery(_id: string | null, gallery: UpdateGallery): Promise<Gallery>;
1200
+ export declare function updateGallery(_id: string | null, gallery: UpdateGallery): Promise<Gallery & NonNullable<UpdateGalleryResponseNonNullableFields>['gallery']>;
981
1201
  export interface UpdateGallery {
982
1202
  /**
983
1203
  * Gallery ID.
@@ -1020,9 +1240,10 @@ export interface UpdateGallery {
1020
1240
  * @documentationMaturity preview
1021
1241
  * @requiredField galleryId
1022
1242
  * @permissionScope Manage Galleries
1243
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1023
1244
  * @applicableIdentity APP
1024
1245
  */
1025
- export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryResponse>;
1246
+ export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryResponse & DeleteGalleryResponseNonNullableFields>;
1026
1247
  /**
1027
1248
  * Creates a media item in a specified gallery.
1028
1249
  *
@@ -1050,10 +1271,11 @@ export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryR
1050
1271
  * @requiredField item.text.html
1051
1272
  * @requiredField item.video.videoInfo
1052
1273
  * @permissionScope Manage Galleries
1274
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1053
1275
  * @applicableIdentity APP
1054
1276
  * @returns Created media item.
1055
1277
  */
1056
- export declare function createGalleryItem(galleryId: string, item: Item): Promise<Item>;
1278
+ export declare function createGalleryItem(galleryId: string, item: Item): Promise<Item & NonNullable<CreateGalleryItemResponseNonNullableFields>['item']>;
1057
1279
  /**
1058
1280
  * Updates a media item in a specified gallery.
1059
1281
  *
@@ -1083,10 +1305,11 @@ export declare function createGalleryItem(galleryId: string, item: Item): Promis
1083
1305
  * @param item - The information for the gallery item being updated.
1084
1306
  * @param identifiers - Gallery ID and Item ID.
1085
1307
  * @permissionScope Manage Galleries
1308
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1086
1309
  * @applicableIdentity APP
1087
1310
  * @returns Updated media item.
1088
1311
  */
1089
- export declare function updateGalleryItem(identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem): Promise<Item>;
1312
+ export declare function updateGalleryItem(identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem): Promise<Item & NonNullable<UpdateGalleryItemResponseNonNullableFields>['item']>;
1090
1313
  export interface UpdateGalleryItemIdentifiers {
1091
1314
  /** ID of the gallery containing the item to update. */
1092
1315
  galleryId: string;
@@ -1154,9 +1377,10 @@ export interface UpdateGalleryItem {
1154
1377
  * @requiredField identifiers.itemId
1155
1378
  * @param identifiers - Gallery ID and Item ID.
1156
1379
  * @permissionScope Manage Galleries
1380
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1157
1381
  * @applicableIdentity APP
1158
1382
  */
1159
- export declare function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse>;
1383
+ export declare function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
1160
1384
  export interface DeleteGalleryItemIdentifiers {
1161
1385
  /** Gallery ID. */
1162
1386
  galleryId: string;