@wix/auto_sdk_consent-policy_cmp 1.0.2 → 1.0.4

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 (21) hide show
  1. package/build/cjs/src/bu-legal-v2-cmp-config-cmp.public.js.map +1 -1
  2. package/build/cjs/src/bu-legal-v2-cmp-config-cmp.types.d.ts +12 -18
  3. package/build/cjs/src/bu-legal-v2-cmp-config-cmp.types.js.map +1 -1
  4. package/build/cjs/src/bu-legal-v2-cmp-config-cmp.universal.d.ts +14 -19
  5. package/build/cjs/src/bu-legal-v2-cmp-config-cmp.universal.js.map +1 -1
  6. package/build/es/src/bu-legal-v2-cmp-config-cmp.public.js.map +1 -1
  7. package/build/es/src/bu-legal-v2-cmp-config-cmp.types.d.ts +12 -18
  8. package/build/es/src/bu-legal-v2-cmp-config-cmp.types.js.map +1 -1
  9. package/build/es/src/bu-legal-v2-cmp-config-cmp.universal.d.ts +14 -19
  10. package/build/es/src/bu-legal-v2-cmp-config-cmp.universal.js.map +1 -1
  11. package/build/internal/cjs/src/bu-legal-v2-cmp-config-cmp.public.js.map +1 -1
  12. package/build/internal/cjs/src/bu-legal-v2-cmp-config-cmp.types.d.ts +12 -18
  13. package/build/internal/cjs/src/bu-legal-v2-cmp-config-cmp.types.js.map +1 -1
  14. package/build/internal/cjs/src/bu-legal-v2-cmp-config-cmp.universal.d.ts +14 -19
  15. package/build/internal/cjs/src/bu-legal-v2-cmp-config-cmp.universal.js.map +1 -1
  16. package/build/internal/es/src/bu-legal-v2-cmp-config-cmp.public.js.map +1 -1
  17. package/build/internal/es/src/bu-legal-v2-cmp-config-cmp.types.d.ts +12 -18
  18. package/build/internal/es/src/bu-legal-v2-cmp-config-cmp.types.js.map +1 -1
  19. package/build/internal/es/src/bu-legal-v2-cmp-config-cmp.universal.d.ts +14 -19
  20. package/build/internal/es/src/bu-legal-v2-cmp-config-cmp.universal.js.map +1 -1
  21. package/package.json +4 -4
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":";;;AACA,uGAImD;AAEtC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,IAAA,sDAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,oCAMC;AAUD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAoB,EAAE,EAAE,CAC9B,IAAA,yDAAwB,EACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAWD,qGAiBmD;AADjD,8IAAA,mBAAmB,OAAA"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":";;;AACA,uGAImD;AAEtC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,IAAA,sDAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,oCAMC;AAUD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAkD,EAAE,EAAE,CAC5D,IAAA,yDAAwB,EACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAWD,qGAiBmD;AADjD,8IAAA,mBAAmB,OAAA"}
@@ -43,25 +43,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
43
  updatedEvent?: EntityUpdatedEvent;
44
44
  deletedEvent?: EntityDeletedEvent;
45
45
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
46
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
47
  id?: string;
51
48
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
49
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
50
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
51
  */
55
52
  entityFqdn?: string;
56
53
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
54
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
55
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
56
  */
61
57
  slug?: string;
62
58
  /** ID of the entity associated with the event. */
63
59
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
60
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
61
  eventTime?: Date | null;
66
62
  /**
67
63
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +67,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
67
  /** If present, indicates the action that triggered the event. */
72
68
  originatedFrom?: string | null;
73
69
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
70
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
71
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
72
  */
81
73
  entityEventSequence?: string | null;
82
74
  }
@@ -104,7 +96,7 @@ export interface EntityUpdatedEvent {
104
96
  currentEntityAsJson?: string;
105
97
  }
106
98
  export interface EntityDeletedEvent {
107
- /** Entity that was deleted */
99
+ /** Entity that was deleted. */
108
100
  deletedEntityAsJson?: string | null;
109
101
  }
