ssjs-data 0.3.0 → 0.3.2
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/dist/sfmc-globals.d.ts +485 -1
- package/package.json +1 -1
package/dist/sfmc-globals.d.ts
CHANGED
|
@@ -53,9 +53,14 @@ declare namespace Platform {
|
|
|
53
53
|
function Base64Encode(string: string, charset?: string): string;
|
|
54
54
|
function Base64Decode(encodedString: string, charset?: string): string;
|
|
55
55
|
function MD5(string: string, charset?: string): string;
|
|
56
|
-
function Write(content: string): void;
|
|
57
56
|
function Stringify(object: object): string;
|
|
57
|
+
/**
|
|
58
|
+
* @deprecated
|
|
59
|
+
*/
|
|
58
60
|
function ContentArea(id: number, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
|
|
61
|
+
/**
|
|
62
|
+
* @deprecated
|
|
63
|
+
*/
|
|
59
64
|
function ContentAreaByName(name: string, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
|
|
60
65
|
function IsCHTMLBrowser(userAgentString: string): boolean;
|
|
61
66
|
}
|
|
@@ -96,31 +101,94 @@ declare namespace Platform {
|
|
|
96
101
|
}
|
|
97
102
|
|
|
98
103
|
// ── Bare-name globals (aliasOf Platform.*) ──────────────────────────────────
|
|
104
|
+
/**
|
|
105
|
+
* @deprecated
|
|
106
|
+
*/
|
|
99
107
|
declare function ContentArea(id: number, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
|
|
108
|
+
/**
|
|
109
|
+
* @deprecated
|
|
110
|
+
*/
|
|
100
111
|
declare function ContentAreaByName(name: string, regionName?: string, stopOnError?: boolean, fallbackContent?: string): string;
|
|
112
|
+
/**
|
|
113
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
114
|
+
*/
|
|
101
115
|
declare function BeginImpressionRegion(name: string): void;
|
|
116
|
+
/**
|
|
117
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
118
|
+
*/
|
|
102
119
|
declare function EndImpressionRegion(closeAll?: boolean): void;
|
|
120
|
+
/**
|
|
121
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
122
|
+
*/
|
|
103
123
|
declare function Now(useContextTime?: boolean): string;
|
|
124
|
+
/**
|
|
125
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
126
|
+
*/
|
|
104
127
|
declare function SystemDateToLocalDate(dateValue: string): string;
|
|
128
|
+
/**
|
|
129
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
130
|
+
*/
|
|
105
131
|
declare function LocalDateToSystemDate(dateValue: string): string;
|
|
132
|
+
/**
|
|
133
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
134
|
+
*/
|
|
106
135
|
declare function Redirect(url: string, movedPermanently: boolean): void;
|
|
136
|
+
/**
|
|
137
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
138
|
+
*/
|
|
107
139
|
declare function GUID(): string;
|
|
140
|
+
/**
|
|
141
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
142
|
+
*/
|
|
108
143
|
declare function IsEmailAddress(value: string): boolean;
|
|
144
|
+
/**
|
|
145
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
146
|
+
*/
|
|
109
147
|
declare function IsPhoneNumber(value: string): boolean;
|
|
148
|
+
/**
|
|
149
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
150
|
+
*/
|
|
110
151
|
declare function Write(content: string): void;
|
|
152
|
+
/**
|
|
153
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
154
|
+
*/
|
|
111
155
|
declare function Stringify(object: object): string;
|
|
112
156
|
|
|
113
157
|
// ── DataExtension instance interfaces ───────────────────────────────────────
|
|
114
158
|
interface DataExtensionFieldsAccessor {
|
|
159
|
+
/**
|
|
160
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
161
|
+
*/
|
|
115
162
|
Add(properties: object): string;
|
|
163
|
+
/**
|
|
164
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
165
|
+
*/
|
|
116
166
|
Retrieve(): object[];
|
|
167
|
+
/**
|
|
168
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
169
|
+
*/
|
|
117
170
|
UpdateSendableField(deFieldName: string, subscriberField: string): string;
|
|
118
171
|
}
|
|
119
172
|
interface DataExtensionRowsAccessor {
|
|
173
|
+
/**
|
|
174
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
175
|
+
*/
|
|
120
176
|
Add(rowData: any[]): string;
|
|
177
|
+
/**
|
|
178
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
179
|
+
*/
|
|
121
180
|
Lookup(searchFieldNames: any[], searchValues: any[], limit?: number, orderByFieldName?: string): object[];
|
|
181
|
+
/**
|
|
182
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
183
|
+
*/
|
|
122
184
|
Remove(columnNames: any[], columnValues: any[]): number;
|
|
185
|
+
/**
|
|
186
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
187
|
+
*/
|
|
123
188
|
Retrieve(filter?: object): object[];
|
|
189
|
+
/**
|
|
190
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
191
|
+
*/
|
|
124
192
|
Update(rowData: object, whereFieldNames: any[], whereValues: any[]): string;
|
|
125
193
|
}
|
|
126
194
|
interface DataExtensionInstance {
|
|
@@ -130,234 +198,650 @@ interface DataExtensionInstance {
|
|
|
130
198
|
|
|
131
199
|
// ── Core Library namespaces ──────────────────────────────────────────────────
|
|
132
200
|
declare namespace Account {
|
|
201
|
+
/**
|
|
202
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
203
|
+
*/
|
|
133
204
|
function Init(key: string): any;
|
|
205
|
+
/**
|
|
206
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
207
|
+
*/
|
|
134
208
|
function Retrieve(filter: object): object[];
|
|
209
|
+
/**
|
|
210
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
211
|
+
*/
|
|
135
212
|
function Update(properties: object): string;
|
|
136
213
|
}
|
|
137
214
|
declare namespace Account.Tracking {
|
|
215
|
+
/**
|
|
216
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
217
|
+
*/
|
|
138
218
|
function Retrieve(filter: object): object[];
|
|
139
219
|
}
|
|
140
220
|
declare namespace AccountUser {
|
|
221
|
+
/**
|
|
222
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
223
|
+
*/
|
|
141
224
|
function Init(targetUserKey: string, myClientID: number): any;
|
|
225
|
+
/**
|
|
226
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
227
|
+
*/
|
|
142
228
|
function Add(properties: object): string;
|
|
229
|
+
/**
|
|
230
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
231
|
+
*/
|
|
143
232
|
function Retrieve(filter: object): object[];
|
|
233
|
+
/**
|
|
234
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
235
|
+
*/
|
|
144
236
|
function Update(properties: object): string;
|
|
237
|
+
/**
|
|
238
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
239
|
+
*/
|
|
145
240
|
function Activate(): string;
|
|
241
|
+
/**
|
|
242
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
243
|
+
*/
|
|
146
244
|
function Deactivate(): string;
|
|
147
245
|
}
|
|
148
246
|
declare namespace Portfolio {
|
|
247
|
+
/**
|
|
248
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
249
|
+
*/
|
|
149
250
|
function Init(key: string): any;
|
|
251
|
+
/**
|
|
252
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
253
|
+
*/
|
|
150
254
|
function Add(properties: object): string;
|
|
255
|
+
/**
|
|
256
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
257
|
+
*/
|
|
151
258
|
function Retrieve(filter: object): object[];
|
|
259
|
+
/**
|
|
260
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
261
|
+
*/
|
|
152
262
|
function Update(properties: object): string;
|
|
263
|
+
/**
|
|
264
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
265
|
+
*/
|
|
153
266
|
function Remove(): string;
|
|
154
267
|
}
|
|
155
268
|
declare namespace ContentAreaObj {
|
|
269
|
+
/**
|
|
270
|
+
* @deprecated
|
|
271
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
272
|
+
*/
|
|
156
273
|
function Init(key: string): any;
|
|
274
|
+
/**
|
|
275
|
+
* @deprecated
|
|
276
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
277
|
+
*/
|
|
157
278
|
function Add(properties: object): string;
|
|
279
|
+
/**
|
|
280
|
+
* @deprecated
|
|
281
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
282
|
+
*/
|
|
158
283
|
function Retrieve(filter: object): object[];
|
|
284
|
+
/**
|
|
285
|
+
* @deprecated
|
|
286
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
287
|
+
*/
|
|
159
288
|
function Update(properties: object): string;
|
|
289
|
+
/**
|
|
290
|
+
* @deprecated
|
|
291
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
292
|
+
*/
|
|
160
293
|
function Remove(): string;
|
|
161
294
|
}
|
|
162
295
|
declare namespace Folder {
|
|
296
|
+
/**
|
|
297
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
298
|
+
*/
|
|
163
299
|
function Init(key?: string): any;
|
|
300
|
+
/**
|
|
301
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
302
|
+
*/
|
|
164
303
|
function Add(properties: object): string;
|
|
304
|
+
/**
|
|
305
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
306
|
+
*/
|
|
165
307
|
function Retrieve(filter: object): object[];
|
|
308
|
+
/**
|
|
309
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
310
|
+
*/
|
|
166
311
|
function Update(properties: object): string;
|
|
312
|
+
/**
|
|
313
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
314
|
+
*/
|
|
167
315
|
function Remove(): string;
|
|
316
|
+
/**
|
|
317
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
318
|
+
*/
|
|
168
319
|
function SetID(id: number): void;
|
|
169
320
|
}
|
|
170
321
|
declare namespace Template {
|
|
322
|
+
/**
|
|
323
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
324
|
+
*/
|
|
171
325
|
function Init(key: string): any;
|
|
326
|
+
/**
|
|
327
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
328
|
+
*/
|
|
172
329
|
function Add(properties: object): string;
|
|
330
|
+
/**
|
|
331
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
332
|
+
*/
|
|
173
333
|
function Retrieve(filter: object): object[];
|
|
334
|
+
/**
|
|
335
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
336
|
+
*/
|
|
174
337
|
function Update(properties: object): string;
|
|
175
338
|
}
|
|
176
339
|
declare namespace DeliveryProfile {
|
|
340
|
+
/**
|
|
341
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
342
|
+
*/
|
|
177
343
|
function Init(key: string): any;
|
|
344
|
+
/**
|
|
345
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
346
|
+
*/
|
|
178
347
|
function Add(properties: object): string;
|
|
348
|
+
/**
|
|
349
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
350
|
+
*/
|
|
179
351
|
function Update(properties: object): string;
|
|
352
|
+
/**
|
|
353
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
354
|
+
*/
|
|
180
355
|
function Remove(): string;
|
|
181
356
|
}
|
|
182
357
|
declare namespace SenderProfile {
|
|
358
|
+
/**
|
|
359
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
360
|
+
*/
|
|
183
361
|
function Init(key: string): any;
|
|
362
|
+
/**
|
|
363
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
364
|
+
*/
|
|
184
365
|
function Add(properties: object): string;
|
|
366
|
+
/**
|
|
367
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
368
|
+
*/
|
|
185
369
|
function Update(properties: object): string;
|
|
370
|
+
/**
|
|
371
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
372
|
+
*/
|
|
186
373
|
function Remove(): string;
|
|
187
374
|
}
|
|
188
375
|
declare namespace SendClassification {
|
|
376
|
+
/**
|
|
377
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
378
|
+
*/
|
|
189
379
|
function Init(key: string): any;
|
|
380
|
+
/**
|
|
381
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
382
|
+
*/
|
|
190
383
|
function Add(properties: object): string;
|
|
384
|
+
/**
|
|
385
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
386
|
+
*/
|
|
191
387
|
function Retrieve(filter: object): object[];
|
|
388
|
+
/**
|
|
389
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
390
|
+
*/
|
|
192
391
|
function Update(properties: object): string;
|
|
392
|
+
/**
|
|
393
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
394
|
+
*/
|
|
193
395
|
function Remove(): string;
|
|
194
396
|
}
|
|
195
397
|
declare namespace FilterDefinition {
|
|
398
|
+
/**
|
|
399
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
400
|
+
*/
|
|
196
401
|
function Init(key: string): any;
|
|
402
|
+
/**
|
|
403
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
404
|
+
*/
|
|
197
405
|
function Add(properties: object): string;
|
|
406
|
+
/**
|
|
407
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
408
|
+
*/
|
|
198
409
|
function Retrieve(filter: object): object[];
|
|
410
|
+
/**
|
|
411
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
412
|
+
*/
|
|
199
413
|
function Update(properties: object): string;
|
|
414
|
+
/**
|
|
415
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
416
|
+
*/
|
|
200
417
|
function Remove(): string;
|
|
201
418
|
}
|
|
202
419
|
declare namespace QueryDefinition {
|
|
420
|
+
/**
|
|
421
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
422
|
+
*/
|
|
203
423
|
function Init(key: string): any;
|
|
424
|
+
/**
|
|
425
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
426
|
+
*/
|
|
204
427
|
function Add(properties: object): string;
|
|
428
|
+
/**
|
|
429
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
430
|
+
*/
|
|
205
431
|
function Retrieve(filter: object): object[];
|
|
432
|
+
/**
|
|
433
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
434
|
+
*/
|
|
206
435
|
function Update(properties: object): string;
|
|
436
|
+
/**
|
|
437
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
438
|
+
*/
|
|
207
439
|
function Remove(): string;
|
|
440
|
+
/**
|
|
441
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
442
|
+
*/
|
|
208
443
|
function Perform(action: string): string;
|
|
209
444
|
}
|
|
210
445
|
declare namespace List {
|
|
446
|
+
/**
|
|
447
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
448
|
+
*/
|
|
211
449
|
function Init(key: string): any;
|
|
450
|
+
/**
|
|
451
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
452
|
+
*/
|
|
212
453
|
function Add(properties: object): any;
|
|
454
|
+
/**
|
|
455
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
456
|
+
*/
|
|
213
457
|
function Retrieve(filter: object): object[];
|
|
458
|
+
/**
|
|
459
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
460
|
+
*/
|
|
214
461
|
function Remove(): string;
|
|
215
462
|
}
|
|
216
463
|
declare namespace List.Subscribers {
|
|
464
|
+
/**
|
|
465
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
466
|
+
*/
|
|
217
467
|
function Add(properties: object): string;
|
|
468
|
+
/**
|
|
469
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
470
|
+
*/
|
|
218
471
|
function Retrieve(filter?: object): object[];
|
|
472
|
+
/**
|
|
473
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
474
|
+
*/
|
|
219
475
|
function Unsubscribe(emailAddress: string): string;
|
|
476
|
+
/**
|
|
477
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
478
|
+
*/
|
|
220
479
|
function Update(emailAddress: string, status: string): string;
|
|
480
|
+
/**
|
|
481
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
482
|
+
*/
|
|
221
483
|
function Upsert(emailAddress: string, attributes: object): string;
|
|
222
484
|
}
|
|
223
485
|
declare namespace List.Subscribers.Tracking {
|
|
486
|
+
/**
|
|
487
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
488
|
+
*/
|
|
224
489
|
function Retrieve(filter: object): object[];
|
|
225
490
|
}
|
|
226
491
|
declare namespace Subscriber {
|
|
492
|
+
/**
|
|
493
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
494
|
+
*/
|
|
227
495
|
function Init(key: string): any;
|
|
496
|
+
/**
|
|
497
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
498
|
+
*/
|
|
228
499
|
function Add(properties: object): string;
|
|
500
|
+
/**
|
|
501
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
502
|
+
*/
|
|
229
503
|
function Retrieve(filter: object): object[];
|
|
504
|
+
/**
|
|
505
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
506
|
+
*/
|
|
230
507
|
function Upsert(properties: object): string;
|
|
508
|
+
/**
|
|
509
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
510
|
+
*/
|
|
231
511
|
function Statistics(subscriberKey: string): object;
|
|
512
|
+
/**
|
|
513
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
514
|
+
*/
|
|
232
515
|
function Update(properties: object): string;
|
|
516
|
+
/**
|
|
517
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
518
|
+
*/
|
|
233
519
|
function Remove(): string;
|
|
520
|
+
/**
|
|
521
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
522
|
+
*/
|
|
234
523
|
function Unsubscribe(): string;
|
|
235
524
|
}
|
|
236
525
|
declare namespace Subscriber.Attributes {
|
|
526
|
+
/**
|
|
527
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
528
|
+
*/
|
|
237
529
|
function Retrieve(): object[];
|
|
238
530
|
}
|
|
239
531
|
declare namespace Subscriber.Lists {
|
|
532
|
+
/**
|
|
533
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
534
|
+
*/
|
|
240
535
|
function Retrieve(): object[];
|
|
241
536
|
}
|
|
242
537
|
declare namespace Email {
|
|
538
|
+
/**
|
|
539
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
540
|
+
*/
|
|
243
541
|
function Init(key: string): any;
|
|
542
|
+
/**
|
|
543
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
544
|
+
*/
|
|
244
545
|
function Add(properties: object): any;
|
|
546
|
+
/**
|
|
547
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
548
|
+
*/
|
|
245
549
|
function Retrieve(filter: object): object[];
|
|
550
|
+
/**
|
|
551
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
552
|
+
*/
|
|
246
553
|
function Update(properties: object): string;
|
|
554
|
+
/**
|
|
555
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
556
|
+
*/
|
|
247
557
|
function Remove(): string;
|
|
558
|
+
/**
|
|
559
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
560
|
+
*/
|
|
248
561
|
function Validate(): object;
|
|
562
|
+
/**
|
|
563
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
564
|
+
*/
|
|
249
565
|
function CheckContent(): object;
|
|
250
566
|
}
|
|
251
567
|
declare namespace Send {
|
|
568
|
+
/**
|
|
569
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
570
|
+
*/
|
|
252
571
|
function Init(id: number): any;
|
|
572
|
+
/**
|
|
573
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
574
|
+
*/
|
|
253
575
|
function Add(emailKey: string, listIds: any[], options?: object): string;
|
|
576
|
+
/**
|
|
577
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
578
|
+
*/
|
|
254
579
|
function Retrieve(filter: object): object[];
|
|
580
|
+
/**
|
|
581
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
582
|
+
*/
|
|
255
583
|
function RetrieveLists(filter: object): object[];
|
|
584
|
+
/**
|
|
585
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
586
|
+
*/
|
|
256
587
|
function Remove(): string;
|
|
588
|
+
/**
|
|
589
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
590
|
+
*/
|
|
257
591
|
function CancelSend(): string;
|
|
258
592
|
}
|
|
259
593
|
declare namespace Send.Tracking {
|
|
594
|
+
/**
|
|
595
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
596
|
+
*/
|
|
260
597
|
function Retrieve(filter: object): object[];
|
|
598
|
+
/**
|
|
599
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
600
|
+
*/
|
|
261
601
|
function ClickRetrieve(filter: object): object[];
|
|
602
|
+
/**
|
|
603
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
604
|
+
*/
|
|
262
605
|
function TotalByIntervalRetrieve(type: string, startDate: string, endDate: string, groupBy: string): object[];
|
|
263
606
|
}
|
|
264
607
|
declare namespace Send.Definition {
|
|
608
|
+
/**
|
|
609
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
610
|
+
*/
|
|
265
611
|
function Init(key: string): any;
|
|
612
|
+
/**
|
|
613
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
614
|
+
*/
|
|
266
615
|
function Add(esdParams: object, sendClassificationKey: string, emailKey: string, listIds: any[]): string;
|
|
616
|
+
/**
|
|
617
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
618
|
+
*/
|
|
267
619
|
function AddWithDE(esdParams: object, sendClassificationKey: string, emailKey: string, sendableDataExtensionKey: string, publicationListKey: string): string;
|
|
620
|
+
/**
|
|
621
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
622
|
+
*/
|
|
268
623
|
function AddWithFilterDefinition(esdParams: object, sendClassificationKey: string, emailKey: string, filterDefinitionKey: string, listId: number): string;
|
|
624
|
+
/**
|
|
625
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
626
|
+
*/
|
|
269
627
|
function Retrieve(filter?: object): object[];
|
|
628
|
+
/**
|
|
629
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
630
|
+
*/
|
|
270
631
|
function Update(properties: object): string;
|
|
632
|
+
/**
|
|
633
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
634
|
+
*/
|
|
271
635
|
function Remove(): string;
|
|
636
|
+
/**
|
|
637
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
638
|
+
*/
|
|
272
639
|
function Send(): string;
|
|
273
640
|
}
|
|
274
641
|
declare namespace TriggeredSend {
|
|
642
|
+
/**
|
|
643
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
644
|
+
*/
|
|
275
645
|
function Init(key: string): any;
|
|
646
|
+
/**
|
|
647
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
648
|
+
*/
|
|
276
649
|
function Add(properties: object): any;
|
|
650
|
+
/**
|
|
651
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
652
|
+
*/
|
|
277
653
|
function Retrieve(filter: object): object[];
|
|
654
|
+
/**
|
|
655
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
656
|
+
*/
|
|
278
657
|
function Update(properties: object): string;
|
|
658
|
+
/**
|
|
659
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
660
|
+
*/
|
|
279
661
|
function Start(): string;
|
|
662
|
+
/**
|
|
663
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
664
|
+
*/
|
|
280
665
|
function Pause(): string;
|
|
666
|
+
/**
|
|
667
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
668
|
+
*/
|
|
281
669
|
function Publish(): string;
|
|
670
|
+
/**
|
|
671
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
672
|
+
*/
|
|
282
673
|
function Send(emailAddress: string, sendTimeAttributes?: object): string;
|
|
283
674
|
}
|
|
284
675
|
declare namespace TriggeredSend.Tracking {
|
|
676
|
+
/**
|
|
677
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
678
|
+
*/
|
|
285
679
|
function Retrieve(filter?: object): object[];
|
|
286
680
|
}
|
|
287
681
|
declare namespace TriggeredSend.Tracking.Clicks {
|
|
682
|
+
/**
|
|
683
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
684
|
+
*/
|
|
288
685
|
function Retrieve(filter: object): object[];
|
|
289
686
|
}
|
|
290
687
|
declare namespace TriggeredSend.Tracking.TotalByInterval {
|
|
688
|
+
/**
|
|
689
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
690
|
+
*/
|
|
291
691
|
function Retrieve(type: string, startDate: string, endDate: string, groupBy: string): object[];
|
|
292
692
|
}
|
|
293
693
|
declare namespace DataExtension {
|
|
694
|
+
/**
|
|
695
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
696
|
+
*/
|
|
294
697
|
function Init(key: string): DataExtensionInstance;
|
|
698
|
+
/**
|
|
699
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
700
|
+
*/
|
|
295
701
|
function Add(properties: object): DataExtensionInstance;
|
|
702
|
+
/**
|
|
703
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
704
|
+
*/
|
|
296
705
|
function Retrieve(filter: object, queryAllAccounts?: boolean): object[];
|
|
297
706
|
}
|
|
298
707
|
declare namespace DataExtension.Fields {
|
|
708
|
+
/**
|
|
709
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
710
|
+
*/
|
|
299
711
|
function Add(properties: object): string;
|
|
712
|
+
/**
|
|
713
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
714
|
+
*/
|
|
300
715
|
function Retrieve(): object[];
|
|
716
|
+
/**
|
|
717
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
718
|
+
*/
|
|
301
719
|
function UpdateSendableField(deFieldName: string, subscriberField: string): string;
|
|
302
720
|
}
|
|
303
721
|
declare namespace DataExtension.Rows {
|
|
722
|
+
/**
|
|
723
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
724
|
+
*/
|
|
304
725
|
function Add(rowData: any[]): string;
|
|
726
|
+
/**
|
|
727
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
728
|
+
*/
|
|
305
729
|
function Lookup(searchFieldNames: any[], searchValues: any[], limit?: number, orderByFieldName?: string): object[];
|
|
730
|
+
/**
|
|
731
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
732
|
+
*/
|
|
306
733
|
function Remove(columnNames: any[], columnValues: any[]): number;
|
|
734
|
+
/**
|
|
735
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
736
|
+
*/
|
|
307
737
|
function Retrieve(filter?: object): object[];
|
|
738
|
+
/**
|
|
739
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
740
|
+
*/
|
|
308
741
|
function Update(rowData: object, whereFieldNames: any[], whereValues: any[]): string;
|
|
309
742
|
}
|
|
310
743
|
declare namespace DateTime.TimeZone {
|
|
744
|
+
/**
|
|
745
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
746
|
+
*/
|
|
311
747
|
function Retrieve(filter: object): object[];
|
|
312
748
|
}
|
|
313
749
|
|
|
314
750
|
// ── Standalone Core Library globals ──────────────────────────────────────────
|
|
315
751
|
declare namespace Attribute {
|
|
752
|
+
/**
|
|
753
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
754
|
+
*/
|
|
316
755
|
function GetValue(name: string): string;
|
|
317
756
|
}
|
|
318
757
|
|
|
319
758
|
declare namespace ErrorUtil {
|
|
759
|
+
/**
|
|
760
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
761
|
+
*/
|
|
320
762
|
function ThrowWSProxyError(result: object): void;
|
|
321
763
|
}
|
|
322
764
|
|
|
323
765
|
// ── Event namespaces ─────────────────────────────────────────────────────────
|
|
324
766
|
declare namespace BounceEvent {
|
|
767
|
+
/**
|
|
768
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
769
|
+
*/
|
|
325
770
|
function Retrieve(filter: object): object[];
|
|
326
771
|
}
|
|
327
772
|
declare namespace ClickEvent {
|
|
773
|
+
/**
|
|
774
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
775
|
+
*/
|
|
328
776
|
function Retrieve(filter: object): object[];
|
|
329
777
|
}
|
|
330
778
|
declare namespace ForwardedEmailEvent {
|
|
779
|
+
/**
|
|
780
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
781
|
+
*/
|
|
331
782
|
function Retrieve(filter: object): object[];
|
|
332
783
|
}
|
|
333
784
|
declare namespace ForwardedEmailOptInEvent {
|
|
785
|
+
/**
|
|
786
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
787
|
+
*/
|
|
334
788
|
function Retrieve(filter: object): object[];
|
|
335
789
|
}
|
|
336
790
|
declare namespace NotSentEvent {
|
|
791
|
+
/**
|
|
792
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
793
|
+
*/
|
|
337
794
|
function Retrieve(filter: object): object[];
|
|
338
795
|
}
|
|
339
796
|
declare namespace OpenEvent {
|
|
797
|
+
/**
|
|
798
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
799
|
+
*/
|
|
340
800
|
function Retrieve(filter: object): object[];
|
|
341
801
|
}
|
|
342
802
|
declare namespace SentEvent {
|
|
803
|
+
/**
|
|
804
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
805
|
+
*/
|
|
343
806
|
function Retrieve(filter: object): object[];
|
|
344
807
|
}
|
|
345
808
|
declare namespace SurveyEvent {
|
|
809
|
+
/**
|
|
810
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
811
|
+
*/
|
|
346
812
|
function Retrieve(filter: object): object[];
|
|
347
813
|
}
|
|
348
814
|
declare namespace UnsubEvent {
|
|
815
|
+
/**
|
|
816
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
817
|
+
*/
|
|
349
818
|
function Retrieve(filter: object): object[];
|
|
350
819
|
}
|
|
351
820
|
|
|
352
821
|
// ── HTTP / HTTPHeader ────────────────────────────────────────────────────────
|
|
353
822
|
declare namespace HTTP {
|
|
823
|
+
/**
|
|
824
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
825
|
+
*/
|
|
354
826
|
function Get(url: string, headerNames?: any[], headerValues?: any[]): object;
|
|
827
|
+
/**
|
|
828
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
829
|
+
*/
|
|
355
830
|
function Post(url: string, contentType: string, payload: string, headerNames: string[], headerValues: any[]): object;
|
|
356
831
|
}
|
|
357
832
|
|
|
358
833
|
declare namespace HTTPHeader {
|
|
834
|
+
/**
|
|
835
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
836
|
+
*/
|
|
359
837
|
function GetValue(name: string): string;
|
|
838
|
+
/**
|
|
839
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
840
|
+
*/
|
|
360
841
|
function SetValue(name: string, value: string): void;
|
|
842
|
+
/**
|
|
843
|
+
* @remarks Requires `Platform.Load("Core", "1")` before use.
|
|
844
|
+
*/
|
|
361
845
|
function Remove(headerName: string): string;
|
|
362
846
|
}
|
|
363
847
|
|
package/package.json
CHANGED