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