110
102
  export interface ActionEvent {
@@ -148,7 +140,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
148
140
  */
149
141
  appId?: string;
150
142
  /** @readonly */
151
- identityType?: WebhookIdentityType;
143
+ identityType?: WebhookIdentityTypeWithLiterals;
152
144
  }
153
145
  /** @oneof */
154
146
  export interface IdentificationDataIdOneOf {
@@ -180,3 +172,5 @@ export declare enum WebhookIdentityType {
180
172
  WIX_USER = "WIX_USER",
181
173
  APP = "APP"
182
174
  }
175
+ /** @enumType */
176
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":";;;AA6LA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":";;;AAqLA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -1,3 +1,4 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
1
2
  /**
2
3
  * A CMP Config is a collection of settings and parameters defined within a consent management platform.
3
4
  *
@@ -43,25 +44,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
44
  updatedEvent?: EntityUpdatedEvent;
44
45
  deletedEvent?: EntityDeletedEvent;
45
46
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
47
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
48
  _id?: string;
51
49
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
50
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
51
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
52
  */
55
53
  entityFqdn?: string;
56
54
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
55
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
56
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
57
  */
61
58
  slug?: string;
62
59
  /** ID of the entity associated with the event. */
63
60
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
61
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
62
  eventTime?: Date | null;
66
63
  /**
67
64
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +68,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
68
  /** If present, indicates the action that triggered the event. */
72
69
  originatedFrom?: string | null;
73
70
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
71
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
72
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
73
  */
81
74
  entityEventSequence?: string | null;
82
75
  }
@@ -102,7 +95,7 @@ export interface EntityUpdatedEvent {
102
95
  currentEntity?: string;
103
96
  }
104
97
  export interface EntityDeletedEvent {
105
- /** Entity that was deleted */
98
+ /** Entity that was deleted. */
106
99
  deletedEntity?: string | null;
107
100
  }
108
101
  export interface ActionEvent {
@@ -146,7 +139,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
146
139
  */
147
140
  appId?: string;
148
141
  /** @readonly */
149
- identityType?: WebhookIdentityType;
142
+ identityType?: WebhookIdentityTypeWithLiterals;
150
143
  }
151
144
  /** @oneof */
152
145
  export interface IdentificationDataIdOneOf {
@@ -178,6 +171,8 @@ export declare enum WebhookIdentityType {
178
171
  WIX_USER = "WIX_USER",
179
172
  APP = "APP"
180
173
  }
174
+ /** @enumType */
175
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
181
176
  /**
182
177
  * Retrieves a CMP config.
183
178
  * @public
@@ -206,4 +201,4 @@ export declare function getCmpConfig(): Promise<CmpConfig>;
206
201
  * @returns Updated CMP config.
207
202
  * @fqn wix.bu.legal.v2.CmpConfigService.UpdateCmpConfig
208
203
  */
209
- export declare function updateCmpConfig(cmpConfig: CmpConfig): Promise<CmpConfig>;
204
+ export declare function updateCmpConfig(cmpConfig: NonNullablePaths<CmpConfig, `revision`>): Promise<CmpConfig>;
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,sGAAwF;AA6LxF,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA/BD,oCA+BC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,eAAe,CACnC,SAAoB;IAEpB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,0CAmCC"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,sGAAwF;AAqLxF,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAWD;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA/BD,oCA+BC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,eAAe,CACnC,SAAkD;IAElD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,0CAmCC"}
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,YAAY,IAAI,qBAAqB,EACrC,eAAe,IAAI,wBAAwB,GAC5C,MAAM,2CAA2C,CAAC;AAEnD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAoB,EAAE,EAAE,CAC9B,wBAAwB,CACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,OAAO,EAgBL,mBAAmB,GACpB,MAAM,2CAA2C,CAAC"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,YAAY,IAAI,qBAAqB,EACrC,eAAe,IAAI,wBAAwB,GAC5C,MAAM,2CAA2C,CAAC;AAEnD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAkD,EAAE,EAAE,CAC5D,wBAAwB,CACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,OAAO,EAgBL,mBAAmB,GACpB,MAAM,2CAA2C,CAAC"}
@@ -43,25 +43,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
43
  updatedEvent?: EntityUpdatedEvent;
