@wix/auto_sdk_email-marketing_sender-details 1.0.8 → 1.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{es/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.mts} +76 -28
- package/build/{cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.ts} +76 -28
- package/build/index.d.mts +58 -0
- package/build/index.d.ts +58 -0
- package/build/index.js +441 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +412 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.mts} +76 -28
- package/build/internal/{es/src/email-marketing-v1-sender-details-sender-details.types.d.ts → email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.ts} +76 -28
- package/build/internal/index.d.mts +58 -0
- package/build/internal/index.d.ts +58 -0
- package/build/internal/index.js +441 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +412 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +77 -0
- package/build/internal/meta.d.ts +77 -0
- package/build/internal/meta.js +341 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +311 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +77 -0
- package/build/meta.d.ts +77 -0
- package/build/meta.js +341 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +311 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +0 -18
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +0 -260
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -104
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +0 -45
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +0 -12
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -218
- package/build/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
- package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js +0 -14
- package/build/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
- package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js +0 -253
- package/build/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
- package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -74
- package/build/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
- package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js +0 -37
- package/build/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js +0 -9
- package/build/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -188
- package/build/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js +0 -18
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js +0 -260
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -104
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js +0 -45
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js +0 -12
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -218
- package/build/internal/cjs/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.d.ts +0 -14
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js +0 -14
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.context.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.d.ts +0 -30
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js +0 -253
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.http.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.d.ts +0 -16
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js +0 -74
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.meta.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.d.ts +0 -49
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js +0 -37
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.public.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js +0 -9
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.types.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.d.ts +0 -355
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js +0 -188
- package/build/internal/es/src/email-marketing-v1-sender-details-sender-details.universal.js.map +0 -1
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
* If sending with an email from a custom domain that is not managed by Wix, a line will be inserted that states that the
|
|
9
9
|
* email was sent via wixemails.com.
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
interface SenderDetails {
|
|
12
12
|
/** Display name of sender. */
|
|
13
13
|
fromName?: string;
|
|
14
14
|
/**
|
|
@@ -22,47 +22,47 @@ export interface SenderDetails {
|
|
|
22
22
|
*/
|
|
23
23
|
dateVerified?: Date | null;
|
|
24
24
|
}
|
|
25
|
-
|
|
25
|
+
interface GetSenderDetailsRequest {
|
|
26
26
|
}
|
|
27
|
-
|
|
27
|
+
interface GetSenderDetailsResponse {
|
|
28
28
|
/** Current sender details. */
|
|
29
29
|
senderDetails?: SenderDetails;
|
|
30
30
|
}
|
|
31
|
-
|
|
31
|
+
interface UpdateSenderDetailsRequest {
|
|
32
32
|
/** New sender details. */
|
|
33
33
|
senderDetails: SenderDetails;
|
|
34
34
|
}
|
|
35
|
-
|
|
35
|
+
interface UpdateSenderDetailsResponse {
|
|
36
36
|
/** Whether email address needs verification. */
|
|
37
37
|
verificationNeeded?: boolean;
|
|
38
38
|
}
|
|
39
|
-
|
|
39
|
+
interface VerifySenderEmailRequest {
|
|
40
40
|
/** Verification code. */
|
|
41
41
|
verificationCode: string;
|
|
42
42
|
}
|
|
43
|
-
|
|
43
|
+
interface VerifySenderEmailResponse {
|
|
44
44
|
}
|
|
45
|
-
|
|
45
|
+
interface ResolveActualFromAddressRequest {
|
|
46
46
|
/**
|
|
47
47
|
* User's provided address from which to send email marketing campaign.
|
|
48
48
|
* @format EMAIL
|
|
49
49
|
*/
|
|
50
50
|
fromAddress: string;
|
|
51
51
|
}
|
|
52
|
-
|
|
52
|
+
interface ResolveActualFromAddressResponse {
|
|
53
53
|
/**
|
|
54
54
|
* Actual from-address that will be used for email distribution.
|
|
55
55
|
* @format EMAIL
|
|
56
56
|
*/
|
|
57
57
|
actualFromAddress?: string;
|
|
58
58
|
}
|
|
59
|
-
|
|
59
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
60
60
|
createdEvent?: EntityCreatedEvent;
|
|
61
61
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
62
|
deletedEvent?: EntityDeletedEvent;
|
|
63
63
|
actionEvent?: ActionEvent;
|
|
64
64
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
65
|
-
|
|
65
|
+
_id?: string;
|
|
66
66
|
/**
|
|
67
67
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
68
68
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -91,36 +91,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
91
91
|
entityEventSequence?: string | null;
|
|
92
92
|
}
|
|
93
93
|
/** @oneof */
|
|
94
|
-
|
|
94
|
+
interface DomainEventBodyOneOf {
|
|
95
95
|
createdEvent?: EntityCreatedEvent;
|
|
96
96
|
updatedEvent?: EntityUpdatedEvent;
|
|
97
97
|
deletedEvent?: EntityDeletedEvent;
|
|
98
98
|
actionEvent?: ActionEvent;
|
|
99
99
|
}
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
103
|
-
restoreInfo?: RestoreInfo;
|
|
100
|
+
interface EntityCreatedEvent {
|
|
101
|
+
entity?: string;
|
|
104
102
|
}
|
|
105
|
-
|
|
103
|
+
interface RestoreInfo {
|
|
106
104
|
deletedDate?: Date | null;
|
|
107
105
|
}
|
|
108
|
-
|
|
106
|
+
interface EntityUpdatedEvent {
|
|
109
107
|
/**
|
|
110
108
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
111
109
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
112
110
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
113
111
|
*/
|
|
114
|
-
|
|
112
|
+
currentEntity?: string;
|
|
115
113
|
}
|
|
116
|
-
|
|
114
|
+
interface EntityDeletedEvent {
|
|
117
115
|
/** Entity that was deleted. */
|
|
118
|
-
|
|
116
|
+
deletedEntity?: string | null;
|
|
119
117
|
}
|
|
120
|
-
|
|
121
|
-
|
|
118
|
+
interface ActionEvent {
|
|
119
|
+
body?: string;
|
|
122
120
|
}
|
|
123
|
-
|
|
121
|
+
interface MessageEnvelope {
|
|
124
122
|
/**
|
|
125
123
|
* App instance ID.
|
|
126
124
|
* @format GUID
|
|
@@ -136,7 +134,7 @@ export interface MessageEnvelope {
|
|
|
136
134
|
/** Stringify payload. */
|
|
137
135
|
data?: string;
|
|
138
136
|
}
|
|
139
|
-
|
|
137
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
140
138
|
/**
|
|
141
139
|
* ID of a site visitor that has not logged in to the site.
|
|
142
140
|
* @format GUID
|
|
@@ -161,7 +159,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
161
159
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
162
160
|
}
|
|
163
161
|
/** @oneof */
|
|
164
|
-
|
|
162
|
+
interface IdentificationDataIdOneOf {
|
|
165
163
|
/**
|
|
166
164
|
* ID of a site visitor that has not logged in to the site.
|
|
167
165
|
* @format GUID
|
|
@@ -183,7 +181,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
183
181
|
*/
|
|
184
182
|
appId?: string;
|
|
185
183
|
}
|
|
186
|
-
|
|
184
|
+
declare enum WebhookIdentityType {
|
|
187
185
|
UNKNOWN = "UNKNOWN",
|
|
188
186
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
189
187
|
MEMBER = "MEMBER",
|
|
@@ -191,4 +189,54 @@ export declare enum WebhookIdentityType {
|
|
|
191
189
|
APP = "APP"
|
|
192
190
|
}
|
|
193
191
|
/** @enumType */
|
|
194
|
-
|
|
192
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
193
|
+
interface BaseEventMetadata {
|
|
194
|
+
/**
|
|
195
|
+
* App instance ID.
|
|
196
|
+
* @format GUID
|
|
197
|
+
*/
|
|
198
|
+
instanceId?: string | null;
|
|
199
|
+
/**
|
|
200
|
+
* Event type.
|
|
201
|
+
* @maxLength 150
|
|
202
|
+
*/
|
|
203
|
+
eventType?: string;
|
|
204
|
+
/** The identification type and identity data. */
|
|
205
|
+
identity?: IdentificationData;
|
|
206
|
+
}
|
|
207
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
208
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
209
|
+
_id?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
212
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
213
|
+
*/
|
|
214
|
+
entityFqdn?: string;
|
|
215
|
+
/**
|
|
216
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
217
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
218
|
+
*/
|
|
219
|
+
slug?: string;
|
|
220
|
+
/** ID of the entity associated with the event. */
|
|
221
|
+
entityId?: string;
|
|
222
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
223
|
+
eventTime?: Date | null;
|
|
224
|
+
/**
|
|
225
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
226
|
+
* (for example, GDPR).
|
|
227
|
+
*/
|
|
228
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
229
|
+
/** If present, indicates the action that triggered the event. */
|
|
230
|
+
originatedFrom?: string | null;
|
|
231
|
+
/**
|
|
232
|
+
* 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.
|
|
233
|
+
* 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.
|
|
234
|
+
*/
|
|
235
|
+
entityEventSequence?: string | null;
|
|
236
|
+
}
|
|
237
|
+
interface SenderDetailsUpdatedEnvelope {
|
|
238
|
+
entity: SenderDetails;
|
|
239
|
+
metadata: EventMetadata;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
export { type ActionEvent as A, type BaseEventMetadata as B, type DomainEvent as D, type EntityCreatedEvent as E, type GetSenderDetailsResponse as G, type IdentificationData as I, type MessageEnvelope as M, type ResolveActualFromAddressResponse as R, type SenderDetails as S, type UpdateSenderDetailsResponse as U, type VerifySenderEmailRequest as V, WebhookIdentityType as W, type SenderDetailsUpdatedEnvelope as a, type GetSenderDetailsRequest as b, type UpdateSenderDetailsRequest as c, type VerifySenderEmailResponse as d, type ResolveActualFromAddressRequest as e, type DomainEventBodyOneOf as f, type RestoreInfo as g, type EntityUpdatedEvent as h, type EntityDeletedEvent as i, type IdentificationDataIdOneOf as j, type EventMetadata as k };
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
* If sending with an email from a custom domain that is not managed by Wix, a line will be inserted that states that the
|
|
9
9
|
* email was sent via wixemails.com.
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
interface SenderDetails {
|
|
12
12
|
/** Display name of sender. */
|
|
13
13
|
fromName?: string;
|
|
14
14
|
/**
|
|
@@ -22,47 +22,47 @@ export interface SenderDetails {
|
|
|
22
22
|
*/
|
|
23
23
|
dateVerified?: Date | null;
|
|
24
24
|
}
|
|
25
|
-
|
|
25
|
+
interface GetSenderDetailsRequest {
|
|
26
26
|
}
|
|
27
|
-
|
|
27
|
+
interface GetSenderDetailsResponse {
|
|
28
28
|
/** Current sender details. */
|
|
29
29
|
senderDetails?: SenderDetails;
|
|
30
30
|
}
|
|
31
|
-
|
|
31
|
+
interface UpdateSenderDetailsRequest {
|
|
32
32
|
/** New sender details. */
|
|
33
33
|
senderDetails: SenderDetails;
|
|
34
34
|
}
|
|
35
|
-
|
|
35
|
+
interface UpdateSenderDetailsResponse {
|
|
36
36
|
/** Whether email address needs verification. */
|
|
37
37
|
verificationNeeded?: boolean;
|
|
38
38
|
}
|
|
39
|
-
|
|
39
|
+
interface VerifySenderEmailRequest {
|
|
40
40
|
/** Verification code. */
|
|
41
41
|
verificationCode: string;
|
|
42
42
|
}
|
|
43
|
-
|
|
43
|
+
interface VerifySenderEmailResponse {
|
|
44
44
|
}
|
|
45
|
-
|
|
45
|
+
interface ResolveActualFromAddressRequest {
|
|
46
46
|
/**
|
|
47
47
|
* User's provided address from which to send email marketing campaign.
|
|
48
48
|
* @format EMAIL
|
|
49
49
|
*/
|
|
50
50
|
fromAddress: string;
|
|
51
51
|
}
|
|
52
|
-
|
|
52
|
+
interface ResolveActualFromAddressResponse {
|
|
53
53
|
/**
|
|
54
54
|
* Actual from-address that will be used for email distribution.
|
|
55
55
|
* @format EMAIL
|
|
56
56
|
*/
|
|
57
57
|
actualFromAddress?: string;
|
|
58
58
|
}
|
|
59
|
-
|
|
59
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
60
60
|
createdEvent?: EntityCreatedEvent;
|
|
61
61
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
62
|
deletedEvent?: EntityDeletedEvent;
|
|
63
63
|
actionEvent?: ActionEvent;
|
|
64
64
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
65
|
-
|
|
65
|
+
_id?: string;
|
|
66
66
|
/**
|
|
67
67
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
68
68
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -91,36 +91,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
91
91
|
entityEventSequence?: string | null;
|
|
92
92
|
}
|
|
93
93
|
/** @oneof */
|
|
94
|
-
|
|
94
|
+
interface DomainEventBodyOneOf {
|
|
95
95
|
createdEvent?: EntityCreatedEvent;
|
|
96
96
|
updatedEvent?: EntityUpdatedEvent;
|
|
97
97
|
deletedEvent?: EntityDeletedEvent;
|
|
98
98
|
actionEvent?: ActionEvent;
|
|
99
99
|
}
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
103
|
-
restoreInfo?: RestoreInfo;
|
|
100
|
+
interface EntityCreatedEvent {
|
|
101
|
+
entity?: string;
|
|
104
102
|
}
|
|
105
|
-
|
|
103
|
+
interface RestoreInfo {
|
|
106
104
|
deletedDate?: Date | null;
|
|
107
105
|
}
|
|
108
|
-
|
|
106
|
+
interface EntityUpdatedEvent {
|
|
109
107
|
/**
|
|
110
108
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
111
109
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
112
110
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
113
111
|
*/
|
|
114
|
-
|
|
112
|
+
currentEntity?: string;
|
|
115
113
|
}
|
|
116
|
-
|
|
114
|
+
interface EntityDeletedEvent {
|
|
117
115
|
/** Entity that was deleted. */
|
|
118
|
-
|
|
116
|
+
deletedEntity?: string | null;
|
|
119
117
|
}
|
|
120
|
-
|
|
121
|
-
|
|
118
|
+
interface ActionEvent {
|
|
119
|
+
body?: string;
|
|
122
120
|
}
|
|
123
|
-
|
|
121
|
+
interface MessageEnvelope {
|
|
124
122
|
/**
|
|
125
123
|
* App instance ID.
|
|
126
124
|
* @format GUID
|
|
@@ -136,7 +134,7 @@ export interface MessageEnvelope {
|
|
|
136
134
|
/** Stringify payload. */
|
|
137
135
|
data?: string;
|
|
138
136
|
}
|
|
139
|
-
|
|
137
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
140
138
|
/**
|
|
141
139
|
* ID of a site visitor that has not logged in to the site.
|
|
142
140
|
* @format GUID
|
|
@@ -161,7 +159,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
161
159
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
162
160
|
}
|
|
163
161
|
/** @oneof */
|
|
164
|
-
|
|
162
|
+
interface IdentificationDataIdOneOf {
|
|
165
163
|
/**
|
|
166
164
|
* ID of a site visitor that has not logged in to the site.
|
|
167
165
|
* @format GUID
|
|
@@ -183,7 +181,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
183
181
|
*/
|
|
184
182
|
appId?: string;
|
|
185
183
|
}
|
|
186
|
-
|
|
184
|
+
declare enum WebhookIdentityType {
|
|
187
185
|
UNKNOWN = "UNKNOWN",
|
|
188
186
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
189
187
|
MEMBER = "MEMBER",
|
|
@@ -191,4 +189,54 @@ export declare enum WebhookIdentityType {
|
|
|
191
189
|
APP = "APP"
|
|
192
190
|
}
|
|
193
191
|
/** @enumType */
|
|
194
|
-
|
|
192
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
193
|
+
interface BaseEventMetadata {
|
|
194
|
+
/**
|
|
195
|
+
* App instance ID.
|
|
196
|
+
* @format GUID
|
|
197
|
+
*/
|
|
198
|
+
instanceId?: string | null;
|
|
199
|
+
/**
|
|
200
|
+
* Event type.
|
|
201
|
+
* @maxLength 150
|
|
202
|
+
*/
|
|
203
|
+
eventType?: string;
|
|
204
|
+
/** The identification type and identity data. */
|
|
205
|
+
identity?: IdentificationData;
|
|
206
|
+
}
|
|
207
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
208
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
209
|
+
_id?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
212
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
213
|
+
*/
|
|
214
|
+
entityFqdn?: string;
|
|
215
|
+
/**
|
|
216
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
217
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
218
|
+
*/
|
|
219
|
+
slug?: string;
|
|
220
|
+
/** ID of the entity associated with the event. */
|
|
221
|
+
entityId?: string;
|
|
222
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
223
|
+
eventTime?: Date | null;
|
|
224
|
+
/**
|
|
225
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
226
|
+
* (for example, GDPR).
|
|
227
|
+
*/
|
|
228
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
229
|
+
/** If present, indicates the action that triggered the event. */
|
|
230
|
+
originatedFrom?: string | null;
|
|
231
|
+
/**
|
|
232
|
+
* 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.
|
|
233
|
+
* 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.
|
|
234
|
+
*/
|
|
235
|
+
entityEventSequence?: string | null;
|
|
236
|
+
}
|
|
237
|
+
interface SenderDetailsUpdatedEnvelope {
|
|
238
|
+
entity: SenderDetails;
|
|
239
|
+
metadata: EventMetadata;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
export { type ActionEvent as A, type BaseEventMetadata as B, type DomainEvent as D, type EntityCreatedEvent as E, type GetSenderDetailsResponse as G, type IdentificationData as I, type MessageEnvelope as M, type ResolveActualFromAddressResponse as R, type SenderDetails as S, type UpdateSenderDetailsResponse as U, type VerifySenderEmailRequest as V, WebhookIdentityType as W, type SenderDetailsUpdatedEnvelope as a, type GetSenderDetailsRequest as b, type UpdateSenderDetailsRequest as c, type VerifySenderEmailResponse as d, type ResolveActualFromAddressRequest as e, type DomainEventBodyOneOf as f, type RestoreInfo as g, type EntityUpdatedEvent as h, type EntityDeletedEvent as i, type IdentificationDataIdOneOf as j, type EventMetadata as k };
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
+
import { G as GetSenderDetailsResponse, S as SenderDetails, U as UpdateSenderDetailsResponse, R as ResolveActualFromAddressResponse, a as SenderDetailsUpdatedEnvelope } from './email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.mjs';
|
|
3
|
+
export { A as ActionEvent, B as BaseEventMetadata, D as DomainEvent, f as DomainEventBodyOneOf, E as EntityCreatedEvent, i as EntityDeletedEvent, h as EntityUpdatedEvent, k as EventMetadata, b as GetSenderDetailsRequest, I as IdentificationData, j as IdentificationDataIdOneOf, M as MessageEnvelope, e as ResolveActualFromAddressRequest, g as RestoreInfo, c as UpdateSenderDetailsRequest, V as VerifySenderEmailRequest, d as VerifySenderEmailResponse, W as WebhookIdentityType } from './email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.mjs';
|
|
4
|
+
|
|
5
|
+
declare function getSenderDetails$1(httpClient: HttpClient): GetSenderDetailsSignature;
|
|
6
|
+
interface GetSenderDetailsSignature {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves sender details.
|
|
9
|
+
*
|
|
10
|
+
* The sender details include the information displayed as the email sender's name and email address.
|
|
11
|
+
*
|
|
12
|
+
* + If you send an email campaign with a public email domain (e.g.
|
|
13
|
+
* @deprecated
|
|
14
|
+
*/
|
|
15
|
+
(): Promise<GetSenderDetailsResponse>;
|
|
16
|
+
}
|
|
17
|
+
declare function updateSenderDetails$1(httpClient: HttpClient): UpdateSenderDetailsSignature;
|
|
18
|
+
interface UpdateSenderDetailsSignature {
|
|
19
|
+
/**
|
|
20
|
+
* Updates sender details (only provided fields will be updated).
|
|
21
|
+
*
|
|
22
|
+
* If `from_email` is changed - a verification code will be sent to new email address.
|
|
23
|
+
* If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.
|
|
24
|
+
* @param - New sender details.
|
|
25
|
+
* @deprecated
|
|
26
|
+
*/
|
|
27
|
+
(senderDetails: SenderDetails): Promise<UpdateSenderDetailsResponse>;
|
|
28
|
+
}
|
|
29
|
+
declare function verifyEmail$1(httpClient: HttpClient): VerifyEmailSignature;
|
|
30
|
+
interface VerifyEmailSignature {
|
|
31
|
+
/**
|
|
32
|
+
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
33
|
+
* @param - Verification code.
|
|
34
|
+
* @deprecated
|
|
35
|
+
*/
|
|
36
|
+
(verificationCode: string): Promise<void>;
|
|
37
|
+
}
|
|
38
|
+
declare function resolveActualFromAddress$1(httpClient: HttpClient): ResolveActualFromAddressSignature;
|
|
39
|
+
interface ResolveActualFromAddressSignature {
|
|
40
|
+
/**
|
|
41
|
+
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
42
|
+
* @param - User's provided address from which to send email marketing campaign.
|
|
43
|
+
* @deprecated
|
|
44
|
+
*/
|
|
45
|
+
(fromAddress: string): Promise<ResolveActualFromAddressResponse>;
|
|
46
|
+
}
|
|
47
|
+
declare const onSenderDetailsUpdated$1: EventDefinition<SenderDetailsUpdatedEnvelope, "wix.email_marketing.v1.sender_details_updated">;
|
|
48
|
+
|
|
49
|
+
declare const getSenderDetails: MaybeContext<BuildRESTFunction<typeof getSenderDetails$1> & typeof getSenderDetails$1>;
|
|
50
|
+
declare const updateSenderDetails: MaybeContext<BuildRESTFunction<typeof updateSenderDetails$1> & typeof updateSenderDetails$1>;
|
|
51
|
+
declare const verifyEmail: MaybeContext<BuildRESTFunction<typeof verifyEmail$1> & typeof verifyEmail$1>;
|
|
52
|
+
declare const resolveActualFromAddress: MaybeContext<BuildRESTFunction<typeof resolveActualFromAddress$1> & typeof resolveActualFromAddress$1>;
|
|
53
|
+
/**
|
|
54
|
+
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
55
|
+
*/
|
|
56
|
+
declare const onSenderDetailsUpdated: BuildEventDefinition<typeof onSenderDetailsUpdated$1>;
|
|
57
|
+
|
|
58
|
+
export { GetSenderDetailsResponse, ResolveActualFromAddressResponse, SenderDetails, SenderDetailsUpdatedEnvelope, UpdateSenderDetailsResponse, getSenderDetails, onSenderDetailsUpdated, resolveActualFromAddress, updateSenderDetails, verifyEmail };
|
package/build/index.d.ts
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
+
import { G as GetSenderDetailsResponse, S as SenderDetails, U as UpdateSenderDetailsResponse, R as ResolveActualFromAddressResponse, a as SenderDetailsUpdatedEnvelope } from './email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.js';
|
|
3
|
+
export { A as ActionEvent, B as BaseEventMetadata, D as DomainEvent, f as DomainEventBodyOneOf, E as EntityCreatedEvent, i as EntityDeletedEvent, h as EntityUpdatedEvent, k as EventMetadata, b as GetSenderDetailsRequest, I as IdentificationData, j as IdentificationDataIdOneOf, M as MessageEnvelope, e as ResolveActualFromAddressRequest, g as RestoreInfo, c as UpdateSenderDetailsRequest, V as VerifySenderEmailRequest, d as VerifySenderEmailResponse, W as WebhookIdentityType } from './email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.js';
|
|
4
|
+
|
|
5
|
+
declare function getSenderDetails$1(httpClient: HttpClient): GetSenderDetailsSignature;
|
|
6
|
+
interface GetSenderDetailsSignature {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves sender details.
|
|
9
|
+
*
|
|
10
|
+
* The sender details include the information displayed as the email sender's name and email address.
|
|
11
|
+
*
|
|
12
|
+
* + If you send an email campaign with a public email domain (e.g.
|
|
13
|
+
* @deprecated
|
|
14
|
+
*/
|
|
15
|
+
(): Promise<GetSenderDetailsResponse>;
|
|
16
|
+
}
|
|
17
|
+
declare function updateSenderDetails$1(httpClient: HttpClient): UpdateSenderDetailsSignature;
|
|
18
|
+
interface UpdateSenderDetailsSignature {
|
|
19
|
+
/**
|
|
20
|
+
* Updates sender details (only provided fields will be updated).
|
|
21
|
+
*
|
|
22
|
+
* If `from_email` is changed - a verification code will be sent to new email address.
|
|
23
|
+
* If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.
|
|
24
|
+
* @param - New sender details.
|
|
25
|
+
* @deprecated
|
|
26
|
+
*/
|
|
27
|
+
(senderDetails: SenderDetails): Promise<UpdateSenderDetailsResponse>;
|
|
28
|
+
}
|
|
29
|
+
declare function verifyEmail$1(httpClient: HttpClient): VerifyEmailSignature;
|
|
30
|
+
interface VerifyEmailSignature {
|
|
31
|
+
/**
|
|
32
|
+
* Verifies the sender's email using a verification code sent to the user's email address upon update.
|
|
33
|
+
* @param - Verification code.
|
|
34
|
+
* @deprecated
|
|
35
|
+
*/
|
|
36
|
+
(verificationCode: string): Promise<void>;
|
|
37
|
+
}
|
|
38
|
+
declare function resolveActualFromAddress$1(httpClient: HttpClient): ResolveActualFromAddressSignature;
|
|
39
|
+
interface ResolveActualFromAddressSignature {
|
|
40
|
+
/**
|
|
41
|
+
* Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
|
|
42
|
+
* @param - User's provided address from which to send email marketing campaign.
|
|
43
|
+
* @deprecated
|
|
44
|
+
*/
|
|
45
|
+
(fromAddress: string): Promise<ResolveActualFromAddressResponse>;
|
|
46
|
+
}
|
|
47
|
+
declare const onSenderDetailsUpdated$1: EventDefinition<SenderDetailsUpdatedEnvelope, "wix.email_marketing.v1.sender_details_updated">;
|
|
48
|
+
|
|
49
|
+
declare const getSenderDetails: MaybeContext<BuildRESTFunction<typeof getSenderDetails$1> & typeof getSenderDetails$1>;
|
|
50
|
+
declare const updateSenderDetails: MaybeContext<BuildRESTFunction<typeof updateSenderDetails$1> & typeof updateSenderDetails$1>;
|
|
51
|
+
declare const verifyEmail: MaybeContext<BuildRESTFunction<typeof verifyEmail$1> & typeof verifyEmail$1>;
|
|
52
|
+
declare const resolveActualFromAddress: MaybeContext<BuildRESTFunction<typeof resolveActualFromAddress$1> & typeof resolveActualFromAddress$1>;
|
|
53
|
+
/**
|
|
54
|
+
* An event that triggers when sender details are updated without the need for explicit verification.
|
|
55
|
+
*/
|
|
56
|
+
declare const onSenderDetailsUpdated: BuildEventDefinition<typeof onSenderDetailsUpdated$1>;
|
|
57
|
+
|
|
58
|
+
export { GetSenderDetailsResponse, ResolveActualFromAddressResponse, SenderDetails, SenderDetailsUpdatedEnvelope, UpdateSenderDetailsResponse, getSenderDetails, onSenderDetailsUpdated, resolveActualFromAddress, updateSenderDetails, verifyEmail };
|