44
44
  deletedEvent?: EntityDeletedEvent;
45
45
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
46
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
47
  id?: string;
51
48
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
49
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
50
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
51
  */
55
52
  entityFqdn?: string;
56
53
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
54
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
55
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
56
  */
61
57
  slug?: string;
62
58
  /** ID of the entity associated with the event. */
63
59
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
60
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
61
  eventTime?: Date | null;
66
62
  /**
67
63
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +67,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
67
  /** If present, indicates the action that triggered the event. */
72
68
  originatedFrom?: string | null;
73
69
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
70
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
71
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
72
  */
81
73
  entityEventSequence?: string | null;
82
74
  }
@@ -104,7 +96,7 @@ export interface EntityUpdatedEvent {
104
96
  currentEntityAsJson?: string;
105
97
  }
106
98
  export interface EntityDeletedEvent {
107
- /** Entity that was deleted */
99
+ /** Entity that was deleted. */
108
100
  deletedEntityAsJson?: string | null;
109
101
  }
110
102
  export interface ActionEvent {
@@ -148,7 +140,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
148
140
  */
149
141
  appId?: string;
150
142
  /** @readonly */
151
- identityType?: WebhookIdentityType;
143
+ identityType?: WebhookIdentityTypeWithLiterals;
152
144
  }
153
145
  /** @oneof */
154
146
  export interface IdentificationDataIdOneOf {
@@ -180,3 +172,5 @@ export declare enum WebhookIdentityType {
180
172
  WIX_USER = "WIX_USER",
181
173
  APP = "APP"
182
174
  }
175
+ /** @enumType */
176
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":"AA6LA,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":"AAqLA,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
@@ -1,3 +1,4 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
1
2
  /**
2
3
  * A CMP Config is a collection of settings and parameters defined within a consent management platform.
3
4
  *
@@ -43,25 +44,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
44
  updatedEvent?: EntityUpdatedEvent;
44
45
  deletedEvent?: EntityDeletedEvent;
45
46
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
47
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
48
  _id?: string;
51
49
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
50
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
51
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
52
  */
55
53
  entityFqdn?: string;
56
54
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
55
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
56
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
57
  */
61
58
  slug?: string;
62
59
  /** ID of the entity associated with the event. */
63
60
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
61
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
62
  eventTime?: Date | null;
66
63
  /**
67
64
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +68,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
68
  /** If present, indicates the action that triggered the event. */
72
69
  originatedFrom?: string | null;
73
70
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
71
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
72
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
73
  */
81
74
  entityEventSequence?: string | null;
82
75
  }
@@ -102,7 +95,7 @@ export interface EntityUpdatedEvent {
102
95
  currentEntity?: string;
103
96
  }
104
97
  export interface EntityDeletedEvent {
105
- /** Entity that was deleted */
98
+ /** Entity that was deleted. */
106
99
  deletedEntity?: string | null;
107
100
  }
108
101
  export interface ActionEvent {
@@ -146,7 +139,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
146
139
  */
147
140
  appId?: string;
148
141
  /** @readonly */
149
- identityType?: WebhookIdentityType;
142
+ identityType?: WebhookIdentityTypeWithLiterals;
150
143
  }
151
144
  /** @oneof */
152
145
  export interface IdentificationDataIdOneOf {
@@ -178,6 +171,8 @@ export declare enum WebhookIdentityType {
178
171
  WIX_USER = "WIX_USER",
179
172
  APP = "APP"
180
173
  }
174
+ /** @enumType */
175
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
181
176
  /**
182
177
  * Retrieves a CMP config.
183
178
  * @public
@@ -206,4 +201,4 @@ export declare function getCmpConfig(): Promise<CmpConfig>;
206
201
  * @returns Updated CMP config.
207
202
  * @fqn wix.bu.legal.v2.CmpConfigService.UpdateCmpConfig
208
203
  */
209
- export declare function updateCmpConfig(cmpConfig: CmpConfig): Promise<CmpConfig>;
204
+ export declare function updateCmpConfig(cmpConfig: NonNullablePaths<CmpConfig, `revision`>): Promise<CmpConfig>;
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,+BAA+B,MAAM,sCAAsC,CAAC;AA6LxF,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,SAAoB;IAEpB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,+BAA+B,MAAM,sCAAsC,CAAC;AAqLxF,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAWD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,SAAkD;IAElD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":";;;AACA,uGAImD;AAEtC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,IAAA,sDAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,oCAMC;AAUD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAoB,EAAE,EAAE,CAC9B,IAAA,yDAAwB,EACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAWD,qGAiBmD;AADjD,8IAAA,mBAAmB,OAAA"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":";;;AACA,uGAImD;AAEtC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,IAAA,sDAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,oCAMC;AAUD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAkD,EAAE,EAAE,CAC5D,IAAA,yDAAwB,EACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAWD,qGAiBmD;AADjD,8IAAA,mBAAmB,OAAA"}
@@ -43,25 +43,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
43
  updatedEvent?: EntityUpdatedEvent;
44
44
  deletedEvent?: EntityDeletedEvent;
45
45
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
46
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
47
  id?: string;
51
48
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
49
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
50
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
51
  */
55
52
  entityFqdn?: string;
56
53
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
54
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
55
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
56
  */
61
57
  slug?: string;
62
58
  /** ID of the entity associated with the event. */
63
59
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
60
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
61
  eventTime?: Date | null;
66
62
  /**
67
63
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +67,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
67
  /** If present, indicates the action that triggered the event. */
72
68
  originatedFrom?: string | null;
73
69
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
70
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
71
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
72
  */
81
73
  entityEventSequence?: string | null;
82
74
  }
@@ -104,7 +96,7 @@ export interface EntityUpdatedEvent {
104
96
  currentEntityAsJson?: string;
105
97
  }
106
98
  export interface EntityDeletedEvent {
107
- /** Entity that was deleted */
99
+ /** Entity that was deleted. */
108
100
  deletedEntityAsJson?: string | null;
109
101
  }
110
102
  export interface ActionEvent {
@@ -148,7 +140,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
148
140
  */
149
141
  appId?: string;
150
142
  /** @readonly */
151
- identityType?: WebhookIdentityType;
143
+ identityType?: WebhookIdentityTypeWithLiterals;
152
144
  }
153
145
  /** @oneof */
154
146
  export interface IdentificationDataIdOneOf {
@@ -180,3 +172,5 @@ export declare enum WebhookIdentityType {
180
172
  WIX_USER = "WIX_USER",
181
173
  APP = "APP"
182
174
  }
175
+ /** @enumType */
176
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":";;;AA6LA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":";;;AAqLA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -1,3 +1,4 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
1
2
  /**
2
3
  * A CMP Config is a collection of settings and parameters defined within a consent management platform.
3
4
  *
@@ -43,25 +44,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
44
  updatedEvent?: EntityUpdatedEvent;
44
45
  deletedEvent?: EntityDeletedEvent;
45
46
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
47
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
48
  _id?: string;
51
49
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
50
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
51
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
52
  */
55
53
  entityFqdn?: string;
56
54
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
55
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
56
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
57
  */
61
58
  slug?: string;
62
59
  /** ID of the entity associated with the event. */
63
60
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
61
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
62
  eventTime?: Date | null;
66
63
  /**
67
64
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +68,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
68
  /** If present, indicates the action that triggered the event. */
72
69
  originatedFrom?: string | null;
73
70
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
71
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
72
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
73
  */
81
74
  entityEventSequence?: string | null;
82
75
  }
@@ -102,7 +95,7 @@ export interface EntityUpdatedEvent {
102
95
  currentEntity?: string;
103
96
  }
104
97
  export interface EntityDeletedEvent {
105
- /** Entity that was deleted */
98
+ /** Entity that was deleted. */
106
99
  deletedEntity?: string | null;
107
100
  }
108
101
  export interface ActionEvent {
@@ -146,7 +139,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
146
139
  */
147
140
  appId?: string;
148
141
  /** @readonly */
149
- identityType?: WebhookIdentityType;
142
+ identityType?: WebhookIdentityTypeWithLiterals;
150
143
  }
151
144
  /** @oneof */
152
145
  export interface IdentificationDataIdOneOf {
@@ -178,6 +171,8 @@ export declare enum WebhookIdentityType {
178
171
  WIX_USER = "WIX_USER",
179
172
  APP = "APP"
180
173
  }
174
+ /** @enumType */
175
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
181
176
  /**
182
177
  * Retrieves a CMP config.
183
178
  * @public
@@ -206,4 +201,4 @@ export declare function getCmpConfig(): Promise<CmpConfig>;
206
201
  * @returns Updated CMP config.
207
202
  * @fqn wix.bu.legal.v2.CmpConfigService.UpdateCmpConfig
208
203
  */
209
- export declare function updateCmpConfig(cmpConfig: CmpConfig): Promise<CmpConfig>;
204
+ export declare function updateCmpConfig(cmpConfig: NonNullablePaths<CmpConfig, `revision`>): Promise<CmpConfig>;
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,sGAAwF;AA6LxF,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA/BD,oCA+BC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,eAAe,CACnC,SAAoB;IAEpB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,0CAmCC"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,sGAAwF;AAqLxF,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAWD;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA/BD,oCA+BC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,eAAe,CACnC,SAAkD;IAElD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,0CAmCC"}
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,YAAY,IAAI,qBAAqB,EACrC,eAAe,IAAI,wBAAwB,GAC5C,MAAM,2CAA2C,CAAC;AAEnD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAoB,EAAE,EAAE,CAC9B,wBAAwB,CACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,OAAO,EAgBL,mBAAmB,GACpB,MAAM,2CAA2C,CAAC"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.public.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.public.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,YAAY,IAAI,qBAAqB,EACrC,eAAe,IAAI,wBAAwB,GAC5C,MAAM,2CAA2C,CAAC;AAEnD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,SAAkD,EAAE,EAAE,CAC5D,wBAAwB,CACtB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,OAAO,EAgBL,mBAAmB,GACpB,MAAM,2CAA2C,CAAC"}
@@ -43,25 +43,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
43
  updatedEvent?: EntityUpdatedEvent;
44
44
  deletedEvent?: EntityDeletedEvent;
45
45
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
46
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
47
  id?: string;
51
48
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
49
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
50
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
51
  */
55
52
  entityFqdn?: string;
56
53
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
54
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
55
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
56
  */
61
57
  slug?: string;
62
58
  /** ID of the entity associated with the event. */
63
59
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
60
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
61
  eventTime?: Date | null;
66
62
  /**
67
63
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +67,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
67
  /** If present, indicates the action that triggered the event. */
72
68
  originatedFrom?: string | null;
73
69
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
70
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
71
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
72
  */
81
73
  entityEventSequence?: string | null;
82
74
  }
@@ -104,7 +96,7 @@ export interface EntityUpdatedEvent {
104
96
  currentEntityAsJson?: string;
105
97
  }
106
98
  export interface EntityDeletedEvent {
107
- /** Entity that was deleted */
99
+ /** Entity that was deleted. */
108
100
  deletedEntityAsJson?: string | null;
109
101
  }
110
102
  export interface ActionEvent {
@@ -148,7 +140,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
148
140
  */
149
141
  appId?: string;
150
142
  /** @readonly */
151
- identityType?: WebhookIdentityType;
143
+ identityType?: WebhookIdentityTypeWithLiterals;
152
144
  }
153
145
  /** @oneof */
154
146
  export interface IdentificationDataIdOneOf {
@@ -180,3 +172,5 @@ export declare enum WebhookIdentityType {
180
172
  WIX_USER = "WIX_USER",
181
173
  APP = "APP"
182
174
  }
175
+ /** @enumType */
176
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":"AA6LA,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.types.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.types.ts"],"names":[],"mappings":"AAqLA,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
@@ -1,3 +1,4 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
1
2
  /**
2
3
  * A CMP Config is a collection of settings and parameters defined within a consent management platform.
3
4
  *
@@ -43,25 +44,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
43
44
  updatedEvent?: EntityUpdatedEvent;
44
45
  deletedEvent?: EntityDeletedEvent;
45
46
  actionEvent?: ActionEvent;
46
- /**
47
- * Unique event ID.
48
- * Allows clients to ignore duplicate webhooks.
49
- */
47
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
50
48
  _id?: string;
51
49
  /**
52
- * Assumes actions are also always typed to an entity_type
53
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
50
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
51
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
54
52
  */
55
53
  entityFqdn?: string;
56
54
  /**
57
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
58
- * This is although the created/updated/deleted notion is duplication of the oneof types
59
- * Example: created/updated/deleted/started/completed/email_opened
55
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
56
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
60
57
  */
61
58
  slug?: string;
62
59
  /** ID of the entity associated with the event. */
63
60
  entityId?: string;
64
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
61
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
65
62
  eventTime?: Date | null;
66
63
  /**
67
64
  * Whether the event was triggered as a result of a privacy regulation application
@@ -71,12 +68,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
71
68
  /** If present, indicates the action that triggered the event. */
72
69
  originatedFrom?: string | null;
73
70
  /**
74
- * A sequence number defining the order of updates to the underlying entity.
75
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
76
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
77
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
78
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
79
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
71
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
72
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
80
73
  */
81
74
  entityEventSequence?: string | null;
82
75
  }
@@ -102,7 +95,7 @@ export interface EntityUpdatedEvent {
102
95
  currentEntity?: string;
103
96
  }
104
97
  export interface EntityDeletedEvent {
105
- /** Entity that was deleted */
98
+ /** Entity that was deleted. */
106
99
  deletedEntity?: string | null;
107
100
  }
108
101
  export interface ActionEvent {
@@ -146,7 +139,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
146
139
  */
147
140
  appId?: string;
148
141
  /** @readonly */
149
- identityType?: WebhookIdentityType;
142
+ identityType?: WebhookIdentityTypeWithLiterals;
150
143
  }
151
144
  /** @oneof */
152
145
  export interface IdentificationDataIdOneOf {
@@ -178,6 +171,8 @@ export declare enum WebhookIdentityType {
178
171
  WIX_USER = "WIX_USER",
179
172
  APP = "APP"
180
173
  }
174
+ /** @enumType */
175
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
181
176
  /**
182
177
  * Retrieves a CMP config.
183
178
  * @public
@@ -206,4 +201,4 @@ export declare function getCmpConfig(): Promise<CmpConfig>;
206
201
  * @returns Updated CMP config.
207
202
  * @fqn wix.bu.legal.v2.CmpConfigService.UpdateCmpConfig
208
203
  */
209
- export declare function updateCmpConfig(cmpConfig: CmpConfig): Promise<CmpConfig>;
204
+ export declare function updateCmpConfig(cmpConfig: NonNullablePaths<CmpConfig, `revision`>): Promise<CmpConfig>;
@@ -1 +1 @@
1
- {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,+BAA+B,MAAM,sCAAsC,CAAC;AA6LxF,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,SAAoB;IAEpB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"bu-legal-v2-cmp-config-cmp.universal.js","sourceRoot":"","sources":["../../../../src/bu-legal-v2-cmp-config-cmp.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,+BAA+B,MAAM,sCAAsC,CAAC;AAqLxF,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAWD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,+BAA+B,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,SAAkD;IAElD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,+BAA+B,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAU,CAAC;IAC1E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_consent-policy_cmp",
3
- "version": "1.0.2",
3
+ "version": "1.0.4",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -28,8 +28,8 @@
28
28
  "service-plugins"
29
29
  ],
30
30
  "dependencies": {
31
- "@wix/sdk-runtime": "^0.3.42",
32
- "@wix/sdk-types": "^1.13.9"
31
+ "@wix/sdk-runtime": "^0.3.49",
32
+ "@wix/sdk-types": "^1.13.23"
33
33
  },
34
34
  "devDependencies": {
35
35
  "typescript": "^5.3.2"
@@ -48,5 +48,5 @@
48
48
  "fqdn": "wix.bu.legal.v2.cmp_config"
49
49
  }
50
50
  },
51
- "falconPackageHash": "b333640c406aa861bdc9ecbafb0c6f0739d66b59369a5e6105801603"
51
+ "falconPackageHash": "e877221132e832077581abbd48dff59f21e0bf5dbe7d2078823bca87"
52
52
  }