ssjs-data 0.3.2 → 0.3.3
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 +3101 -36
- package/dist/site-index.json +3512 -0
- package/package.json +6 -2
- package/src/index.js +14 -1
- package/src/urls.js +203 -0
|
@@ -0,0 +1,3512 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "Lookup",
|
|
4
|
+
"url": "/platform-functions/lookup/",
|
|
5
|
+
"section": "Platform Functions",
|
|
6
|
+
"type": "function",
|
|
7
|
+
"description": "Retrieves a single field value from a Data Extension row matching filter criteria.",
|
|
8
|
+
"params": [
|
|
9
|
+
"deName",
|
|
10
|
+
"returnField",
|
|
11
|
+
"whereFieldNames",
|
|
12
|
+
"whereFieldValues"
|
|
13
|
+
],
|
|
14
|
+
"returnType": "string"
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
"name": "LookupRows",
|
|
18
|
+
"url": "/platform-functions/lookuprows/",
|
|
19
|
+
"section": "Platform Functions",
|
|
20
|
+
"type": "function",
|
|
21
|
+
"description": "Returns a result set of rows from a Data Extension matching filter criteria.",
|
|
22
|
+
"params": [
|
|
23
|
+
"deName",
|
|
24
|
+
"whereFieldNames",
|
|
25
|
+
"whereFieldValues"
|
|
26
|
+
],
|
|
27
|
+
"returnType": "object"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "LookupOrderedRows",
|
|
31
|
+
"url": "/platform-functions/lookuporderedrows/",
|
|
32
|
+
"section": "Platform Functions",
|
|
33
|
+
"type": "function",
|
|
34
|
+
"description": "Returns an ordered result set from a Data Extension.",
|
|
35
|
+
"params": [
|
|
36
|
+
"deName",
|
|
37
|
+
"count",
|
|
38
|
+
"orderBy",
|
|
39
|
+
"whereFieldNames",
|
|
40
|
+
"whereFieldValues"
|
|
41
|
+
],
|
|
42
|
+
"returnType": "object"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "InsertData",
|
|
46
|
+
"url": "/platform-functions/insertdata/",
|
|
47
|
+
"section": "Platform Functions",
|
|
48
|
+
"type": "function",
|
|
49
|
+
"description": "Adds a new row to a Data Extension.",
|
|
50
|
+
"params": [
|
|
51
|
+
"deName",
|
|
52
|
+
"fieldNames",
|
|
53
|
+
"fieldValues"
|
|
54
|
+
],
|
|
55
|
+
"returnType": "number"
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "InsertDE",
|
|
59
|
+
"url": "/platform-functions/insertde/",
|
|
60
|
+
"section": "Platform Functions",
|
|
61
|
+
"type": "function",
|
|
62
|
+
"description": "Adds a new row to a Data Extension.",
|
|
63
|
+
"params": [
|
|
64
|
+
"deName",
|
|
65
|
+
"fieldNames",
|
|
66
|
+
"fieldValues"
|
|
67
|
+
],
|
|
68
|
+
"returnType": "void"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "UpdateData",
|
|
72
|
+
"url": "/platform-functions/updatedata/",
|
|
73
|
+
"section": "Platform Functions",
|
|
74
|
+
"type": "function",
|
|
75
|
+
"description": "Modifies existing rows in a Data Extension matching filter criteria.",
|
|
76
|
+
"params": [
|
|
77
|
+
"deName",
|
|
78
|
+
"whereFieldNames",
|
|
79
|
+
"whereFieldValues",
|
|
80
|
+
"fieldNames",
|
|
81
|
+
"fieldValues"
|
|
82
|
+
],
|
|
83
|
+
"returnType": "number"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "UpdateDE",
|
|
87
|
+
"url": "/platform-functions/updatede/",
|
|
88
|
+
"section": "Platform Functions",
|
|
89
|
+
"type": "function",
|
|
90
|
+
"description": "Modifies existing rows in a Data Extension matching filter criteria.",
|
|
91
|
+
"params": [
|
|
92
|
+
"deName",
|
|
93
|
+
"whereFieldNames",
|
|
94
|
+
"whereFieldValues",
|
|
95
|
+
"fieldNames",
|
|
96
|
+
"fieldValues"
|
|
97
|
+
],
|
|
98
|
+
"returnType": "number"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "UpsertData",
|
|
102
|
+
"url": "/platform-functions/upsertdata/",
|
|
103
|
+
"section": "Platform Functions",
|
|
104
|
+
"type": "function",
|
|
105
|
+
"description": "Inserts a new row or updates an existing one in a Data Extension.",
|
|
106
|
+
"params": [
|
|
107
|
+
"deName",
|
|
108
|
+
"whereFieldNames",
|
|
109
|
+
"whereFieldValues",
|
|
110
|
+
"fieldNames",
|
|
111
|
+
"fieldValues"
|
|
112
|
+
],
|
|
113
|
+
"returnType": "number"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "UpsertDE",
|
|
117
|
+
"url": "/platform-functions/upsertde/",
|
|
118
|
+
"section": "Platform Functions",
|
|
119
|
+
"type": "function",
|
|
120
|
+
"description": "Inserts a new row or updates an existing one in a Data Extension.",
|
|
121
|
+
"params": [
|
|
122
|
+
"deName",
|
|
123
|
+
"whereFieldNames",
|
|
124
|
+
"whereFieldValues",
|
|
125
|
+
"fieldNames",
|
|
126
|
+
"fieldValues"
|
|
127
|
+
],
|
|
128
|
+
"returnType": "number"
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"name": "DeleteData",
|
|
132
|
+
"url": "/platform-functions/deletedata/",
|
|
133
|
+
"section": "Platform Functions",
|
|
134
|
+
"type": "function",
|
|
135
|
+
"description": "Removes rows from a Data Extension matching filter criteria.",
|
|
136
|
+
"params": [
|
|
137
|
+
"deName",
|
|
138
|
+
"whereFieldNames",
|
|
139
|
+
"whereFieldValues"
|
|
140
|
+
],
|
|
141
|
+
"returnType": "number"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"name": "DeleteDE",
|
|
145
|
+
"url": "/platform-functions/deletede/",
|
|
146
|
+
"section": "Platform Functions",
|
|
147
|
+
"type": "function",
|
|
148
|
+
"description": "Removes rows from a Data Extension matching filter criteria.",
|
|
149
|
+
"params": [
|
|
150
|
+
"deName",
|
|
151
|
+
"whereFieldNames",
|
|
152
|
+
"whereFieldValues"
|
|
153
|
+
],
|
|
154
|
+
"returnType": "number"
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
"name": "ContentBlockByKey",
|
|
158
|
+
"url": "/platform-functions/contentblockbykey/",
|
|
159
|
+
"section": "Platform Functions",
|
|
160
|
+
"type": "function",
|
|
161
|
+
"description": "Renders a Content Builder asset referenced by customer key.",
|
|
162
|
+
"params": [
|
|
163
|
+
"customerKey",
|
|
164
|
+
"regionName",
|
|
165
|
+
"stopOnError",
|
|
166
|
+
"fallbackContent"
|
|
167
|
+
],
|
|
168
|
+
"returnType": "string"
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
"name": "ContentBlockByName",
|
|
172
|
+
"url": "/platform-functions/contentblockbyname/",
|
|
173
|
+
"section": "Platform Functions",
|
|
174
|
+
"type": "function",
|
|
175
|
+
"description": "Renders a Content Builder asset referenced by folder path and name.",
|
|
176
|
+
"params": [
|
|
177
|
+
"name",
|
|
178
|
+
"regionName",
|
|
179
|
+
"stopOnError",
|
|
180
|
+
"fallbackContent",
|
|
181
|
+
"statusVariable"
|
|
182
|
+
],
|
|
183
|
+
"returnType": "string"
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"name": "ContentBlockByID",
|
|
187
|
+
"url": "/platform-functions/contentblockbyid/",
|
|
188
|
+
"section": "Platform Functions",
|
|
189
|
+
"type": "function",
|
|
190
|
+
"description": "Renders a Content Builder asset by its numeric identifier.",
|
|
191
|
+
"params": [
|
|
192
|
+
"id",
|
|
193
|
+
"regionName",
|
|
194
|
+
"stopOnError",
|
|
195
|
+
"fallbackContent"
|
|
196
|
+
],
|
|
197
|
+
"returnType": "string"
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"name": "ContentImageByKey",
|
|
201
|
+
"url": "/platform-functions/contentimagebykey/",
|
|
202
|
+
"section": "Platform Functions",
|
|
203
|
+
"type": "function",
|
|
204
|
+
"description": "Returns an HTML img tag for a Content Builder image identified by its external key.",
|
|
205
|
+
"params": [
|
|
206
|
+
"key",
|
|
207
|
+
"fallbackId"
|
|
208
|
+
],
|
|
209
|
+
"returnType": "string"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "ContentImageByID",
|
|
213
|
+
"url": "/platform-functions/contentimagebyid/",
|
|
214
|
+
"section": "Platform Functions",
|
|
215
|
+
"type": "function",
|
|
216
|
+
"description": "Returns an HTML img tag for a Content Builder image identified by its numeric ID.",
|
|
217
|
+
"params": [
|
|
218
|
+
"id",
|
|
219
|
+
"fallbackId"
|
|
220
|
+
],
|
|
221
|
+
"returnType": "string"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"name": "TreatAsContent",
|
|
225
|
+
"url": "/platform-functions/treatascontent/",
|
|
226
|
+
"section": "Platform Functions",
|
|
227
|
+
"type": "function",
|
|
228
|
+
"description": "Processes a string as AMPscript/HTML and returns rendered output.",
|
|
229
|
+
"params": [
|
|
230
|
+
"content"
|
|
231
|
+
],
|
|
232
|
+
"returnType": "string"
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "BeginImpressionRegion",
|
|
236
|
+
"url": "/platform-functions/beginimpressionregion/",
|
|
237
|
+
"section": "Platform Functions",
|
|
238
|
+
"type": "function",
|
|
239
|
+
"description": "Marks the start of a named impression tracking region within content.",
|
|
240
|
+
"params": [
|
|
241
|
+
"name"
|
|
242
|
+
],
|
|
243
|
+
"returnType": "void"
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
"name": "EndImpressionRegion",
|
|
247
|
+
"url": "/platform-functions/endimpressionregion/",
|
|
248
|
+
"section": "Platform Functions",
|
|
249
|
+
"type": "function",
|
|
250
|
+
"description": "Marks the end of an impression tracking region within content.",
|
|
251
|
+
"params": [
|
|
252
|
+
"closeAll"
|
|
253
|
+
],
|
|
254
|
+
"returnType": "void"
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"name": "Now",
|
|
258
|
+
"url": "/platform-functions/now/",
|
|
259
|
+
"section": "Platform Functions",
|
|
260
|
+
"type": "function",
|
|
261
|
+
"description": "Returns the current system timestamp, or the timestamp of the triggering send when called with true.",
|
|
262
|
+
"params": [
|
|
263
|
+
"useContextTime"
|
|
264
|
+
],
|
|
265
|
+
"returnType": "string"
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": "SystemDateToLocalDate",
|
|
269
|
+
"url": "/platform-functions/systemdatetolocaldate/",
|
|
270
|
+
"section": "Platform Functions",
|
|
271
|
+
"type": "function",
|
|
272
|
+
"description": "Converts a date-time value from Marketing Cloud system time (CST) to the local time of the account or user.",
|
|
273
|
+
"params": [
|
|
274
|
+
"dateValue"
|
|
275
|
+
],
|
|
276
|
+
"returnType": "string"
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "LocalDateToSystemDate",
|
|
280
|
+
"url": "/platform-functions/localdatetosystemdate/",
|
|
281
|
+
"section": "Platform Functions",
|
|
282
|
+
"type": "function",
|
|
283
|
+
"description": "Converts a date-time value from the local time of the account or user to Marketing Cloud system time (CST).",
|
|
284
|
+
"params": [
|
|
285
|
+
"dateValue"
|
|
286
|
+
],
|
|
287
|
+
"returnType": "string"
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"name": "RaiseError",
|
|
291
|
+
"url": "/platform-functions/raiseerror/",
|
|
292
|
+
"section": "Platform Functions",
|
|
293
|
+
"type": "function",
|
|
294
|
+
"description": "Raises an error with an optional scope flag.",
|
|
295
|
+
"params": [
|
|
296
|
+
"message",
|
|
297
|
+
"currentRecipientOnly",
|
|
298
|
+
"errorCode",
|
|
299
|
+
"errorNumber"
|
|
300
|
+
],
|
|
301
|
+
"returnType": "void"
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "GUID",
|
|
305
|
+
"url": "/platform-functions/guid/",
|
|
306
|
+
"section": "Platform Functions",
|
|
307
|
+
"type": "function",
|
|
308
|
+
"description": "Generates a new globally unique identifier string.",
|
|
309
|
+
"returnType": "string"
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"name": "IsEmailAddress",
|
|
313
|
+
"url": "/platform-functions/isemailaddress/",
|
|
314
|
+
"section": "Platform Functions",
|
|
315
|
+
"type": "function",
|
|
316
|
+
"description": "Checks whether a string is a valid email address format.",
|
|
317
|
+
"params": [
|
|
318
|
+
"value"
|
|
319
|
+
],
|
|
320
|
+
"returnType": "boolean"
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "IsPhoneNumber",
|
|
324
|
+
"url": "/platform-functions/isphonenumber/",
|
|
325
|
+
"section": "Platform Functions",
|
|
326
|
+
"type": "function",
|
|
327
|
+
"description": "Evaluates whether a string contains a valid phone number.",
|
|
328
|
+
"params": [
|
|
329
|
+
"value"
|
|
330
|
+
],
|
|
331
|
+
"returnType": "boolean"
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
"name": "CreateObject",
|
|
335
|
+
"url": "/platform-functions/createobject/",
|
|
336
|
+
"section": "Platform Functions",
|
|
337
|
+
"type": "function",
|
|
338
|
+
"description": "Instantiates a Marketing Cloud SOAP API object.",
|
|
339
|
+
"params": [
|
|
340
|
+
"objectType"
|
|
341
|
+
],
|
|
342
|
+
"returnType": "object"
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
"name": "SetObjectProperty",
|
|
346
|
+
"url": "/platform-functions/setobjectproperty/",
|
|
347
|
+
"section": "Platform Functions",
|
|
348
|
+
"type": "function",
|
|
349
|
+
"description": "Assigns a property value on a SOAP API object.",
|
|
350
|
+
"params": [
|
|
351
|
+
"apiObject",
|
|
352
|
+
"propertyName",
|
|
353
|
+
"value"
|
|
354
|
+
],
|
|
355
|
+
"returnType": "void"
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
"name": "AddObjectArrayItem",
|
|
359
|
+
"url": "/platform-functions/addobjectarrayitem/",
|
|
360
|
+
"section": "Platform Functions",
|
|
361
|
+
"type": "function",
|
|
362
|
+
"description": "Appends an item to a SOAP API object's array property.",
|
|
363
|
+
"params": [
|
|
364
|
+
"apiObject",
|
|
365
|
+
"propertyName",
|
|
366
|
+
"value"
|
|
367
|
+
],
|
|
368
|
+
"returnType": "void"
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"name": "InvokeCreate",
|
|
372
|
+
"url": "/platform-functions/invokecreate/",
|
|
373
|
+
"section": "Platform Functions",
|
|
374
|
+
"type": "function",
|
|
375
|
+
"description": "Executes a SOAP API Create call on an API object.",
|
|
376
|
+
"params": [
|
|
377
|
+
"apiObject",
|
|
378
|
+
"status",
|
|
379
|
+
"options"
|
|
380
|
+
],
|
|
381
|
+
"returnType": "object"
|
|
382
|
+
},
|
|
383
|
+
{
|
|
384
|
+
"name": "InvokeUpdate",
|
|
385
|
+
"url": "/platform-functions/invokeupdate/",
|
|
386
|
+
"section": "Platform Functions",
|
|
387
|
+
"type": "function",
|
|
388
|
+
"description": "Executes a SOAP API Update call on an API object.",
|
|
389
|
+
"params": [
|
|
390
|
+
"apiObject",
|
|
391
|
+
"status",
|
|
392
|
+
"options"
|
|
393
|
+
],
|
|
394
|
+
"returnType": "object"
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
"name": "InvokeDelete",
|
|
398
|
+
"url": "/platform-functions/invokedelete/",
|
|
399
|
+
"section": "Platform Functions",
|
|
400
|
+
"type": "function",
|
|
401
|
+
"description": "Executes a SOAP API Delete call on an API object.",
|
|
402
|
+
"params": [
|
|
403
|
+
"apiObject",
|
|
404
|
+
"status",
|
|
405
|
+
"options"
|
|
406
|
+
],
|
|
407
|
+
"returnType": "object"
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "InvokeRetrieve",
|
|
411
|
+
"url": "/platform-functions/invokeretrieve/",
|
|
412
|
+
"section": "Platform Functions",
|
|
413
|
+
"type": "function",
|
|
414
|
+
"description": "Executes a SOAP API Retrieve call.",
|
|
415
|
+
"params": [
|
|
416
|
+
"apiObject",
|
|
417
|
+
"status"
|
|
418
|
+
],
|
|
419
|
+
"returnType": "object"
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"name": "InvokePerform",
|
|
423
|
+
"url": "/platform-functions/invokeperform/",
|
|
424
|
+
"section": "Platform Functions",
|
|
425
|
+
"type": "function",
|
|
426
|
+
"description": "Executes a SOAP API Perform action on an API object.",
|
|
427
|
+
"params": [
|
|
428
|
+
"apiObject",
|
|
429
|
+
"method",
|
|
430
|
+
"status",
|
|
431
|
+
"options"
|
|
432
|
+
],
|
|
433
|
+
"returnType": "object"
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"name": "InvokeConfigure",
|
|
437
|
+
"url": "/platform-functions/invokeconfigure/",
|
|
438
|
+
"section": "Platform Functions",
|
|
439
|
+
"type": "function",
|
|
440
|
+
"description": "Executes a SOAP API Configure call on an API object.",
|
|
441
|
+
"params": [
|
|
442
|
+
"apiObject",
|
|
443
|
+
"method",
|
|
444
|
+
"status",
|
|
445
|
+
"options"
|
|
446
|
+
],
|
|
447
|
+
"returnType": "object"
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"name": "InvokeExecute",
|
|
451
|
+
"url": "/platform-functions/invokeexecute/",
|
|
452
|
+
"section": "Platform Functions",
|
|
453
|
+
"type": "function",
|
|
454
|
+
"description": "Executes a SOAP API Execute call on an API object.",
|
|
455
|
+
"params": [
|
|
456
|
+
"apiObject",
|
|
457
|
+
"status",
|
|
458
|
+
"options"
|
|
459
|
+
],
|
|
460
|
+
"returnType": "object"
|
|
461
|
+
},
|
|
462
|
+
{
|
|
463
|
+
"name": "InvokeExtract",
|
|
464
|
+
"url": "/platform-functions/invokeextract/",
|
|
465
|
+
"section": "Platform Functions",
|
|
466
|
+
"type": "function",
|
|
467
|
+
"description": "Invokes the Extract SOAP API method on the specified object.",
|
|
468
|
+
"params": [
|
|
469
|
+
"apiObject",
|
|
470
|
+
"statusArray",
|
|
471
|
+
"options"
|
|
472
|
+
],
|
|
473
|
+
"returnType": "string"
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "InvokeSchedule",
|
|
477
|
+
"url": "/platform-functions/invokeschedule/",
|
|
478
|
+
"section": "Platform Functions",
|
|
479
|
+
"type": "function",
|
|
480
|
+
"description": "Invokes the Schedule SOAP API method on the specified object.",
|
|
481
|
+
"params": [
|
|
482
|
+
"apiObject",
|
|
483
|
+
"action",
|
|
484
|
+
"schedule",
|
|
485
|
+
"statusArray",
|
|
486
|
+
"options"
|
|
487
|
+
],
|
|
488
|
+
"returnType": "string"
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
"name": "HTTPGet",
|
|
492
|
+
"url": "/platform-functions/httpget/",
|
|
493
|
+
"section": "Platform Functions",
|
|
494
|
+
"type": "function",
|
|
495
|
+
"description": "Performs an HTTP GET request and returns the response body.",
|
|
496
|
+
"params": [
|
|
497
|
+
"url",
|
|
498
|
+
"continueOnError",
|
|
499
|
+
"emptyContentHandling",
|
|
500
|
+
"headerNames",
|
|
501
|
+
"headerValues",
|
|
502
|
+
"statusVariable"
|
|
503
|
+
],
|
|
504
|
+
"returnType": "string"
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "HTTPPost",
|
|
508
|
+
"url": "/platform-functions/httppost/",
|
|
509
|
+
"section": "Platform Functions",
|
|
510
|
+
"type": "function",
|
|
511
|
+
"description": "Performs an HTTP POST request with a content type and payload.",
|
|
512
|
+
"params": [
|
|
513
|
+
"url",
|
|
514
|
+
"contentType",
|
|
515
|
+
"payload",
|
|
516
|
+
"headerNames",
|
|
517
|
+
"headerValues",
|
|
518
|
+
"response"
|
|
519
|
+
],
|
|
520
|
+
"returnType": "number"
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"name": "ParseJSON",
|
|
524
|
+
"url": "/platform-functions/parsejson/",
|
|
525
|
+
"section": "Platform Functions",
|
|
526
|
+
"type": "function",
|
|
527
|
+
"description": "Parses a JSON-formatted string (or array of strings) and returns the resulting JavaScript object (or array of objects).",
|
|
528
|
+
"params": [
|
|
529
|
+
"jsonString"
|
|
530
|
+
],
|
|
531
|
+
"returnType": "object|object[]"
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
"name": "RedirectTo",
|
|
535
|
+
"url": "/platform-functions/redirectto/",
|
|
536
|
+
"section": "Platform Functions",
|
|
537
|
+
"type": "function",
|
|
538
|
+
"description": "Specifies the target of an email link as a complete URL stored in an attribute, data extension field, or variable.",
|
|
539
|
+
"params": [
|
|
540
|
+
"url"
|
|
541
|
+
],
|
|
542
|
+
"returnType": "void"
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
"name": "UrlEncode",
|
|
546
|
+
"url": "/platform-functions/urlencode/",
|
|
547
|
+
"section": "Platform Functions",
|
|
548
|
+
"type": "function",
|
|
549
|
+
"description": "Percent-encodes a complete URL.",
|
|
550
|
+
"params": [
|
|
551
|
+
"url",
|
|
552
|
+
"encodeReservedKeywords"
|
|
553
|
+
],
|
|
554
|
+
"returnType": "string"
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"name": "Base64Encode",
|
|
558
|
+
"url": "/platform-functions/base64encode/",
|
|
559
|
+
"section": "Platform Functions",
|
|
560
|
+
"type": "function",
|
|
561
|
+
"description": "Encodes any string value to Base64.",
|
|
562
|
+
"params": [
|
|
563
|
+
"string",
|
|
564
|
+
"charset"
|
|
565
|
+
],
|
|
566
|
+
"returnType": "string"
|
|
567
|
+
},
|
|
568
|
+
{
|
|
569
|
+
"name": "Base64Decode",
|
|
570
|
+
"url": "/platform-functions/base64decode/",
|
|
571
|
+
"section": "Platform Functions",
|
|
572
|
+
"type": "function",
|
|
573
|
+
"description": "Decodes a Base64-encoded string.",
|
|
574
|
+
"params": [
|
|
575
|
+
"encodedString",
|
|
576
|
+
"charset"
|
|
577
|
+
],
|
|
578
|
+
"returnType": "string"
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"name": "MD5",
|
|
582
|
+
"url": "/platform-functions/md5/",
|
|
583
|
+
"section": "Platform Functions",
|
|
584
|
+
"type": "function",
|
|
585
|
+
"description": "Returns an MD5 hash for a given string value.",
|
|
586
|
+
"params": [
|
|
587
|
+
"string",
|
|
588
|
+
"charset"
|
|
589
|
+
],
|
|
590
|
+
"returnType": "string"
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"name": "Stringify",
|
|
594
|
+
"url": "/global-functions/stringify/",
|
|
595
|
+
"section": "Platform Functions",
|
|
596
|
+
"type": "function",
|
|
597
|
+
"description": "Converts a JavaScript object into its JSON string representation.",
|
|
598
|
+
"params": [
|
|
599
|
+
"object"
|
|
600
|
+
],
|
|
601
|
+
"returnType": "string"
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
"name": "IsCHTMLBrowser",
|
|
605
|
+
"url": "/platform-functions/ischtmlbrowser/",
|
|
606
|
+
"section": "Platform Functions",
|
|
607
|
+
"type": "function",
|
|
608
|
+
"description": "Indicates whether the passed-in user-agent value represents a CHTML browser.",
|
|
609
|
+
"params": [
|
|
610
|
+
"userAgentString"
|
|
611
|
+
],
|
|
612
|
+
"returnType": "boolean"
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
"name": "HTTP.Get",
|
|
616
|
+
"url": "/http/get/",
|
|
617
|
+
"section": "HTTP & REST",
|
|
618
|
+
"type": "function",
|
|
619
|
+
"description": "Performs an HTTP GET request and returns the response body.",
|
|
620
|
+
"params": [
|
|
621
|
+
"url",
|
|
622
|
+
"headerNames",
|
|
623
|
+
"headerValues"
|
|
624
|
+
],
|
|
625
|
+
"returnType": "object"
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"name": "HTTP.Post",
|
|
629
|
+
"url": "/http/post/",
|
|
630
|
+
"section": "HTTP & REST",
|
|
631
|
+
"type": "function",
|
|
632
|
+
"description": "Performs an HTTP POST request with a content type and payload.",
|
|
633
|
+
"params": [
|
|
634
|
+
"url",
|
|
635
|
+
"contentType",
|
|
636
|
+
"payload",
|
|
637
|
+
"headerNames",
|
|
638
|
+
"headerValues"
|
|
639
|
+
],
|
|
640
|
+
"returnType": "object"
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
"name": "proxy.createItem",
|
|
644
|
+
"url": "/wsproxy/createitem/",
|
|
645
|
+
"section": "WSProxy",
|
|
646
|
+
"type": "method",
|
|
647
|
+
"description": "Creates a new Marketing Cloud object via the SOAP API.",
|
|
648
|
+
"params": [
|
|
649
|
+
"objectType",
|
|
650
|
+
"properties"
|
|
651
|
+
],
|
|
652
|
+
"returnType": "object"
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"name": "proxy.updateItem",
|
|
656
|
+
"url": "/wsproxy/updateitem/",
|
|
657
|
+
"section": "WSProxy",
|
|
658
|
+
"type": "method",
|
|
659
|
+
"description": "Updates an existing Marketing Cloud object via the SOAP API.",
|
|
660
|
+
"params": [
|
|
661
|
+
"objectType",
|
|
662
|
+
"properties"
|
|
663
|
+
],
|
|
664
|
+
"returnType": "object"
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"name": "proxy.deleteItem",
|
|
668
|
+
"url": "/wsproxy/deleteitem/",
|
|
669
|
+
"section": "WSProxy",
|
|
670
|
+
"type": "method",
|
|
671
|
+
"description": "Deletes a Marketing Cloud object via the SOAP API.",
|
|
672
|
+
"params": [
|
|
673
|
+
"objectType",
|
|
674
|
+
"properties"
|
|
675
|
+
],
|
|
676
|
+
"returnType": "object"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"name": "proxy.retrieve",
|
|
680
|
+
"url": "/wsproxy/retrieve/",
|
|
681
|
+
"section": "WSProxy",
|
|
682
|
+
"type": "method",
|
|
683
|
+
"description": "Retrieves Marketing Cloud objects matching an optional filter via the SOAP API.",
|
|
684
|
+
"params": [
|
|
685
|
+
"objectType",
|
|
686
|
+
"columns",
|
|
687
|
+
"filter",
|
|
688
|
+
"retrieveOptions",
|
|
689
|
+
"requestProps"
|
|
690
|
+
],
|
|
691
|
+
"returnType": "object"
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
"name": "proxy.getNextBatch",
|
|
695
|
+
"url": "/wsproxy/getnextbatch/",
|
|
696
|
+
"section": "WSProxy",
|
|
697
|
+
"type": "method",
|
|
698
|
+
"description": "Retrieves the next page of results from a previous retrieve call that returned HasMoreRows = true.",
|
|
699
|
+
"params": [
|
|
700
|
+
"objectType",
|
|
701
|
+
"requestId"
|
|
702
|
+
],
|
|
703
|
+
"returnType": "object"
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
"name": "proxy.performItem",
|
|
707
|
+
"url": "/wsproxy/perform/",
|
|
708
|
+
"section": "WSProxy",
|
|
709
|
+
"type": "method",
|
|
710
|
+
"description": "Executes a perform action on a single Marketing Cloud object.",
|
|
711
|
+
"params": [
|
|
712
|
+
"objectType",
|
|
713
|
+
"properties",
|
|
714
|
+
"action",
|
|
715
|
+
"performOptions"
|
|
716
|
+
],
|
|
717
|
+
"returnType": "object"
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
"name": "proxy.performBatch",
|
|
721
|
+
"url": "/wsproxy/performbatch/",
|
|
722
|
+
"section": "WSProxy",
|
|
723
|
+
"type": "method",
|
|
724
|
+
"description": "Executes a perform action on multiple Marketing Cloud objects in a single SOAP API call.",
|
|
725
|
+
"params": [
|
|
726
|
+
"objectType",
|
|
727
|
+
"propertiesArray",
|
|
728
|
+
"action",
|
|
729
|
+
"performOptions"
|
|
730
|
+
],
|
|
731
|
+
"returnType": "object"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"name": "proxy.describe",
|
|
735
|
+
"url": "/wsproxy/describe/",
|
|
736
|
+
"section": "WSProxy",
|
|
737
|
+
"type": "method",
|
|
738
|
+
"description": "Returns structural metadata (ObjectDefinition) for one or more SOAP API object types.",
|
|
739
|
+
"params": [
|
|
740
|
+
"objectType"
|
|
741
|
+
],
|
|
742
|
+
"returnType": "object"
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"name": "proxy.execute",
|
|
746
|
+
"url": "/wsproxy/execute/",
|
|
747
|
+
"section": "WSProxy",
|
|
748
|
+
"type": "method",
|
|
749
|
+
"description": "Executes a named method on a Marketing Cloud object.",
|
|
750
|
+
"params": [
|
|
751
|
+
"objectType",
|
|
752
|
+
"requestName"
|
|
753
|
+
],
|
|
754
|
+
"returnType": "object"
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"name": "proxy.setBatchSize",
|
|
758
|
+
"url": "/wsproxy/setbatchsize/",
|
|
759
|
+
"section": "WSProxy",
|
|
760
|
+
"type": "method",
|
|
761
|
+
"description": "Sets the maximum number of objects returned per SOAP API page (default is 2500).",
|
|
762
|
+
"params": [
|
|
763
|
+
"batchSize"
|
|
764
|
+
],
|
|
765
|
+
"returnType": "void"
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
"name": "proxy.setClientId",
|
|
769
|
+
"url": "/wsproxy/setclientid/",
|
|
770
|
+
"section": "WSProxy",
|
|
771
|
+
"type": "method",
|
|
772
|
+
"description": "Sets the business unit MID for cross-account operations.",
|
|
773
|
+
"params": [
|
|
774
|
+
"clientId"
|
|
775
|
+
],
|
|
776
|
+
"returnType": "void"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "proxy.resetClientIds",
|
|
780
|
+
"url": "/wsproxy/resetclientids/",
|
|
781
|
+
"section": "WSProxy",
|
|
782
|
+
"type": "method",
|
|
783
|
+
"description": "Clears all client IDs set on the WSProxy instance, reverting to the default execution context credentials.",
|
|
784
|
+
"returnType": "void"
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
"name": "proxy.createBatch",
|
|
788
|
+
"url": "/wsproxy/createbatch/",
|
|
789
|
+
"section": "WSProxy",
|
|
790
|
+
"type": "method",
|
|
791
|
+
"description": "Creates multiple Marketing Cloud objects in a single SOAP API call.",
|
|
792
|
+
"params": [
|
|
793
|
+
"objectType",
|
|
794
|
+
"propertiesArray"
|
|
795
|
+
],
|
|
796
|
+
"returnType": "object"
|
|
797
|
+
},
|
|
798
|
+
{
|
|
799
|
+
"name": "proxy.updateBatch",
|
|
800
|
+
"url": "/wsproxy/updatebatch/",
|
|
801
|
+
"section": "WSProxy",
|
|
802
|
+
"type": "method",
|
|
803
|
+
"description": "Updates multiple Marketing Cloud objects in a single SOAP API call.",
|
|
804
|
+
"params": [
|
|
805
|
+
"objectType",
|
|
806
|
+
"propertiesArray"
|
|
807
|
+
],
|
|
808
|
+
"returnType": "object"
|
|
809
|
+
},
|
|
810
|
+
{
|
|
811
|
+
"name": "proxy.deleteBatch",
|
|
812
|
+
"url": "/wsproxy/deletebatch/",
|
|
813
|
+
"section": "WSProxy",
|
|
814
|
+
"type": "method",
|
|
815
|
+
"description": "Deletes multiple Marketing Cloud objects in a single SOAP API call.",
|
|
816
|
+
"params": [
|
|
817
|
+
"objectType",
|
|
818
|
+
"propertiesArray"
|
|
819
|
+
],
|
|
820
|
+
"returnType": "object"
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "new Script.Util.WSProxy",
|
|
824
|
+
"url": "/wsproxy/",
|
|
825
|
+
"section": "HTTP & REST",
|
|
826
|
+
"type": "function",
|
|
827
|
+
"description": "Creates a WSProxy instance for making SOAP API calls against the Marketing Cloud web service.",
|
|
828
|
+
"returnType": "WSProxyInstance"
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"name": "new Script.Util.HttpRequest",
|
|
832
|
+
"url": "/http/script-util-httprequest/",
|
|
833
|
+
"section": "HTTP & REST",
|
|
834
|
+
"type": "function",
|
|
835
|
+
"description": "Creates an HTTP request handler that supports any HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS).",
|
|
836
|
+
"params": [
|
|
837
|
+
"url"
|
|
838
|
+
],
|
|
839
|
+
"returnType": "HttpRequestInstance"
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
"name": "new Script.Util.HttpGet",
|
|
843
|
+
"url": "/http/script-util-httpget/",
|
|
844
|
+
"section": "HTTP & REST",
|
|
845
|
+
"type": "function",
|
|
846
|
+
"description": "Creates an HTTP GET request handler.",
|
|
847
|
+
"params": [
|
|
848
|
+
"url"
|
|
849
|
+
],
|
|
850
|
+
"returnType": "HttpRequestInstance"
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "<HttpRequestInstance>.send",
|
|
854
|
+
"url": "/http/request-methods/",
|
|
855
|
+
"section": "HTTP & REST",
|
|
856
|
+
"type": "method",
|
|
857
|
+
"description": "Executes the HTTP request and returns a Script.",
|
|
858
|
+
"returnType": "object"
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "<HttpRequestInstance>.setHeader",
|
|
862
|
+
"url": "/http/request-methods/",
|
|
863
|
+
"section": "HTTP & REST",
|
|
864
|
+
"type": "method",
|
|
865
|
+
"description": "Sets a request header on the Script.",
|
|
866
|
+
"params": [
|
|
867
|
+
"name",
|
|
868
|
+
"value"
|
|
869
|
+
],
|
|
870
|
+
"returnType": "void"
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"name": "<HttpRequestInstance>.clearHeaders",
|
|
874
|
+
"url": "/http/request-methods/",
|
|
875
|
+
"section": "HTTP & REST",
|
|
876
|
+
"type": "method",
|
|
877
|
+
"description": "Removes all custom headers previously set on the request.",
|
|
878
|
+
"returnType": "void"
|
|
879
|
+
},
|
|
880
|
+
{
|
|
881
|
+
"name": "<HttpRequestInstance>.removeHeader",
|
|
882
|
+
"url": "/http/request-methods/",
|
|
883
|
+
"section": "HTTP & REST",
|
|
884
|
+
"type": "method",
|
|
885
|
+
"description": "Removes a specific header from the request by name.",
|
|
886
|
+
"params": [
|
|
887
|
+
"name"
|
|
888
|
+
],
|
|
889
|
+
"returnType": "void"
|
|
890
|
+
},
|
|
891
|
+
{
|
|
892
|
+
"name": "Platform.Load",
|
|
893
|
+
"url": "/platform-objects/platform-load/",
|
|
894
|
+
"section": "Platform Objects",
|
|
895
|
+
"type": "method",
|
|
896
|
+
"description": "Loads a platform library.",
|
|
897
|
+
"params": [
|
|
898
|
+
"libraryName",
|
|
899
|
+
"version"
|
|
900
|
+
],
|
|
901
|
+
"returnType": "void"
|
|
902
|
+
},
|
|
903
|
+
{
|
|
904
|
+
"name": "Platform.Variable.GetValue",
|
|
905
|
+
"url": "/platform-objects/platform-variable/",
|
|
906
|
+
"section": "Platform Objects",
|
|
907
|
+
"type": "method",
|
|
908
|
+
"description": "Retrieves the value of an AMPscript variable from the SSJS context.",
|
|
909
|
+
"params": [
|
|
910
|
+
"variableName"
|
|
911
|
+
],
|
|
912
|
+
"returnType": "string"
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
"name": "Platform.Variable.SetValue",
|
|
916
|
+
"url": "/platform-objects/platform-variable/",
|
|
917
|
+
"section": "Platform Objects",
|
|
918
|
+
"type": "method",
|
|
919
|
+
"description": "Assigns a value to an AMPscript variable from the SSJS context.",
|
|
920
|
+
"params": [
|
|
921
|
+
"variableName",
|
|
922
|
+
"value"
|
|
923
|
+
],
|
|
924
|
+
"returnType": "void"
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
"name": "Platform.Response.SetResponseHeader",
|
|
928
|
+
"url": "/platform-objects/platform-response/",
|
|
929
|
+
"section": "Platform Objects",
|
|
930
|
+
"type": "method",
|
|
931
|
+
"description": "Sets a response header on the current page response.",
|
|
932
|
+
"params": [
|
|
933
|
+
"headerName",
|
|
934
|
+
"value"
|
|
935
|
+
],
|
|
936
|
+
"returnType": "void"
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"name": "Platform.Response.RemoveResponseHeader",
|
|
940
|
+
"url": "/platform-objects/platform-response/",
|
|
941
|
+
"section": "Platform Objects",
|
|
942
|
+
"type": "method",
|
|
943
|
+
"description": "Removes a previously set HTTP response header from the response.",
|
|
944
|
+
"params": [
|
|
945
|
+
"headerName"
|
|
946
|
+
],
|
|
947
|
+
"returnType": "void"
|
|
948
|
+
},
|
|
949
|
+
{
|
|
950
|
+
"name": "Platform.Response.Redirect",
|
|
951
|
+
"url": "/platform-objects/platform-response/",
|
|
952
|
+
"section": "Platform Objects",
|
|
953
|
+
"type": "method",
|
|
954
|
+
"description": "Redirects the current page to a new URL.",
|
|
955
|
+
"params": [
|
|
956
|
+
"url",
|
|
957
|
+
"movedPermanently"
|
|
958
|
+
],
|
|
959
|
+
"returnType": "void"
|
|
960
|
+
},
|
|
961
|
+
{
|
|
962
|
+
"name": "Platform.Response.SetCookie",
|
|
963
|
+
"url": "/platform-objects/platform-response/",
|
|
964
|
+
"section": "Platform Objects",
|
|
965
|
+
"type": "method",
|
|
966
|
+
"description": "Sets a cookie on the client browser response.",
|
|
967
|
+
"params": [
|
|
968
|
+
"name",
|
|
969
|
+
"value",
|
|
970
|
+
"expires",
|
|
971
|
+
"secure"
|
|
972
|
+
],
|
|
973
|
+
"returnType": "void"
|
|
974
|
+
},
|
|
975
|
+
{
|
|
976
|
+
"name": "Platform.Response.RemoveCookie",
|
|
977
|
+
"url": "/platform-objects/platform-response/",
|
|
978
|
+
"section": "Platform Objects",
|
|
979
|
+
"type": "method",
|
|
980
|
+
"description": "Removes a cookie from the client browser by setting its expiration to a past date.",
|
|
981
|
+
"params": [
|
|
982
|
+
"name"
|
|
983
|
+
],
|
|
984
|
+
"returnType": "void"
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"name": "Platform.Response.Write",
|
|
988
|
+
"url": "/platform-objects/platform-response/",
|
|
989
|
+
"section": "Platform Objects",
|
|
990
|
+
"type": "method",
|
|
991
|
+
"description": "Writes content to the HTTP response output.",
|
|
992
|
+
"params": [
|
|
993
|
+
"content"
|
|
994
|
+
],
|
|
995
|
+
"returnType": "void"
|
|
996
|
+
},
|
|
997
|
+
{
|
|
998
|
+
"name": "Platform.Response.ContentType",
|
|
999
|
+
"url": "/platform-objects/platform-response/",
|
|
1000
|
+
"section": "Platform Objects",
|
|
1001
|
+
"type": "property",
|
|
1002
|
+
"description": "Gets or sets the Content-Type of the HTTP response.",
|
|
1003
|
+
"returnType": "string"
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"name": "Platform.Response.CharacterSet",
|
|
1007
|
+
"url": "/platform-objects/platform-response/",
|
|
1008
|
+
"section": "Platform Objects",
|
|
1009
|
+
"type": "property",
|
|
1010
|
+
"description": "Gets or sets the character set of the HTTP response.",
|
|
1011
|
+
"returnType": "string"
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"name": "Platform.Request.GetQueryStringParameter",
|
|
1015
|
+
"url": "/platform-objects/platform-request/",
|
|
1016
|
+
"section": "Platform Objects",
|
|
1017
|
+
"type": "method",
|
|
1018
|
+
"description": "Retrieves the value of a URL query string parameter.",
|
|
1019
|
+
"params": [
|
|
1020
|
+
"parameterName"
|
|
1021
|
+
],
|
|
1022
|
+
"returnType": "string"
|
|
1023
|
+
},
|
|
1024
|
+
{
|
|
1025
|
+
"name": "Platform.Request.GetFormField",
|
|
1026
|
+
"url": "/platform-objects/platform-request/",
|
|
1027
|
+
"section": "Platform Objects",
|
|
1028
|
+
"type": "method",
|
|
1029
|
+
"description": "Retrieves data from a named form field, including values sent via POST.",
|
|
1030
|
+
"params": [
|
|
1031
|
+
"name"
|
|
1032
|
+
],
|
|
1033
|
+
"returnType": "string"
|
|
1034
|
+
},
|
|
1035
|
+
{
|
|
1036
|
+
"name": "Platform.Request.GetPostData",
|
|
1037
|
+
"url": "/platform-objects/platform-request/",
|
|
1038
|
+
"section": "Platform Objects",
|
|
1039
|
+
"type": "method",
|
|
1040
|
+
"description": "Returns the raw body of the HTTP POST request.",
|
|
1041
|
+
"params": [
|
|
1042
|
+
"encoding"
|
|
1043
|
+
],
|
|
1044
|
+
"returnType": "string"
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "Platform.Request.GetCookieValue",
|
|
1048
|
+
"url": "/platform-objects/platform-request/",
|
|
1049
|
+
"section": "Platform Objects",
|
|
1050
|
+
"type": "method",
|
|
1051
|
+
"description": "Retrieves the value of a named cookie from the HTTP request sent by the client browser.",
|
|
1052
|
+
"params": [
|
|
1053
|
+
"cookieName"
|
|
1054
|
+
],
|
|
1055
|
+
"returnType": "string"
|
|
1056
|
+
},
|
|
1057
|
+
{
|
|
1058
|
+
"name": "Platform.Request.GetUserLanguages",
|
|
1059
|
+
"url": "/platform-objects/platform-request/",
|
|
1060
|
+
"section": "Platform Objects",
|
|
1061
|
+
"type": "method",
|
|
1062
|
+
"description": "Returns the language preferences of the client browser as specified in the HTTP Accept-Language request header.",
|
|
1063
|
+
"returnType": "string"
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"name": "Platform.Request.GetRequestHeader",
|
|
1067
|
+
"url": "/platform-objects/platform-request/",
|
|
1068
|
+
"section": "Platform Objects",
|
|
1069
|
+
"type": "method",
|
|
1070
|
+
"description": "Returns the value of the named HTTP request header, or null if not present.",
|
|
1071
|
+
"params": [
|
|
1072
|
+
"headerName"
|
|
1073
|
+
],
|
|
1074
|
+
"returnType": "string"
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
"name": "Platform.Request.Browser",
|
|
1078
|
+
"url": "/platform-objects/platform-request/",
|
|
1079
|
+
"section": "Platform Objects",
|
|
1080
|
+
"type": "property",
|
|
1081
|
+
"description": "Returns an object describing the client browser.",
|
|
1082
|
+
"returnType": "object"
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
"name": "Platform.Request.ClientIP",
|
|
1086
|
+
"url": "/platform-objects/platform-request/",
|
|
1087
|
+
"section": "Platform Objects",
|
|
1088
|
+
"type": "property",
|
|
1089
|
+
"description": "Returns the IP address of the client.",
|
|
1090
|
+
"returnType": "string"
|
|
1091
|
+
},
|
|
1092
|
+
{
|
|
1093
|
+
"name": "Platform.Request.HasSSL",
|
|
1094
|
+
"url": "/platform-objects/platform-request/",
|
|
1095
|
+
"section": "Platform Objects",
|
|
1096
|
+
"type": "property",
|
|
1097
|
+
"description": "Returns true if the current request was made over HTTPS.",
|
|
1098
|
+
"returnType": "boolean"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "Platform.Request.IsSSL",
|
|
1102
|
+
"url": "/platform-objects/platform-request/",
|
|
1103
|
+
"section": "Platform Objects",
|
|
1104
|
+
"type": "property",
|
|
1105
|
+
"description": "Returns true if the current request was made over HTTPS (alias of HasSSL).",
|
|
1106
|
+
"returnType": "boolean"
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"name": "Platform.Request.Method",
|
|
1110
|
+
"url": "/platform-objects/platform-request/",
|
|
1111
|
+
"section": "Platform Objects",
|
|
1112
|
+
"type": "property",
|
|
1113
|
+
"description": "Returns the HTTP method (GET, POST, etc.",
|
|
1114
|
+
"returnType": "string"
|
|
1115
|
+
},
|
|
1116
|
+
{
|
|
1117
|
+
"name": "Platform.Request.QueryString",
|
|
1118
|
+
"url": "/platform-objects/platform-request/",
|
|
1119
|
+
"section": "Platform Objects",
|
|
1120
|
+
"type": "property",
|
|
1121
|
+
"description": "Returns the full query string of the current request URL.",
|
|
1122
|
+
"returnType": "string"
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "Platform.Request.ReferrerURL",
|
|
1126
|
+
"url": "/platform-objects/platform-request/",
|
|
1127
|
+
"section": "Platform Objects",
|
|
1128
|
+
"type": "property",
|
|
1129
|
+
"description": "Returns the referrer URL from the HTTP Referer header.",
|
|
1130
|
+
"returnType": "string"
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"name": "Platform.Request.RequestURL",
|
|
1134
|
+
"url": "/platform-objects/platform-request/",
|
|
1135
|
+
"section": "Platform Objects",
|
|
1136
|
+
"type": "property",
|
|
1137
|
+
"description": "Returns the full URL of the current page request.",
|
|
1138
|
+
"returnType": "string"
|
|
1139
|
+
},
|
|
1140
|
+
{
|
|
1141
|
+
"name": "Platform.Request.UserAgent",
|
|
1142
|
+
"url": "/platform-objects/platform-request/",
|
|
1143
|
+
"section": "Platform Objects",
|
|
1144
|
+
"type": "property",
|
|
1145
|
+
"description": "Returns the user-agent string from the HTTP request.",
|
|
1146
|
+
"returnType": "string"
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"name": "Platform.Recipient.GetAttributeValue",
|
|
1150
|
+
"url": "/platform-objects/platform-recipient/",
|
|
1151
|
+
"section": "Platform Objects",
|
|
1152
|
+
"type": "method",
|
|
1153
|
+
"description": "Returns the value of a subscriber attribute or sendable data extension field for the current recipient.",
|
|
1154
|
+
"params": [
|
|
1155
|
+
"attributeName"
|
|
1156
|
+
],
|
|
1157
|
+
"returnType": "string"
|
|
1158
|
+
},
|
|
1159
|
+
{
|
|
1160
|
+
"name": "HTTPHeader.GetValue",
|
|
1161
|
+
"url": "/platform-objects/httpheader/",
|
|
1162
|
+
"section": "Platform Objects",
|
|
1163
|
+
"type": "method",
|
|
1164
|
+
"description": "Retrieves the value of the specified HTTP request header.",
|
|
1165
|
+
"params": [
|
|
1166
|
+
"name"
|
|
1167
|
+
],
|
|
1168
|
+
"returnType": "string"
|
|
1169
|
+
},
|
|
1170
|
+
{
|
|
1171
|
+
"name": "HTTPHeader.SetValue",
|
|
1172
|
+
"url": "/platform-objects/httpheader/",
|
|
1173
|
+
"section": "Platform Objects",
|
|
1174
|
+
"type": "method",
|
|
1175
|
+
"description": "Sets the value of the specified HTTP header.",
|
|
1176
|
+
"params": [
|
|
1177
|
+
"name",
|
|
1178
|
+
"value"
|
|
1179
|
+
],
|
|
1180
|
+
"returnType": "void"
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
"name": "HTTPHeader.Remove",
|
|
1184
|
+
"url": "/platform-objects/httpheader/",
|
|
1185
|
+
"section": "Platform Objects",
|
|
1186
|
+
"type": "method",
|
|
1187
|
+
"description": "Removes the specified entry from the HTTP header.",
|
|
1188
|
+
"params": [
|
|
1189
|
+
"headerName"
|
|
1190
|
+
],
|
|
1191
|
+
"returnType": "string"
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "DateTime.TimeZone.Retrieve",
|
|
1195
|
+
"url": "/platform-objects/datetime-timezone/",
|
|
1196
|
+
"section": "Platform Objects",
|
|
1197
|
+
"type": "method",
|
|
1198
|
+
"description": "Retrieves an array of time zones matching the specified filter criteria.",
|
|
1199
|
+
"params": [
|
|
1200
|
+
"filter"
|
|
1201
|
+
],
|
|
1202
|
+
"returnType": "object[]"
|
|
1203
|
+
},
|
|
1204
|
+
{
|
|
1205
|
+
"name": "ErrorUtil.ThrowWSProxyError",
|
|
1206
|
+
"url": "/platform-objects/errorutil/",
|
|
1207
|
+
"section": "Platform Objects",
|
|
1208
|
+
"type": "method",
|
|
1209
|
+
"description": "Inspects a WSProxy result object and throws an exception when its `Status` property starts with `\"Error:\"`.",
|
|
1210
|
+
"params": [
|
|
1211
|
+
"result"
|
|
1212
|
+
],
|
|
1213
|
+
"returnType": "void"
|
|
1214
|
+
},
|
|
1215
|
+
{
|
|
1216
|
+
"name": "Attribute.GetValue",
|
|
1217
|
+
"url": "/global-functions/attribute/",
|
|
1218
|
+
"section": "Global Functions",
|
|
1219
|
+
"type": "method",
|
|
1220
|
+
"description": "Returns the value of the specified subscriber attribute or sendable data extension field for the current recipient.",
|
|
1221
|
+
"params": [
|
|
1222
|
+
"name"
|
|
1223
|
+
],
|
|
1224
|
+
"returnType": "string"
|
|
1225
|
+
},
|
|
1226
|
+
{
|
|
1227
|
+
"name": "DataExtension.Init",
|
|
1228
|
+
"url": "/core-library/dataextension/",
|
|
1229
|
+
"section": "Core Library",
|
|
1230
|
+
"type": "method",
|
|
1231
|
+
"description": "Initializes a DataExtension instance bound to the specified external key.",
|
|
1232
|
+
"params": [
|
|
1233
|
+
"key"
|
|
1234
|
+
],
|
|
1235
|
+
"returnType": "DataExtensionInstance"
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
"name": "DataExtension.Add",
|
|
1239
|
+
"url": "/core-library/dataextension/",
|
|
1240
|
+
"section": "Core Library",
|
|
1241
|
+
"type": "method",
|
|
1242
|
+
"description": "Creates a new data extension from the supplied properties and returns an initialized DataExtension instance.",
|
|
1243
|
+
"params": [
|
|
1244
|
+
"properties"
|
|
1245
|
+
],
|
|
1246
|
+
"returnType": "DataExtensionInstance"
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "DataExtension.Retrieve",
|
|
1250
|
+
"url": "/core-library/dataextension/",
|
|
1251
|
+
"section": "Core Library",
|
|
1252
|
+
"type": "method",
|
|
1253
|
+
"description": "Returns an array of data extensions matching the specified filter.",
|
|
1254
|
+
"params": [
|
|
1255
|
+
"filter",
|
|
1256
|
+
"queryAllAccounts"
|
|
1257
|
+
],
|
|
1258
|
+
"returnType": "object[]"
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"name": "DataExtension.Fields.Add",
|
|
1262
|
+
"url": "/core-library/dataextension-fields/",
|
|
1263
|
+
"section": "Core Library",
|
|
1264
|
+
"type": "method",
|
|
1265
|
+
"description": "Adds a field to the previously initialized data extension.",
|
|
1266
|
+
"params": [
|
|
1267
|
+
"properties"
|
|
1268
|
+
],
|
|
1269
|
+
"returnType": "string"
|
|
1270
|
+
},
|
|
1271
|
+
{
|
|
1272
|
+
"name": "DataExtension.Fields.Retrieve",
|
|
1273
|
+
"url": "/core-library/dataextension-fields/",
|
|
1274
|
+
"section": "Core Library",
|
|
1275
|
+
"type": "method",
|
|
1276
|
+
"description": "Returns an array of field definitions for the previously initialized data extension.",
|
|
1277
|
+
"returnType": "object[]"
|
|
1278
|
+
},
|
|
1279
|
+
{
|
|
1280
|
+
"name": "DataExtension.Fields.UpdateSendableField",
|
|
1281
|
+
"url": "/core-library/dataextension-fields/",
|
|
1282
|
+
"section": "Core Library",
|
|
1283
|
+
"type": "method",
|
|
1284
|
+
"description": "Updates which data extension field is used to relate the data extension to the All Subscribers list during sending.",
|
|
1285
|
+
"params": [
|
|
1286
|
+
"deFieldName",
|
|
1287
|
+
"subscriberField"
|
|
1288
|
+
],
|
|
1289
|
+
"returnType": "string"
|
|
1290
|
+
},
|
|
1291
|
+
{
|
|
1292
|
+
"name": "DataExtension.Rows.Add",
|
|
1293
|
+
"url": "/core-library/dataextension-rows/",
|
|
1294
|
+
"section": "Core Library",
|
|
1295
|
+
"type": "method",
|
|
1296
|
+
"description": "Adds one or more rows to the previously initialized data extension.",
|
|
1297
|
+
"params": [
|
|
1298
|
+
"rowData"
|
|
1299
|
+
],
|
|
1300
|
+
"returnType": "string"
|
|
1301
|
+
},
|
|
1302
|
+
{
|
|
1303
|
+
"name": "DataExtension.Rows.Lookup",
|
|
1304
|
+
"url": "/core-library/dataextension-rows/",
|
|
1305
|
+
"section": "Core Library",
|
|
1306
|
+
"type": "method",
|
|
1307
|
+
"description": "Returns rows where the specified columns equal the specified values (AND-joined).",
|
|
1308
|
+
"params": [
|
|
1309
|
+
"searchFieldNames",
|
|
1310
|
+
"searchValues",
|
|
1311
|
+
"limit",
|
|
1312
|
+
"orderByFieldName"
|
|
1313
|
+
],
|
|
1314
|
+
"returnType": "object[]"
|
|
1315
|
+
},
|
|
1316
|
+
{
|
|
1317
|
+
"name": "DataExtension.Rows.Remove",
|
|
1318
|
+
"url": "/core-library/dataextension-rows/",
|
|
1319
|
+
"section": "Core Library",
|
|
1320
|
+
"type": "method",
|
|
1321
|
+
"description": "Deletes rows from the previously initialized data extension where the specified columns equal the specified values (AND-joined).",
|
|
1322
|
+
"params": [
|
|
1323
|
+
"columnNames",
|
|
1324
|
+
"columnValues"
|
|
1325
|
+
],
|
|
1326
|
+
"returnType": "number"
|
|
1327
|
+
},
|
|
1328
|
+
{
|
|
1329
|
+
"name": "DataExtension.Rows.Retrieve",
|
|
1330
|
+
"url": "/core-library/dataextension-rows/",
|
|
1331
|
+
"section": "Core Library",
|
|
1332
|
+
"type": "method",
|
|
1333
|
+
"description": "Retrieves up to 2500 rows from the previously initialized data extension.",
|
|
1334
|
+
"params": [
|
|
1335
|
+
"filter"
|
|
1336
|
+
],
|
|
1337
|
+
"returnType": "object[]"
|
|
1338
|
+
},
|
|
1339
|
+
{
|
|
1340
|
+
"name": "DataExtension.Rows.Update",
|
|
1341
|
+
"url": "/core-library/dataextension-rows/",
|
|
1342
|
+
"section": "Core Library",
|
|
1343
|
+
"type": "method",
|
|
1344
|
+
"description": "Updates the columns of rows where `whereFieldNames` equal `whereValues` (AND-joined).",
|
|
1345
|
+
"params": [
|
|
1346
|
+
"rowData",
|
|
1347
|
+
"whereFieldNames",
|
|
1348
|
+
"whereValues"
|
|
1349
|
+
],
|
|
1350
|
+
"returnType": "string"
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"name": "Account.Init",
|
|
1354
|
+
"url": "/core-library/account/",
|
|
1355
|
+
"section": "Core Library",
|
|
1356
|
+
"type": "method",
|
|
1357
|
+
"description": "Initializes an Account instance bound to the specified external key.",
|
|
1358
|
+
"params": [
|
|
1359
|
+
"key"
|
|
1360
|
+
],
|
|
1361
|
+
"returnType": "AccountInstance"
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"name": "Account.Retrieve",
|
|
1365
|
+
"url": "/core-library/account/",
|
|
1366
|
+
"section": "Core Library",
|
|
1367
|
+
"type": "method",
|
|
1368
|
+
"description": "Retrieves accounts based on the specified filter criteria.",
|
|
1369
|
+
"params": [
|
|
1370
|
+
"filter"
|
|
1371
|
+
],
|
|
1372
|
+
"returnType": "object[]"
|
|
1373
|
+
},
|
|
1374
|
+
{
|
|
1375
|
+
"name": "Account.Update",
|
|
1376
|
+
"url": "/core-library/account/",
|
|
1377
|
+
"section": "Core Library",
|
|
1378
|
+
"type": "method",
|
|
1379
|
+
"description": "Updates the account with the supplied attributes.",
|
|
1380
|
+
"params": [
|
|
1381
|
+
"properties"
|
|
1382
|
+
],
|
|
1383
|
+
"returnType": "string"
|
|
1384
|
+
},
|
|
1385
|
+
{
|
|
1386
|
+
"name": "Account.Tracking.Retrieve",
|
|
1387
|
+
"url": "/core-library/account/",
|
|
1388
|
+
"section": "Core Library",
|
|
1389
|
+
"type": "method",
|
|
1390
|
+
"description": "Returns an array of tracking data related to the accounts specified by the passed filter argument.",
|
|
1391
|
+
"params": [
|
|
1392
|
+
"filter"
|
|
1393
|
+
],
|
|
1394
|
+
"returnType": "object[]"
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"name": "AccountUser.Init",
|
|
1398
|
+
"url": "/core-library/accountuser/",
|
|
1399
|
+
"section": "Core Library",
|
|
1400
|
+
"type": "method",
|
|
1401
|
+
"description": "Initializes an AccountUser instance bound to the specified external key and client ID (MID).",
|
|
1402
|
+
"params": [
|
|
1403
|
+
"targetUserKey",
|
|
1404
|
+
"myClientID"
|
|
1405
|
+
],
|
|
1406
|
+
"returnType": "AccountUserInstance"
|
|
1407
|
+
},
|
|
1408
|
+
{
|
|
1409
|
+
"name": "AccountUser.Add",
|
|
1410
|
+
"url": "/core-library/accountuser/",
|
|
1411
|
+
"section": "Core Library",
|
|
1412
|
+
"type": "method",
|
|
1413
|
+
"description": "Creates a new account user from the supplied properties object.",
|
|
1414
|
+
"params": [
|
|
1415
|
+
"properties"
|
|
1416
|
+
],
|
|
1417
|
+
"returnType": "string"
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
"name": "AccountUser.Retrieve",
|
|
1421
|
+
"url": "/core-library/accountuser/",
|
|
1422
|
+
"section": "Core Library",
|
|
1423
|
+
"type": "method",
|
|
1424
|
+
"description": "Retrieves account users based on the specified filter criteria.",
|
|
1425
|
+
"params": [
|
|
1426
|
+
"filter"
|
|
1427
|
+
],
|
|
1428
|
+
"returnType": "object[]"
|
|
1429
|
+
},
|
|
1430
|
+
{
|
|
1431
|
+
"name": "AccountUser.Update",
|
|
1432
|
+
"url": "/core-library/accountuser/",
|
|
1433
|
+
"section": "Core Library",
|
|
1434
|
+
"type": "method",
|
|
1435
|
+
"description": "Updates the account user with the supplied attributes.",
|
|
1436
|
+
"params": [
|
|
1437
|
+
"properties"
|
|
1438
|
+
],
|
|
1439
|
+
"returnType": "string"
|
|
1440
|
+
},
|
|
1441
|
+
{
|
|
1442
|
+
"name": "AccountUser.Activate",
|
|
1443
|
+
"url": "/core-library/accountuser/",
|
|
1444
|
+
"section": "Core Library",
|
|
1445
|
+
"type": "method",
|
|
1446
|
+
"description": "Activates the account user.",
|
|
1447
|
+
"returnType": "string"
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"name": "AccountUser.Deactivate",
|
|
1451
|
+
"url": "/core-library/accountuser/",
|
|
1452
|
+
"section": "Core Library",
|
|
1453
|
+
"type": "method",
|
|
1454
|
+
"description": "Deactivates the account user.",
|
|
1455
|
+
"returnType": "string"
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
"name": "Email.Init",
|
|
1459
|
+
"url": "/core-library/email/",
|
|
1460
|
+
"section": "Core Library",
|
|
1461
|
+
"type": "method",
|
|
1462
|
+
"description": "Initializes an Email instance bound to the specified external key.",
|
|
1463
|
+
"params": [
|
|
1464
|
+
"key"
|
|
1465
|
+
],
|
|
1466
|
+
"returnType": "EmailInstance"
|
|
1467
|
+
},
|
|
1468
|
+
{
|
|
1469
|
+
"name": "Email.Add",
|
|
1470
|
+
"url": "/core-library/email/",
|
|
1471
|
+
"section": "Core Library",
|
|
1472
|
+
"type": "method",
|
|
1473
|
+
"description": "Creates a new email message from the supplied properties and returns an initialized email instance.",
|
|
1474
|
+
"params": [
|
|
1475
|
+
"properties"
|
|
1476
|
+
],
|
|
1477
|
+
"returnType": "EmailInstance"
|
|
1478
|
+
},
|
|
1479
|
+
{
|
|
1480
|
+
"name": "Email.Retrieve",
|
|
1481
|
+
"url": "/core-library/email/",
|
|
1482
|
+
"section": "Core Library",
|
|
1483
|
+
"type": "method",
|
|
1484
|
+
"description": "Returns an array of email messages matching the specified filter.",
|
|
1485
|
+
"params": [
|
|
1486
|
+
"filter"
|
|
1487
|
+
],
|
|
1488
|
+
"returnType": "object[]"
|
|
1489
|
+
},
|
|
1490
|
+
{
|
|
1491
|
+
"name": "Email.Update",
|
|
1492
|
+
"url": "/core-library/email/",
|
|
1493
|
+
"section": "Core Library",
|
|
1494
|
+
"type": "method",
|
|
1495
|
+
"description": "Updates the email message with the supplied attributes.",
|
|
1496
|
+
"params": [
|
|
1497
|
+
"properties"
|
|
1498
|
+
],
|
|
1499
|
+
"returnType": "string"
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
"name": "Email.Remove",
|
|
1503
|
+
"url": "/core-library/email/",
|
|
1504
|
+
"section": "Core Library",
|
|
1505
|
+
"type": "method",
|
|
1506
|
+
"description": "Removes the previously initialized email message.",
|
|
1507
|
+
"returnType": "string"
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"name": "Email.Validate",
|
|
1511
|
+
"url": "/core-library/email/",
|
|
1512
|
+
"section": "Core Library",
|
|
1513
|
+
"type": "method",
|
|
1514
|
+
"description": "Runs validation checks on the previously initialized email message.",
|
|
1515
|
+
"returnType": "object"
|
|
1516
|
+
},
|
|
1517
|
+
{
|
|
1518
|
+
"name": "Email.CheckContent",
|
|
1519
|
+
"url": "/core-library/email/",
|
|
1520
|
+
"section": "Core Library",
|
|
1521
|
+
"type": "method",
|
|
1522
|
+
"description": "Runs content checks on the previously initialized email message.",
|
|
1523
|
+
"returnType": "object"
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"name": "FilterDefinition.Init",
|
|
1527
|
+
"url": "/core-library/filterdefinition/",
|
|
1528
|
+
"section": "Core Library",
|
|
1529
|
+
"type": "method",
|
|
1530
|
+
"description": "Initializes a FilterDefinition instance bound to the specified external key.",
|
|
1531
|
+
"params": [
|
|
1532
|
+
"key"
|
|
1533
|
+
],
|
|
1534
|
+
"returnType": "FilterDefinitionInstance"
|
|
1535
|
+
},
|
|
1536
|
+
{
|
|
1537
|
+
"name": "FilterDefinition.Add",
|
|
1538
|
+
"url": "/core-library/filterdefinition/",
|
|
1539
|
+
"section": "Core Library",
|
|
1540
|
+
"type": "method",
|
|
1541
|
+
"description": "Creates a new filter definition from the supplied properties.",
|
|
1542
|
+
"params": [
|
|
1543
|
+
"properties"
|
|
1544
|
+
],
|
|
1545
|
+
"returnType": "string"
|
|
1546
|
+
},
|
|
1547
|
+
{
|
|
1548
|
+
"name": "FilterDefinition.Retrieve",
|
|
1549
|
+
"url": "/core-library/filterdefinition/",
|
|
1550
|
+
"section": "Core Library",
|
|
1551
|
+
"type": "method",
|
|
1552
|
+
"description": "Returns an array of filter definitions matching the specified filter.",
|
|
1553
|
+
"params": [
|
|
1554
|
+
"filter"
|
|
1555
|
+
],
|
|
1556
|
+
"returnType": "object[]"
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"name": "FilterDefinition.Update",
|
|
1560
|
+
"url": "/core-library/filterdefinition/",
|
|
1561
|
+
"section": "Core Library",
|
|
1562
|
+
"type": "method",
|
|
1563
|
+
"description": "Updates the filter definition with the supplied attributes.",
|
|
1564
|
+
"params": [
|
|
1565
|
+
"properties"
|
|
1566
|
+
],
|
|
1567
|
+
"returnType": "string"
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"name": "FilterDefinition.Remove",
|
|
1571
|
+
"url": "/core-library/filterdefinition/",
|
|
1572
|
+
"section": "Core Library",
|
|
1573
|
+
"type": "method",
|
|
1574
|
+
"description": "Deletes the previously initialized filter definition.",
|
|
1575
|
+
"returnType": "string"
|
|
1576
|
+
},
|
|
1577
|
+
{
|
|
1578
|
+
"name": "Folder.Init",
|
|
1579
|
+
"url": "/core-library/folder/",
|
|
1580
|
+
"section": "Core Library",
|
|
1581
|
+
"type": "method",
|
|
1582
|
+
"description": "Initializes a Folder instance, optionally bound to the specified external key.",
|
|
1583
|
+
"params": [
|
|
1584
|
+
"key"
|
|
1585
|
+
],
|
|
1586
|
+
"returnType": "FolderInstance"
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"name": "Folder.Add",
|
|
1590
|
+
"url": "/core-library/folder/",
|
|
1591
|
+
"section": "Core Library",
|
|
1592
|
+
"type": "method",
|
|
1593
|
+
"description": "Creates a new folder as a child of an existing folder.",
|
|
1594
|
+
"params": [
|
|
1595
|
+
"properties"
|
|
1596
|
+
],
|
|
1597
|
+
"returnType": "string"
|
|
1598
|
+
},
|
|
1599
|
+
{
|
|
1600
|
+
"name": "Folder.Retrieve",
|
|
1601
|
+
"url": "/core-library/folder/",
|
|
1602
|
+
"section": "Core Library",
|
|
1603
|
+
"type": "method",
|
|
1604
|
+
"description": "Returns an array of folders matching the specified filter.",
|
|
1605
|
+
"params": [
|
|
1606
|
+
"filter"
|
|
1607
|
+
],
|
|
1608
|
+
"returnType": "object[]"
|
|
1609
|
+
},
|
|
1610
|
+
{
|
|
1611
|
+
"name": "Folder.Update",
|
|
1612
|
+
"url": "/core-library/folder/",
|
|
1613
|
+
"section": "Core Library",
|
|
1614
|
+
"type": "method",
|
|
1615
|
+
"description": "Updates the folder with the supplied attributes.",
|
|
1616
|
+
"params": [
|
|
1617
|
+
"properties"
|
|
1618
|
+
],
|
|
1619
|
+
"returnType": "string"
|
|
1620
|
+
},
|
|
1621
|
+
{
|
|
1622
|
+
"name": "Folder.Remove",
|
|
1623
|
+
"url": "/core-library/folder/",
|
|
1624
|
+
"section": "Core Library",
|
|
1625
|
+
"type": "method",
|
|
1626
|
+
"description": "Removes the previously initialized folder.",
|
|
1627
|
+
"returnType": "string"
|
|
1628
|
+
},
|
|
1629
|
+
{
|
|
1630
|
+
"name": "Folder.SetID",
|
|
1631
|
+
"url": "/core-library/folder/",
|
|
1632
|
+
"section": "Core Library",
|
|
1633
|
+
"type": "method",
|
|
1634
|
+
"description": "Binds a previously initialized Folder instance to a specific folder ID.",
|
|
1635
|
+
"params": [
|
|
1636
|
+
"id"
|
|
1637
|
+
],
|
|
1638
|
+
"returnType": "void"
|
|
1639
|
+
},
|
|
1640
|
+
{
|
|
1641
|
+
"name": "List.Init",
|
|
1642
|
+
"url": "/core-library/list/",
|
|
1643
|
+
"section": "Core Library",
|
|
1644
|
+
"type": "method",
|
|
1645
|
+
"description": "Initializes a List instance bound to the specified external key.",
|
|
1646
|
+
"params": [
|
|
1647
|
+
"key"
|
|
1648
|
+
],
|
|
1649
|
+
"returnType": "ListInstance"
|
|
1650
|
+
},
|
|
1651
|
+
{
|
|
1652
|
+
"name": "List.Add",
|
|
1653
|
+
"url": "/core-library/list/",
|
|
1654
|
+
"section": "Core Library",
|
|
1655
|
+
"type": "method",
|
|
1656
|
+
"description": "Creates a new list from the supplied properties and returns an initialized list instance.",
|
|
1657
|
+
"params": [
|
|
1658
|
+
"properties"
|
|
1659
|
+
],
|
|
1660
|
+
"returnType": "ListInstance"
|
|
1661
|
+
},
|
|
1662
|
+
{
|
|
1663
|
+
"name": "List.Retrieve",
|
|
1664
|
+
"url": "/core-library/list/",
|
|
1665
|
+
"section": "Core Library",
|
|
1666
|
+
"type": "method",
|
|
1667
|
+
"description": "Returns an array of lists matching the specified filter.",
|
|
1668
|
+
"params": [
|
|
1669
|
+
"filter"
|
|
1670
|
+
],
|
|
1671
|
+
"returnType": "object[]"
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"name": "List.Remove",
|
|
1675
|
+
"url": "/core-library/list/",
|
|
1676
|
+
"section": "Core Library",
|
|
1677
|
+
"type": "method",
|
|
1678
|
+
"description": "Removes the previously initialized list.",
|
|
1679
|
+
"returnType": "string"
|
|
1680
|
+
},
|
|
1681
|
+
{
|
|
1682
|
+
"name": "List.Subscribers.Add",
|
|
1683
|
+
"url": "/core-library/list-subscribers/",
|
|
1684
|
+
"section": "Core Library",
|
|
1685
|
+
"type": "method",
|
|
1686
|
+
"description": "Adds a subscriber to the previously initialized list.",
|
|
1687
|
+
"params": [
|
|
1688
|
+
"properties"
|
|
1689
|
+
],
|
|
1690
|
+
"returnType": "string"
|
|
1691
|
+
},
|
|
1692
|
+
{
|
|
1693
|
+
"name": "List.Subscribers.Retrieve",
|
|
1694
|
+
"url": "/core-library/list-subscribers/",
|
|
1695
|
+
"section": "Core Library",
|
|
1696
|
+
"type": "method",
|
|
1697
|
+
"description": "Returns the subscribers belonging to the previously initialized list.",
|
|
1698
|
+
"params": [
|
|
1699
|
+
"filter"
|
|
1700
|
+
],
|
|
1701
|
+
"returnType": "object[]"
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "List.Subscribers.Unsubscribe",
|
|
1705
|
+
"url": "/core-library/list-subscribers/",
|
|
1706
|
+
"section": "Core Library",
|
|
1707
|
+
"type": "method",
|
|
1708
|
+
"description": "Removes the specified subscriber from the previously initialized list.",
|
|
1709
|
+
"params": [
|
|
1710
|
+
"emailAddress"
|
|
1711
|
+
],
|
|
1712
|
+
"returnType": "string"
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
"name": "List.Subscribers.Update",
|
|
1716
|
+
"url": "/core-library/list-subscribers/",
|
|
1717
|
+
"section": "Core Library",
|
|
1718
|
+
"type": "method",
|
|
1719
|
+
"description": "Updates the status of the specified subscriber on the previously initialized list.",
|
|
1720
|
+
"params": [
|
|
1721
|
+
"emailAddress",
|
|
1722
|
+
"status"
|
|
1723
|
+
],
|
|
1724
|
+
"returnType": "string"
|
|
1725
|
+
},
|
|
1726
|
+
{
|
|
1727
|
+
"name": "List.Subscribers.Upsert",
|
|
1728
|
+
"url": "/core-library/list-subscribers/",
|
|
1729
|
+
"section": "Core Library",
|
|
1730
|
+
"type": "method",
|
|
1731
|
+
"description": "Adds the subscriber if not on the list, otherwise updates the supplied attributes.",
|
|
1732
|
+
"params": [
|
|
1733
|
+
"emailAddress",
|
|
1734
|
+
"attributes"
|
|
1735
|
+
],
|
|
1736
|
+
"returnType": "string"
|
|
1737
|
+
},
|
|
1738
|
+
{
|
|
1739
|
+
"name": "List.Subscribers.Tracking.Retrieve",
|
|
1740
|
+
"url": "/core-library/list-subscribers/",
|
|
1741
|
+
"section": "Core Library",
|
|
1742
|
+
"type": "method",
|
|
1743
|
+
"description": "Returns an array of tracking data for subscribers matching the filter.",
|
|
1744
|
+
"params": [
|
|
1745
|
+
"filter"
|
|
1746
|
+
],
|
|
1747
|
+
"returnType": "object[]"
|
|
1748
|
+
},
|
|
1749
|
+
{
|
|
1750
|
+
"name": "Subscriber.Init",
|
|
1751
|
+
"url": "/core-library/subscriber/",
|
|
1752
|
+
"section": "Core Library",
|
|
1753
|
+
"type": "method",
|
|
1754
|
+
"description": "Initializes a Subscriber instance bound to the specified subscriber key.",
|
|
1755
|
+
"params": [
|
|
1756
|
+
"key"
|
|
1757
|
+
],
|
|
1758
|
+
"returnType": "SubscriberInstance"
|
|
1759
|
+
},
|
|
1760
|
+
{
|
|
1761
|
+
"name": "Subscriber.Add",
|
|
1762
|
+
"url": "/core-library/subscriber/",
|
|
1763
|
+
"section": "Core Library",
|
|
1764
|
+
"type": "method",
|
|
1765
|
+
"description": "Creates a new subscriber from the supplied properties.",
|
|
1766
|
+
"params": [
|
|
1767
|
+
"properties"
|
|
1768
|
+
],
|
|
1769
|
+
"returnType": "string"
|
|
1770
|
+
},
|
|
1771
|
+
{
|
|
1772
|
+
"name": "Subscriber.Retrieve",
|
|
1773
|
+
"url": "/core-library/subscriber/",
|
|
1774
|
+
"section": "Core Library",
|
|
1775
|
+
"type": "method",
|
|
1776
|
+
"description": "Returns an array of subscribers matching the specified filter.",
|
|
1777
|
+
"params": [
|
|
1778
|
+
"filter"
|
|
1779
|
+
],
|
|
1780
|
+
"returnType": "object[]"
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"name": "Subscriber.Upsert",
|
|
1784
|
+
"url": "/core-library/subscriber/",
|
|
1785
|
+
"section": "Core Library",
|
|
1786
|
+
"type": "method",
|
|
1787
|
+
"description": "Creates a new subscriber, or updates an existing one matched by EmailAddress / SubscriberKey.",
|
|
1788
|
+
"params": [
|
|
1789
|
+
"properties"
|
|
1790
|
+
],
|
|
1791
|
+
"returnType": "string"
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"name": "Subscriber.Statistics",
|
|
1795
|
+
"url": "/core-library/subscriber/",
|
|
1796
|
+
"section": "Core Library",
|
|
1797
|
+
"type": "method",
|
|
1798
|
+
"description": "Retrieves statistical data for the specified subscriber (sends, opens, clicks, bounces, unsubscribes).",
|
|
1799
|
+
"params": [
|
|
1800
|
+
"subscriberKey"
|
|
1801
|
+
],
|
|
1802
|
+
"returnType": "object"
|
|
1803
|
+
},
|
|
1804
|
+
{
|
|
1805
|
+
"name": "Subscriber.Update",
|
|
1806
|
+
"url": "/core-library/subscriber/",
|
|
1807
|
+
"section": "Core Library",
|
|
1808
|
+
"type": "method",
|
|
1809
|
+
"description": "Updates the previously initialized subscriber with the supplied attributes.",
|
|
1810
|
+
"params": [
|
|
1811
|
+
"properties"
|
|
1812
|
+
],
|
|
1813
|
+
"returnType": "string"
|
|
1814
|
+
},
|
|
1815
|
+
{
|
|
1816
|
+
"name": "Subscriber.Remove",
|
|
1817
|
+
"url": "/core-library/subscriber/",
|
|
1818
|
+
"section": "Core Library",
|
|
1819
|
+
"type": "method",
|
|
1820
|
+
"description": "Deletes the previously initialized subscriber.",
|
|
1821
|
+
"returnType": "string"
|
|
1822
|
+
},
|
|
1823
|
+
{
|
|
1824
|
+
"name": "Subscriber.Unsubscribe",
|
|
1825
|
+
"url": "/core-library/subscriber/",
|
|
1826
|
+
"section": "Core Library",
|
|
1827
|
+
"type": "method",
|
|
1828
|
+
"description": "Sets the previously initialized subscriber's status to `\"Unsubscribed\"`.",
|
|
1829
|
+
"returnType": "string"
|
|
1830
|
+
},
|
|
1831
|
+
{
|
|
1832
|
+
"name": "Subscriber.Attributes.Retrieve",
|
|
1833
|
+
"url": "/core-library/subscriber/",
|
|
1834
|
+
"section": "Core Library",
|
|
1835
|
+
"type": "method",
|
|
1836
|
+
"description": "Returns an array of attributes associated with the previously initialized subscriber.",
|
|
1837
|
+
"returnType": "object[]"
|
|
1838
|
+
},
|
|
1839
|
+
{
|
|
1840
|
+
"name": "Subscriber.Lists.Retrieve",
|
|
1841
|
+
"url": "/core-library/subscriber/",
|
|
1842
|
+
"section": "Core Library",
|
|
1843
|
+
"type": "method",
|
|
1844
|
+
"description": "Returns the lists the previously initialized subscriber is a member of.",
|
|
1845
|
+
"returnType": "object[]"
|
|
1846
|
+
},
|
|
1847
|
+
{
|
|
1848
|
+
"name": "Template.Init",
|
|
1849
|
+
"url": "/core-library/template/",
|
|
1850
|
+
"section": "Core Library",
|
|
1851
|
+
"type": "method",
|
|
1852
|
+
"description": "Initializes a Template instance bound to the specified external key.",
|
|
1853
|
+
"params": [
|
|
1854
|
+
"key"
|
|
1855
|
+
],
|
|
1856
|
+
"returnType": "TemplateInstance"
|
|
1857
|
+
},
|
|
1858
|
+
{
|
|
1859
|
+
"name": "Template.Add",
|
|
1860
|
+
"url": "/core-library/template/",
|
|
1861
|
+
"section": "Core Library",
|
|
1862
|
+
"type": "method",
|
|
1863
|
+
"description": "Creates a new template from the supplied properties.",
|
|
1864
|
+
"params": [
|
|
1865
|
+
"properties"
|
|
1866
|
+
],
|
|
1867
|
+
"returnType": "string"
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
"name": "Template.Retrieve",
|
|
1871
|
+
"url": "/core-library/template/",
|
|
1872
|
+
"section": "Core Library",
|
|
1873
|
+
"type": "method",
|
|
1874
|
+
"description": "Returns an array of templates matching the specified filter.",
|
|
1875
|
+
"params": [
|
|
1876
|
+
"filter"
|
|
1877
|
+
],
|
|
1878
|
+
"returnType": "object[]"
|
|
1879
|
+
},
|
|
1880
|
+
{
|
|
1881
|
+
"name": "Template.Update",
|
|
1882
|
+
"url": "/core-library/template/",
|
|
1883
|
+
"section": "Core Library",
|
|
1884
|
+
"type": "method",
|
|
1885
|
+
"description": "Updates the template with the supplied attributes.",
|
|
1886
|
+
"params": [
|
|
1887
|
+
"properties"
|
|
1888
|
+
],
|
|
1889
|
+
"returnType": "string"
|
|
1890
|
+
},
|
|
1891
|
+
{
|
|
1892
|
+
"name": "DeliveryProfile.Init",
|
|
1893
|
+
"url": "/core-library/deliveryprofile/",
|
|
1894
|
+
"section": "Core Library",
|
|
1895
|
+
"type": "method",
|
|
1896
|
+
"description": "Initializes a DeliveryProfile instance bound to the specified external key.",
|
|
1897
|
+
"params": [
|
|
1898
|
+
"key"
|
|
1899
|
+
],
|
|
1900
|
+
"returnType": "DeliveryProfileInstance"
|
|
1901
|
+
},
|
|
1902
|
+
{
|
|
1903
|
+
"name": "DeliveryProfile.Add",
|
|
1904
|
+
"url": "/core-library/deliveryprofile/",
|
|
1905
|
+
"section": "Core Library",
|
|
1906
|
+
"type": "method",
|
|
1907
|
+
"description": "Creates a new delivery profile from the supplied properties.",
|
|
1908
|
+
"params": [
|
|
1909
|
+
"properties"
|
|
1910
|
+
],
|
|
1911
|
+
"returnType": "string"
|
|
1912
|
+
},
|
|
1913
|
+
{
|
|
1914
|
+
"name": "DeliveryProfile.Update",
|
|
1915
|
+
"url": "/core-library/deliveryprofile/",
|
|
1916
|
+
"section": "Core Library",
|
|
1917
|
+
"type": "method",
|
|
1918
|
+
"description": "Updates the delivery profile with the supplied attributes.",
|
|
1919
|
+
"params": [
|
|
1920
|
+
"properties"
|
|
1921
|
+
],
|
|
1922
|
+
"returnType": "string"
|
|
1923
|
+
},
|
|
1924
|
+
{
|
|
1925
|
+
"name": "DeliveryProfile.Remove",
|
|
1926
|
+
"url": "/core-library/deliveryprofile/",
|
|
1927
|
+
"section": "Core Library",
|
|
1928
|
+
"type": "method",
|
|
1929
|
+
"description": "Removes the previously initialized delivery profile.",
|
|
1930
|
+
"returnType": "string"
|
|
1931
|
+
},
|
|
1932
|
+
{
|
|
1933
|
+
"name": "SenderProfile.Init",
|
|
1934
|
+
"url": "/core-library/senderprofile/",
|
|
1935
|
+
"section": "Core Library",
|
|
1936
|
+
"type": "method",
|
|
1937
|
+
"description": "Initializes a SenderProfile instance bound to the specified external key.",
|
|
1938
|
+
"params": [
|
|
1939
|
+
"key"
|
|
1940
|
+
],
|
|
1941
|
+
"returnType": "SenderProfileInstance"
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"name": "SenderProfile.Add",
|
|
1945
|
+
"url": "/core-library/senderprofile/",
|
|
1946
|
+
"section": "Core Library",
|
|
1947
|
+
"type": "method",
|
|
1948
|
+
"description": "Creates a new sender profile from the supplied properties.",
|
|
1949
|
+
"params": [
|
|
1950
|
+
"properties"
|
|
1951
|
+
],
|
|
1952
|
+
"returnType": "string"
|
|
1953
|
+
},
|
|
1954
|
+
{
|
|
1955
|
+
"name": "SenderProfile.Update",
|
|
1956
|
+
"url": "/core-library/senderprofile/",
|
|
1957
|
+
"section": "Core Library",
|
|
1958
|
+
"type": "method",
|
|
1959
|
+
"description": "Updates the sender profile with the supplied attributes.",
|
|
1960
|
+
"params": [
|
|
1961
|
+
"properties"
|
|
1962
|
+
],
|
|
1963
|
+
"returnType": "string"
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"name": "SenderProfile.Remove",
|
|
1967
|
+
"url": "/core-library/senderprofile/",
|
|
1968
|
+
"section": "Core Library",
|
|
1969
|
+
"type": "method",
|
|
1970
|
+
"description": "Removes the previously initialized sender profile.",
|
|
1971
|
+
"returnType": "string"
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
"name": "SendClassification.Init",
|
|
1975
|
+
"url": "/core-library/sendclassification/",
|
|
1976
|
+
"section": "Core Library",
|
|
1977
|
+
"type": "method",
|
|
1978
|
+
"description": "Initializes a SendClassification instance bound to the specified external key.",
|
|
1979
|
+
"params": [
|
|
1980
|
+
"key"
|
|
1981
|
+
],
|
|
1982
|
+
"returnType": "SendClassificationInstance"
|
|
1983
|
+
},
|
|
1984
|
+
{
|
|
1985
|
+
"name": "SendClassification.Add",
|
|
1986
|
+
"url": "/core-library/sendclassification/",
|
|
1987
|
+
"section": "Core Library",
|
|
1988
|
+
"type": "method",
|
|
1989
|
+
"description": "Creates a new send classification from the supplied properties.",
|
|
1990
|
+
"params": [
|
|
1991
|
+
"properties"
|
|
1992
|
+
],
|
|
1993
|
+
"returnType": "string"
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"name": "SendClassification.Retrieve",
|
|
1997
|
+
"url": "/core-library/sendclassification/",
|
|
1998
|
+
"section": "Core Library",
|
|
1999
|
+
"type": "method",
|
|
2000
|
+
"description": "Returns an array of send classifications matching the specified filter.",
|
|
2001
|
+
"params": [
|
|
2002
|
+
"filter"
|
|
2003
|
+
],
|
|
2004
|
+
"returnType": "object[]"
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"name": "SendClassification.Update",
|
|
2008
|
+
"url": "/core-library/sendclassification/",
|
|
2009
|
+
"section": "Core Library",
|
|
2010
|
+
"type": "method",
|
|
2011
|
+
"description": "Updates the send classification with the supplied attributes.",
|
|
2012
|
+
"params": [
|
|
2013
|
+
"properties"
|
|
2014
|
+
],
|
|
2015
|
+
"returnType": "string"
|
|
2016
|
+
},
|
|
2017
|
+
{
|
|
2018
|
+
"name": "SendClassification.Remove",
|
|
2019
|
+
"url": "/core-library/sendclassification/",
|
|
2020
|
+
"section": "Core Library",
|
|
2021
|
+
"type": "method",
|
|
2022
|
+
"description": "Removes the previously initialized send classification.",
|
|
2023
|
+
"returnType": "string"
|
|
2024
|
+
},
|
|
2025
|
+
{
|
|
2026
|
+
"name": "QueryDefinition.Init",
|
|
2027
|
+
"url": "/core-library/querydefinition/",
|
|
2028
|
+
"section": "Core Library",
|
|
2029
|
+
"type": "method",
|
|
2030
|
+
"description": "Initializes a QueryDefinition instance bound to the specified external key.",
|
|
2031
|
+
"params": [
|
|
2032
|
+
"key"
|
|
2033
|
+
],
|
|
2034
|
+
"returnType": "QueryDefinitionInstance"
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"name": "QueryDefinition.Add",
|
|
2038
|
+
"url": "/core-library/querydefinition/",
|
|
2039
|
+
"section": "Core Library",
|
|
2040
|
+
"type": "method",
|
|
2041
|
+
"description": "Creates a new query definition from the supplied properties.",
|
|
2042
|
+
"params": [
|
|
2043
|
+
"properties"
|
|
2044
|
+
],
|
|
2045
|
+
"returnType": "string"
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"name": "QueryDefinition.Retrieve",
|
|
2049
|
+
"url": "/core-library/querydefinition/",
|
|
2050
|
+
"section": "Core Library",
|
|
2051
|
+
"type": "method",
|
|
2052
|
+
"description": "Returns an array of query definitions matching the specified filter.",
|
|
2053
|
+
"params": [
|
|
2054
|
+
"filter"
|
|
2055
|
+
],
|
|
2056
|
+
"returnType": "object[]"
|
|
2057
|
+
},
|
|
2058
|
+
{
|
|
2059
|
+
"name": "QueryDefinition.Update",
|
|
2060
|
+
"url": "/core-library/querydefinition/",
|
|
2061
|
+
"section": "Core Library",
|
|
2062
|
+
"type": "method",
|
|
2063
|
+
"description": "Updates the query definition with the supplied attributes.",
|
|
2064
|
+
"params": [
|
|
2065
|
+
"properties"
|
|
2066
|
+
],
|
|
2067
|
+
"returnType": "string"
|
|
2068
|
+
},
|
|
2069
|
+
{
|
|
2070
|
+
"name": "QueryDefinition.Remove",
|
|
2071
|
+
"url": "/core-library/querydefinition/",
|
|
2072
|
+
"section": "Core Library",
|
|
2073
|
+
"type": "method",
|
|
2074
|
+
"description": "Removes the previously initialized query definition.",
|
|
2075
|
+
"returnType": "string"
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"name": "QueryDefinition.Perform",
|
|
2079
|
+
"url": "/core-library/querydefinition/",
|
|
2080
|
+
"section": "Core Library",
|
|
2081
|
+
"type": "method",
|
|
2082
|
+
"description": "Executes the query definition.",
|
|
2083
|
+
"params": [
|
|
2084
|
+
"action"
|
|
2085
|
+
],
|
|
2086
|
+
"returnType": "string"
|
|
2087
|
+
},
|
|
2088
|
+
{
|
|
2089
|
+
"name": "Send.Init",
|
|
2090
|
+
"url": "/core-library/send/",
|
|
2091
|
+
"section": "Core Library",
|
|
2092
|
+
"type": "method",
|
|
2093
|
+
"description": "Initializes a Send instance bound to the specified send ID.",
|
|
2094
|
+
"params": [
|
|
2095
|
+
"id"
|
|
2096
|
+
],
|
|
2097
|
+
"returnType": "SendInstance"
|
|
2098
|
+
},
|
|
2099
|
+
{
|
|
2100
|
+
"name": "Send.Add",
|
|
2101
|
+
"url": "/core-library/send/",
|
|
2102
|
+
"section": "Core Library",
|
|
2103
|
+
"type": "method",
|
|
2104
|
+
"description": "Creates a new send to the specified email and list(s).",
|
|
2105
|
+
"params": [
|
|
2106
|
+
"emailKey",
|
|
2107
|
+
"listIds",
|
|
2108
|
+
"options"
|
|
2109
|
+
],
|
|
2110
|
+
"returnType": "string"
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"name": "Send.Retrieve",
|
|
2114
|
+
"url": "/core-library/send/",
|
|
2115
|
+
"section": "Core Library",
|
|
2116
|
+
"type": "method",
|
|
2117
|
+
"description": "Returns an array of sends matching the specified filter.",
|
|
2118
|
+
"params": [
|
|
2119
|
+
"filter"
|
|
2120
|
+
],
|
|
2121
|
+
"returnType": "object[]"
|
|
2122
|
+
},
|
|
2123
|
+
{
|
|
2124
|
+
"name": "Send.RetrieveLists",
|
|
2125
|
+
"url": "/core-library/send/",
|
|
2126
|
+
"section": "Core Library",
|
|
2127
|
+
"type": "method",
|
|
2128
|
+
"description": "Returns information about the lists targeted by a send.",
|
|
2129
|
+
"params": [
|
|
2130
|
+
"filter"
|
|
2131
|
+
],
|
|
2132
|
+
"returnType": "object[]"
|
|
2133
|
+
},
|
|
2134
|
+
{
|
|
2135
|
+
"name": "Send.Remove",
|
|
2136
|
+
"url": "/core-library/send/",
|
|
2137
|
+
"section": "Core Library",
|
|
2138
|
+
"type": "method",
|
|
2139
|
+
"description": "Removes the previously initialized send.",
|
|
2140
|
+
"returnType": "string"
|
|
2141
|
+
},
|
|
2142
|
+
{
|
|
2143
|
+
"name": "Send.CancelSend",
|
|
2144
|
+
"url": "/core-library/send/",
|
|
2145
|
+
"section": "Core Library",
|
|
2146
|
+
"type": "method",
|
|
2147
|
+
"description": "Attempts to cancel the previously initialized send.",
|
|
2148
|
+
"returnType": "string"
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"name": "Send.Tracking.Retrieve",
|
|
2152
|
+
"url": "/core-library/send/",
|
|
2153
|
+
"section": "Core Library",
|
|
2154
|
+
"type": "method",
|
|
2155
|
+
"description": "Returns tracking data for sends matching the filter.",
|
|
2156
|
+
"params": [
|
|
2157
|
+
"filter"
|
|
2158
|
+
],
|
|
2159
|
+
"returnType": "object[]"
|
|
2160
|
+
},
|
|
2161
|
+
{
|
|
2162
|
+
"name": "Send.Tracking.ClickRetrieve",
|
|
2163
|
+
"url": "/core-library/send/",
|
|
2164
|
+
"section": "Core Library",
|
|
2165
|
+
"type": "method",
|
|
2166
|
+
"description": "Returns click tracking data for the previously initialized send.",
|
|
2167
|
+
"params": [
|
|
2168
|
+
"filter"
|
|
2169
|
+
],
|
|
2170
|
+
"returnType": "object[]"
|
|
2171
|
+
},
|
|
2172
|
+
{
|
|
2173
|
+
"name": "Send.Tracking.TotalByIntervalRetrieve",
|
|
2174
|
+
"url": "/core-library/send/",
|
|
2175
|
+
"section": "Core Library",
|
|
2176
|
+
"type": "method",
|
|
2177
|
+
"description": "Returns aggregated tracking data for the previously initialized send.",
|
|
2178
|
+
"params": [
|
|
2179
|
+
"type",
|
|
2180
|
+
"startDate",
|
|
2181
|
+
"endDate",
|
|
2182
|
+
"groupBy"
|
|
2183
|
+
],
|
|
2184
|
+
"returnType": "object[]"
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"name": "Send.Definition.Init",
|
|
2188
|
+
"url": "/core-library/senddefinition/",
|
|
2189
|
+
"section": "Core Library",
|
|
2190
|
+
"type": "method",
|
|
2191
|
+
"description": "Initializes a SendDefinition instance bound to the specified external key.",
|
|
2192
|
+
"params": [
|
|
2193
|
+
"key"
|
|
2194
|
+
],
|
|
2195
|
+
"returnType": "SendDefinitionInstance"
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
"name": "Send.Definition.Add",
|
|
2199
|
+
"url": "/core-library/senddefinition/",
|
|
2200
|
+
"section": "Core Library",
|
|
2201
|
+
"type": "method",
|
|
2202
|
+
"description": "Creates a new send definition.",
|
|
2203
|
+
"params": [
|
|
2204
|
+
"esdParams",
|
|
2205
|
+
"sendClassificationKey",
|
|
2206
|
+
"emailKey",
|
|
2207
|
+
"listIds"
|
|
2208
|
+
],
|
|
2209
|
+
"returnType": "string"
|
|
2210
|
+
},
|
|
2211
|
+
{
|
|
2212
|
+
"name": "Send.Definition.AddWithDE",
|
|
2213
|
+
"url": "/core-library/senddefinition/",
|
|
2214
|
+
"section": "Core Library",
|
|
2215
|
+
"type": "method",
|
|
2216
|
+
"description": "Creates a new send definition that targets a sendable Data Extension.",
|
|
2217
|
+
"params": [
|
|
2218
|
+
"esdParams",
|
|
2219
|
+
"sendClassificationKey",
|
|
2220
|
+
"emailKey",
|
|
2221
|
+
"sendableDataExtensionKey",
|
|
2222
|
+
"publicationListKey"
|
|
2223
|
+
],
|
|
2224
|
+
"returnType": "string"
|
|
2225
|
+
},
|
|
2226
|
+
{
|
|
2227
|
+
"name": "Send.Definition.AddWithFilterDefinition",
|
|
2228
|
+
"url": "/core-library/senddefinition/",
|
|
2229
|
+
"section": "Core Library",
|
|
2230
|
+
"type": "method",
|
|
2231
|
+
"description": "Creates a new send definition that targets the audience defined by a filter definition.",
|
|
2232
|
+
"params": [
|
|
2233
|
+
"esdParams",
|
|
2234
|
+
"sendClassificationKey",
|
|
2235
|
+
"emailKey",
|
|
2236
|
+
"filterDefinitionKey",
|
|
2237
|
+
"listId"
|
|
2238
|
+
],
|
|
2239
|
+
"returnType": "string"
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"name": "Send.Definition.Retrieve",
|
|
2243
|
+
"url": "/core-library/senddefinition/",
|
|
2244
|
+
"section": "Core Library",
|
|
2245
|
+
"type": "method",
|
|
2246
|
+
"description": "Returns an array of send definitions, optionally filtered.",
|
|
2247
|
+
"params": [
|
|
2248
|
+
"filter"
|
|
2249
|
+
],
|
|
2250
|
+
"returnType": "object[]"
|
|
2251
|
+
},
|
|
2252
|
+
{
|
|
2253
|
+
"name": "Send.Definition.Update",
|
|
2254
|
+
"url": "/core-library/senddefinition/",
|
|
2255
|
+
"section": "Core Library",
|
|
2256
|
+
"type": "method",
|
|
2257
|
+
"description": "Updates the previously initialized send definition.",
|
|
2258
|
+
"params": [
|
|
2259
|
+
"properties"
|
|
2260
|
+
],
|
|
2261
|
+
"returnType": "string"
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
"name": "Send.Definition.Remove",
|
|
2265
|
+
"url": "/core-library/senddefinition/",
|
|
2266
|
+
"section": "Core Library",
|
|
2267
|
+
"type": "method",
|
|
2268
|
+
"description": "Deletes the previously initialized send definition.",
|
|
2269
|
+
"returnType": "string"
|
|
2270
|
+
},
|
|
2271
|
+
{
|
|
2272
|
+
"name": "Send.Definition.Send",
|
|
2273
|
+
"url": "/core-library/senddefinition/",
|
|
2274
|
+
"section": "Core Library",
|
|
2275
|
+
"type": "method",
|
|
2276
|
+
"description": "Sends email messages to the lists associated with the previously initialized send definition.",
|
|
2277
|
+
"returnType": "string"
|
|
2278
|
+
},
|
|
2279
|
+
{
|
|
2280
|
+
"name": "TriggeredSend.Init",
|
|
2281
|
+
"url": "/core-library/triggeredsend/",
|
|
2282
|
+
"section": "Core Library",
|
|
2283
|
+
"type": "method",
|
|
2284
|
+
"description": "Initializes a TriggeredSend instance bound to the specified external key.",
|
|
2285
|
+
"params": [
|
|
2286
|
+
"key"
|
|
2287
|
+
],
|
|
2288
|
+
"returnType": "TriggeredSendInstance"
|
|
2289
|
+
},
|
|
2290
|
+
{
|
|
2291
|
+
"name": "TriggeredSend.Add",
|
|
2292
|
+
"url": "/core-library/triggeredsend/",
|
|
2293
|
+
"section": "Core Library",
|
|
2294
|
+
"type": "method",
|
|
2295
|
+
"description": "Creates a new triggered send definition from the supplied properties and returns an initialized TriggeredSend instance.",
|
|
2296
|
+
"params": [
|
|
2297
|
+
"properties"
|
|
2298
|
+
],
|
|
2299
|
+
"returnType": "TriggeredSendInstance"
|
|
2300
|
+
},
|
|
2301
|
+
{
|
|
2302
|
+
"name": "TriggeredSend.Retrieve",
|
|
2303
|
+
"url": "/core-library/triggeredsend/",
|
|
2304
|
+
"section": "Core Library",
|
|
2305
|
+
"type": "method",
|
|
2306
|
+
"description": "Returns an array of triggered send definitions matching the specified filter.",
|
|
2307
|
+
"params": [
|
|
2308
|
+
"filter"
|
|
2309
|
+
],
|
|
2310
|
+
"returnType": "object[]"
|
|
2311
|
+
},
|
|
2312
|
+
{
|
|
2313
|
+
"name": "TriggeredSend.Update",
|
|
2314
|
+
"url": "/core-library/triggeredsend/",
|
|
2315
|
+
"section": "Core Library",
|
|
2316
|
+
"type": "method",
|
|
2317
|
+
"description": "Updates the previously initialized triggered send definition.",
|
|
2318
|
+
"params": [
|
|
2319
|
+
"properties"
|
|
2320
|
+
],
|
|
2321
|
+
"returnType": "string"
|
|
2322
|
+
},
|
|
2323
|
+
{
|
|
2324
|
+
"name": "TriggeredSend.Start",
|
|
2325
|
+
"url": "/core-library/triggeredsend/",
|
|
2326
|
+
"section": "Core Library",
|
|
2327
|
+
"type": "method",
|
|
2328
|
+
"description": "Starts (reactivates) a paused triggered send definition.",
|
|
2329
|
+
"returnType": "string"
|
|
2330
|
+
},
|
|
2331
|
+
{
|
|
2332
|
+
"name": "TriggeredSend.Pause",
|
|
2333
|
+
"url": "/core-library/triggeredsend/",
|
|
2334
|
+
"section": "Core Library",
|
|
2335
|
+
"type": "method",
|
|
2336
|
+
"description": "Pauses an active triggered send definition.",
|
|
2337
|
+
"returnType": "string"
|
|
2338
|
+
},
|
|
2339
|
+
{
|
|
2340
|
+
"name": "TriggeredSend.Publish",
|
|
2341
|
+
"url": "/core-library/triggeredsend/",
|
|
2342
|
+
"section": "Core Library",
|
|
2343
|
+
"type": "method",
|
|
2344
|
+
"description": "Publishes a triggered send definition, making it active and ready to accept sends.",
|
|
2345
|
+
"returnType": "string"
|
|
2346
|
+
},
|
|
2347
|
+
{
|
|
2348
|
+
"name": "TriggeredSend.Send",
|
|
2349
|
+
"url": "/core-library/triggeredsend/",
|
|
2350
|
+
"section": "Core Library",
|
|
2351
|
+
"type": "method",
|
|
2352
|
+
"description": "Sends an email using the previously initialized triggered send definition.",
|
|
2353
|
+
"params": [
|
|
2354
|
+
"emailAddress",
|
|
2355
|
+
"sendTimeAttributes"
|
|
2356
|
+
],
|
|
2357
|
+
"returnType": "string"
|
|
2358
|
+
},
|
|
2359
|
+
{
|
|
2360
|
+
"name": "TriggeredSend.Tracking.Retrieve",
|
|
2361
|
+
"url": "/core-library/triggeredsend/",
|
|
2362
|
+
"section": "Core Library",
|
|
2363
|
+
"type": "method",
|
|
2364
|
+
"description": "Returns tracking data for the previously initialized triggered send definition.",
|
|
2365
|
+
"params": [
|
|
2366
|
+
"filter"
|
|
2367
|
+
],
|
|
2368
|
+
"returnType": "object[]"
|
|
2369
|
+
},
|
|
2370
|
+
{
|
|
2371
|
+
"name": "TriggeredSend.Tracking.Clicks.Retrieve",
|
|
2372
|
+
"url": "/core-library/triggeredsend/",
|
|
2373
|
+
"section": "Core Library",
|
|
2374
|
+
"type": "method",
|
|
2375
|
+
"description": "Returns click tracking information for the previously initialized triggered send definition.",
|
|
2376
|
+
"params": [
|
|
2377
|
+
"filter"
|
|
2378
|
+
],
|
|
2379
|
+
"returnType": "object[]"
|
|
2380
|
+
},
|
|
2381
|
+
{
|
|
2382
|
+
"name": "TriggeredSend.Tracking.TotalByInterval.Retrieve",
|
|
2383
|
+
"url": "/core-library/triggeredsend/",
|
|
2384
|
+
"section": "Core Library",
|
|
2385
|
+
"type": "method",
|
|
2386
|
+
"description": "Returns aggregated tracking data for the previously initialized triggered send.",
|
|
2387
|
+
"params": [
|
|
2388
|
+
"type",
|
|
2389
|
+
"startDate",
|
|
2390
|
+
"endDate",
|
|
2391
|
+
"groupBy"
|
|
2392
|
+
],
|
|
2393
|
+
"returnType": "object[]"
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
"name": "Tracking.Retrieve",
|
|
2397
|
+
"url": "/core-library/events/",
|
|
2398
|
+
"section": "Core Library",
|
|
2399
|
+
"type": "method",
|
|
2400
|
+
"description": "Retrieves bounce event data for message sends matching the specified filter.",
|
|
2401
|
+
"params": [
|
|
2402
|
+
"filter"
|
|
2403
|
+
],
|
|
2404
|
+
"returnType": "object[]"
|
|
2405
|
+
},
|
|
2406
|
+
{
|
|
2407
|
+
"name": "Tracking.Retrieve",
|
|
2408
|
+
"url": "/core-library/events/",
|
|
2409
|
+
"section": "Core Library",
|
|
2410
|
+
"type": "method",
|
|
2411
|
+
"description": "Retrieves click tracking event data for message sends matching the specified filter.",
|
|
2412
|
+
"params": [
|
|
2413
|
+
"filter"
|
|
2414
|
+
],
|
|
2415
|
+
"returnType": "object[]"
|
|
2416
|
+
},
|
|
2417
|
+
{
|
|
2418
|
+
"name": "Tracking.Retrieve",
|
|
2419
|
+
"url": "/core-library/events/",
|
|
2420
|
+
"section": "Core Library",
|
|
2421
|
+
"type": "method",
|
|
2422
|
+
"description": "Retrieves forwarded email event data for message sends matching the specified filter.",
|
|
2423
|
+
"params": [
|
|
2424
|
+
"filter"
|
|
2425
|
+
],
|
|
2426
|
+
"returnType": "object[]"
|
|
2427
|
+
},
|
|
2428
|
+
{
|
|
2429
|
+
"name": "Tracking.Retrieve",
|
|
2430
|
+
"url": "/core-library/events/",
|
|
2431
|
+
"section": "Core Library",
|
|
2432
|
+
"type": "method",
|
|
2433
|
+
"description": "Retrieves forwarded email opt-in event data for message sends matching the specified filter.",
|
|
2434
|
+
"params": [
|
|
2435
|
+
"filter"
|
|
2436
|
+
],
|
|
2437
|
+
"returnType": "object[]"
|
|
2438
|
+
},
|
|
2439
|
+
{
|
|
2440
|
+
"name": "Tracking.Retrieve",
|
|
2441
|
+
"url": "/core-library/events/",
|
|
2442
|
+
"section": "Core Library",
|
|
2443
|
+
"type": "method",
|
|
2444
|
+
"description": "Retrieves not-sent event data for message sends matching the specified filter.",
|
|
2445
|
+
"params": [
|
|
2446
|
+
"filter"
|
|
2447
|
+
],
|
|
2448
|
+
"returnType": "object[]"
|
|
2449
|
+
},
|
|
2450
|
+
{
|
|
2451
|
+
"name": "Tracking.Retrieve",
|
|
2452
|
+
"url": "/core-library/events/",
|
|
2453
|
+
"section": "Core Library",
|
|
2454
|
+
"type": "method",
|
|
2455
|
+
"description": "Retrieves open tracking event data for message sends matching the specified filter.",
|
|
2456
|
+
"params": [
|
|
2457
|
+
"filter"
|
|
2458
|
+
],
|
|
2459
|
+
"returnType": "object[]"
|
|
2460
|
+
},
|
|
2461
|
+
{
|
|
2462
|
+
"name": "Tracking.Retrieve",
|
|
2463
|
+
"url": "/core-library/events/",
|
|
2464
|
+
"section": "Core Library",
|
|
2465
|
+
"type": "method",
|
|
2466
|
+
"description": "Retrieves sent event data for message sends matching the specified filter.",
|
|
2467
|
+
"params": [
|
|
2468
|
+
"filter"
|
|
2469
|
+
],
|
|
2470
|
+
"returnType": "object[]"
|
|
2471
|
+
},
|
|
2472
|
+
{
|
|
2473
|
+
"name": "Tracking.Retrieve",
|
|
2474
|
+
"url": "/core-library/events/",
|
|
2475
|
+
"section": "Core Library",
|
|
2476
|
+
"type": "method",
|
|
2477
|
+
"description": "Retrieves survey response event data for message sends matching the specified filter.",
|
|
2478
|
+
"params": [
|
|
2479
|
+
"filter"
|
|
2480
|
+
],
|
|
2481
|
+
"returnType": "object[]"
|
|
2482
|
+
},
|
|
2483
|
+
{
|
|
2484
|
+
"name": "Tracking.Retrieve",
|
|
2485
|
+
"url": "/core-library/events/",
|
|
2486
|
+
"section": "Core Library",
|
|
2487
|
+
"type": "method",
|
|
2488
|
+
"description": "Retrieves unsubscribe event data for message sends matching the specified filter.",
|
|
2489
|
+
"params": [
|
|
2490
|
+
"filter"
|
|
2491
|
+
],
|
|
2492
|
+
"returnType": "object[]"
|
|
2493
|
+
},
|
|
2494
|
+
{
|
|
2495
|
+
"name": "ContentAreaObj.Init",
|
|
2496
|
+
"url": "/core-library/contentareaobj/",
|
|
2497
|
+
"section": "Core Library",
|
|
2498
|
+
"type": "method",
|
|
2499
|
+
"description": "Initializes a ContentAreaObj instance bound to the specified external key.",
|
|
2500
|
+
"params": [
|
|
2501
|
+
"key"
|
|
2502
|
+
],
|
|
2503
|
+
"returnType": "ContentAreaObjInstance",
|
|
2504
|
+
"deprecated": true
|
|
2505
|
+
},
|
|
2506
|
+
{
|
|
2507
|
+
"name": "ContentAreaObj.Add",
|
|
2508
|
+
"url": "/core-library/contentareaobj/",
|
|
2509
|
+
"section": "Core Library",
|
|
2510
|
+
"type": "method",
|
|
2511
|
+
"description": "Creates a new content area from the supplied properties.",
|
|
2512
|
+
"params": [
|
|
2513
|
+
"properties"
|
|
2514
|
+
],
|
|
2515
|
+
"returnType": "string",
|
|
2516
|
+
"deprecated": true
|
|
2517
|
+
},
|
|
2518
|
+
{
|
|
2519
|
+
"name": "ContentAreaObj.Retrieve",
|
|
2520
|
+
"url": "/core-library/contentareaobj/",
|
|
2521
|
+
"section": "Core Library",
|
|
2522
|
+
"type": "method",
|
|
2523
|
+
"description": "Returns an array of content areas matching the specified filter.",
|
|
2524
|
+
"params": [
|
|
2525
|
+
"filter"
|
|
2526
|
+
],
|
|
2527
|
+
"returnType": "object[]",
|
|
2528
|
+
"deprecated": true
|
|
2529
|
+
},
|
|
2530
|
+
{
|
|
2531
|
+
"name": "ContentAreaObj.Update",
|
|
2532
|
+
"url": "/core-library/contentareaobj/",
|
|
2533
|
+
"section": "Core Library",
|
|
2534
|
+
"type": "method",
|
|
2535
|
+
"description": "Updates the content area with the supplied attributes.",
|
|
2536
|
+
"params": [
|
|
2537
|
+
"properties"
|
|
2538
|
+
],
|
|
2539
|
+
"returnType": "string",
|
|
2540
|
+
"deprecated": true
|
|
2541
|
+
},
|
|
2542
|
+
{
|
|
2543
|
+
"name": "ContentAreaObj.Remove",
|
|
2544
|
+
"url": "/core-library/contentareaobj/",
|
|
2545
|
+
"section": "Core Library",
|
|
2546
|
+
"type": "method",
|
|
2547
|
+
"description": "Removes the previously initialized content area.",
|
|
2548
|
+
"returnType": "string",
|
|
2549
|
+
"deprecated": true
|
|
2550
|
+
},
|
|
2551
|
+
{
|
|
2552
|
+
"name": "Portfolio.Init",
|
|
2553
|
+
"url": "/core-library/portfolio/",
|
|
2554
|
+
"section": "Core Library",
|
|
2555
|
+
"type": "method",
|
|
2556
|
+
"description": "Initializes a Portfolio instance bound to the specified external key.",
|
|
2557
|
+
"params": [
|
|
2558
|
+
"key"
|
|
2559
|
+
],
|
|
2560
|
+
"returnType": "PortfolioInstance"
|
|
2561
|
+
},
|
|
2562
|
+
{
|
|
2563
|
+
"name": "Portfolio.Add",
|
|
2564
|
+
"url": "/core-library/portfolio/",
|
|
2565
|
+
"section": "Core Library",
|
|
2566
|
+
"type": "method",
|
|
2567
|
+
"description": "Creates a new portfolio (file) object from the supplied properties.",
|
|
2568
|
+
"params": [
|
|
2569
|
+
"properties"
|
|
2570
|
+
],
|
|
2571
|
+
"returnType": "string"
|
|
2572
|
+
},
|
|
2573
|
+
{
|
|
2574
|
+
"name": "Portfolio.Retrieve",
|
|
2575
|
+
"url": "/core-library/portfolio/",
|
|
2576
|
+
"section": "Core Library",
|
|
2577
|
+
"type": "method",
|
|
2578
|
+
"description": "Returns an array of portfolio objects matching the specified filter.",
|
|
2579
|
+
"params": [
|
|
2580
|
+
"filter"
|
|
2581
|
+
],
|
|
2582
|
+
"returnType": "object[]"
|
|
2583
|
+
},
|
|
2584
|
+
{
|
|
2585
|
+
"name": "Portfolio.Update",
|
|
2586
|
+
"url": "/core-library/portfolio/",
|
|
2587
|
+
"section": "Core Library",
|
|
2588
|
+
"type": "method",
|
|
2589
|
+
"description": "Updates the portfolio object with the supplied attributes.",
|
|
2590
|
+
"params": [
|
|
2591
|
+
"properties"
|
|
2592
|
+
],
|
|
2593
|
+
"returnType": "string"
|
|
2594
|
+
},
|
|
2595
|
+
{
|
|
2596
|
+
"name": "Portfolio.Remove",
|
|
2597
|
+
"url": "/core-library/portfolio/",
|
|
2598
|
+
"section": "Core Library",
|
|
2599
|
+
"type": "method",
|
|
2600
|
+
"description": "Removes the previously initialized portfolio object.",
|
|
2601
|
+
"returnType": "string"
|
|
2602
|
+
},
|
|
2603
|
+
{
|
|
2604
|
+
"name": "DataExtension",
|
|
2605
|
+
"url": "/core-library/dataextension/",
|
|
2606
|
+
"section": "Core Library",
|
|
2607
|
+
"type": "object",
|
|
2608
|
+
"description": "Manages Data Extension definitions and their field schemas."
|
|
2609
|
+
},
|
|
2610
|
+
{
|
|
2611
|
+
"name": "DataExtension.Fields",
|
|
2612
|
+
"url": "/core-library/dataextension-fields/",
|
|
2613
|
+
"section": "Core Library",
|
|
2614
|
+
"type": "object",
|
|
2615
|
+
"description": "Accesses and manages field definitions within a Data Extension."
|
|
2616
|
+
},
|
|
2617
|
+
{
|
|
2618
|
+
"name": "DataExtension.Rows",
|
|
2619
|
+
"url": "/core-library/dataextension-rows/",
|
|
2620
|
+
"section": "Core Library",
|
|
2621
|
+
"type": "object",
|
|
2622
|
+
"description": "Manages individual rows within a Data Extension."
|
|
2623
|
+
},
|
|
2624
|
+
{
|
|
2625
|
+
"name": "Subscriber",
|
|
2626
|
+
"url": "/core-library/subscriber/",
|
|
2627
|
+
"section": "Core Library",
|
|
2628
|
+
"type": "object",
|
|
2629
|
+
"description": "Manages subscriber records in the account."
|
|
2630
|
+
},
|
|
2631
|
+
{
|
|
2632
|
+
"name": "Subscriber.Attributes",
|
|
2633
|
+
"url": "/core-library/subscriber/",
|
|
2634
|
+
"section": "Core Library",
|
|
2635
|
+
"type": "object",
|
|
2636
|
+
"description": "Accesses attributes belonging to a specific subscriber."
|
|
2637
|
+
},
|
|
2638
|
+
{
|
|
2639
|
+
"name": "Subscriber.Lists",
|
|
2640
|
+
"url": "/core-library/subscriber/",
|
|
2641
|
+
"section": "Core Library",
|
|
2642
|
+
"type": "object",
|
|
2643
|
+
"description": "Lists the subscriber lists a specific subscriber belongs to."
|
|
2644
|
+
},
|
|
2645
|
+
{
|
|
2646
|
+
"name": "Email",
|
|
2647
|
+
"url": "/core-library/email/",
|
|
2648
|
+
"section": "Core Library",
|
|
2649
|
+
"type": "object",
|
|
2650
|
+
"description": "Manages email message definitions."
|
|
2651
|
+
},
|
|
2652
|
+
{
|
|
2653
|
+
"name": "TriggeredSend",
|
|
2654
|
+
"url": "/core-library/triggeredsend/",
|
|
2655
|
+
"section": "Core Library",
|
|
2656
|
+
"type": "object",
|
|
2657
|
+
"description": "Manages triggered send definitions and fires individual sends."
|
|
2658
|
+
},
|
|
2659
|
+
{
|
|
2660
|
+
"name": "TriggeredSend.Tracking",
|
|
2661
|
+
"url": "/core-library/triggeredsend/",
|
|
2662
|
+
"section": "Core Library",
|
|
2663
|
+
"type": "object",
|
|
2664
|
+
"description": "Retrieves tracking data for a specific triggered send."
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
"name": "TriggeredSend.Tracking.Clicks",
|
|
2668
|
+
"url": "/core-library/triggeredsend/",
|
|
2669
|
+
"section": "Core Library",
|
|
2670
|
+
"type": "object",
|
|
2671
|
+
"description": "Retrieves click tracking data for a specific triggered send."
|
|
2672
|
+
},
|
|
2673
|
+
{
|
|
2674
|
+
"name": "TriggeredSend.Tracking.TotalByInterval",
|
|
2675
|
+
"url": "/core-library/triggeredsend/",
|
|
2676
|
+
"section": "Core Library",
|
|
2677
|
+
"type": "object",
|
|
2678
|
+
"description": "Returns aggregated tracking data for a triggered send by type and interval."
|
|
2679
|
+
},
|
|
2680
|
+
{
|
|
2681
|
+
"name": "List",
|
|
2682
|
+
"url": "/core-library/list/",
|
|
2683
|
+
"section": "Core Library",
|
|
2684
|
+
"type": "object",
|
|
2685
|
+
"description": "Manages subscriber lists."
|
|
2686
|
+
},
|
|
2687
|
+
{
|
|
2688
|
+
"name": "List.Subscribers",
|
|
2689
|
+
"url": "/core-library/list-subscribers/",
|
|
2690
|
+
"section": "Core Library",
|
|
2691
|
+
"type": "object",
|
|
2692
|
+
"description": "Manages the subscribers belonging to a specific list."
|
|
2693
|
+
},
|
|
2694
|
+
{
|
|
2695
|
+
"name": "List.Subscribers.Tracking",
|
|
2696
|
+
"url": "/core-library/list-subscribers/",
|
|
2697
|
+
"section": "Core Library",
|
|
2698
|
+
"type": "object",
|
|
2699
|
+
"description": "Retrieves tracking data for subscribers on a specific list."
|
|
2700
|
+
},
|
|
2701
|
+
{
|
|
2702
|
+
"name": "ContentAreaObj",
|
|
2703
|
+
"url": "/core-library/contentareaobj/",
|
|
2704
|
+
"section": "Core Library",
|
|
2705
|
+
"type": "object",
|
|
2706
|
+
"description": "Manages classic content area objects."
|
|
2707
|
+
},
|
|
2708
|
+
{
|
|
2709
|
+
"name": "Folder",
|
|
2710
|
+
"url": "/core-library/folder/",
|
|
2711
|
+
"section": "Core Library",
|
|
2712
|
+
"type": "object",
|
|
2713
|
+
"description": "Manages folder structures within the Marketing Cloud account."
|
|
2714
|
+
},
|
|
2715
|
+
{
|
|
2716
|
+
"name": "QueryDefinition",
|
|
2717
|
+
"url": "/core-library/querydefinition/",
|
|
2718
|
+
"section": "Core Library",
|
|
2719
|
+
"type": "object",
|
|
2720
|
+
"description": "Manages SQL query activity definitions."
|
|
2721
|
+
},
|
|
2722
|
+
{
|
|
2723
|
+
"name": "Send",
|
|
2724
|
+
"url": "/core-library/send/",
|
|
2725
|
+
"section": "Core Library",
|
|
2726
|
+
"type": "object",
|
|
2727
|
+
"description": "Manages email sends."
|
|
2728
|
+
},
|
|
2729
|
+
{
|
|
2730
|
+
"name": "Send.Tracking",
|
|
2731
|
+
"url": "/core-library/send/",
|
|
2732
|
+
"section": "Core Library",
|
|
2733
|
+
"type": "object",
|
|
2734
|
+
"description": "Retrieves tracking data for a specific send."
|
|
2735
|
+
},
|
|
2736
|
+
{
|
|
2737
|
+
"name": "Send.Definition",
|
|
2738
|
+
"url": "/core-library/senddefinition/",
|
|
2739
|
+
"section": "Core Library",
|
|
2740
|
+
"type": "object",
|
|
2741
|
+
"description": "Manages reusable Send Definition configurations that define all parameters for a send including content, audience, and delivery settings."
|
|
2742
|
+
},
|
|
2743
|
+
{
|
|
2744
|
+
"name": "Template",
|
|
2745
|
+
"url": "/core-library/template/",
|
|
2746
|
+
"section": "Core Library",
|
|
2747
|
+
"type": "object",
|
|
2748
|
+
"description": "Manages email template definitions."
|
|
2749
|
+
},
|
|
2750
|
+
{
|
|
2751
|
+
"name": "DeliveryProfile",
|
|
2752
|
+
"url": "/core-library/deliveryprofile/",
|
|
2753
|
+
"section": "Core Library",
|
|
2754
|
+
"type": "object",
|
|
2755
|
+
"description": "Manages delivery profile configurations."
|
|
2756
|
+
},
|
|
2757
|
+
{
|
|
2758
|
+
"name": "SenderProfile",
|
|
2759
|
+
"url": "/core-library/senderprofile/",
|
|
2760
|
+
"section": "Core Library",
|
|
2761
|
+
"type": "object",
|
|
2762
|
+
"description": "Manages sender profile definitions."
|
|
2763
|
+
},
|
|
2764
|
+
{
|
|
2765
|
+
"name": "SendClassification",
|
|
2766
|
+
"url": "/core-library/sendclassification/",
|
|
2767
|
+
"section": "Core Library",
|
|
2768
|
+
"type": "object",
|
|
2769
|
+
"description": "Manages send classification settings."
|
|
2770
|
+
},
|
|
2771
|
+
{
|
|
2772
|
+
"name": "FilterDefinition",
|
|
2773
|
+
"url": "/core-library/filterdefinition/",
|
|
2774
|
+
"section": "Core Library",
|
|
2775
|
+
"type": "object",
|
|
2776
|
+
"description": "Manages data filter definitions."
|
|
2777
|
+
},
|
|
2778
|
+
{
|
|
2779
|
+
"name": "Account",
|
|
2780
|
+
"url": "/core-library/account/",
|
|
2781
|
+
"section": "Core Library",
|
|
2782
|
+
"type": "object",
|
|
2783
|
+
"description": "Manages Marketing Cloud account settings."
|
|
2784
|
+
},
|
|
2785
|
+
{
|
|
2786
|
+
"name": "AccountUser",
|
|
2787
|
+
"url": "/core-library/accountuser/",
|
|
2788
|
+
"section": "Core Library",
|
|
2789
|
+
"type": "object",
|
|
2790
|
+
"description": "Manages user accounts within the Marketing Cloud business unit."
|
|
2791
|
+
},
|
|
2792
|
+
{
|
|
2793
|
+
"name": "Account.Tracking",
|
|
2794
|
+
"url": "/core-library/account/",
|
|
2795
|
+
"section": "Core Library",
|
|
2796
|
+
"type": "object",
|
|
2797
|
+
"description": "Retrieves tracking data associated with account-level sends."
|
|
2798
|
+
},
|
|
2799
|
+
{
|
|
2800
|
+
"name": "Portfolio",
|
|
2801
|
+
"url": "/core-library/portfolio/",
|
|
2802
|
+
"section": "Core Library",
|
|
2803
|
+
"type": "object",
|
|
2804
|
+
"description": "Manages portfolio (file) items in the account."
|
|
2805
|
+
},
|
|
2806
|
+
{
|
|
2807
|
+
"name": "BounceEvent",
|
|
2808
|
+
"url": "/core-library/events/",
|
|
2809
|
+
"section": "Core Library",
|
|
2810
|
+
"type": "object",
|
|
2811
|
+
"description": "Retrieves bounce event data for message sends."
|
|
2812
|
+
},
|
|
2813
|
+
{
|
|
2814
|
+
"name": "ClickEvent",
|
|
2815
|
+
"url": "/core-library/events/",
|
|
2816
|
+
"section": "Core Library",
|
|
2817
|
+
"type": "object",
|
|
2818
|
+
"description": "Retrieves click tracking event data for message sends."
|
|
2819
|
+
},
|
|
2820
|
+
{
|
|
2821
|
+
"name": "ForwardedEmailEvent",
|
|
2822
|
+
"url": "/core-library/events/",
|
|
2823
|
+
"section": "Core Library",
|
|
2824
|
+
"type": "object",
|
|
2825
|
+
"description": "Retrieves forwarded email event data for message sends."
|
|
2826
|
+
},
|
|
2827
|
+
{
|
|
2828
|
+
"name": "ForwardedEmailOptInEvent",
|
|
2829
|
+
"url": "/core-library/events/",
|
|
2830
|
+
"section": "Core Library",
|
|
2831
|
+
"type": "object",
|
|
2832
|
+
"description": "Retrieves forwarded email opt-in event data for message sends."
|
|
2833
|
+
},
|
|
2834
|
+
{
|
|
2835
|
+
"name": "NotSentEvent",
|
|
2836
|
+
"url": "/core-library/events/",
|
|
2837
|
+
"section": "Core Library",
|
|
2838
|
+
"type": "object",
|
|
2839
|
+
"description": "Retrieves not-sent event data for message sends."
|
|
2840
|
+
},
|
|
2841
|
+
{
|
|
2842
|
+
"name": "OpenEvent",
|
|
2843
|
+
"url": "/core-library/events/",
|
|
2844
|
+
"section": "Core Library",
|
|
2845
|
+
"type": "object",
|
|
2846
|
+
"description": "Retrieves open tracking event data for message sends."
|
|
2847
|
+
},
|
|
2848
|
+
{
|
|
2849
|
+
"name": "SentEvent",
|
|
2850
|
+
"url": "/core-library/events/",
|
|
2851
|
+
"section": "Core Library",
|
|
2852
|
+
"type": "object",
|
|
2853
|
+
"description": "Retrieves sent event data for message sends."
|
|
2854
|
+
},
|
|
2855
|
+
{
|
|
2856
|
+
"name": "SurveyEvent",
|
|
2857
|
+
"url": "/core-library/events/",
|
|
2858
|
+
"section": "Core Library",
|
|
2859
|
+
"type": "object",
|
|
2860
|
+
"description": "Retrieves survey response event data for message sends."
|
|
2861
|
+
},
|
|
2862
|
+
{
|
|
2863
|
+
"name": "UnsubEvent",
|
|
2864
|
+
"url": "/core-library/events/",
|
|
2865
|
+
"section": "Core Library",
|
|
2866
|
+
"type": "object",
|
|
2867
|
+
"description": "Retrieves unsubscribe event data for message sends."
|
|
2868
|
+
},
|
|
2869
|
+
{
|
|
2870
|
+
"name": "DateTime.TimeZone",
|
|
2871
|
+
"url": "/platform-objects/datetime-timezone/",
|
|
2872
|
+
"section": "Core Library",
|
|
2873
|
+
"type": "object",
|
|
2874
|
+
"description": "Time zone utilities for SSJS date/time conversions."
|
|
2875
|
+
},
|
|
2876
|
+
{
|
|
2877
|
+
"name": "Array.join",
|
|
2878
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2879
|
+
"section": "ECMAScript Builtins",
|
|
2880
|
+
"type": "method",
|
|
2881
|
+
"description": "Joins all array elements into a string, separated by the specified delimiter.",
|
|
2882
|
+
"params": [
|
|
2883
|
+
"separator"
|
|
2884
|
+
],
|
|
2885
|
+
"returnType": "string"
|
|
2886
|
+
},
|
|
2887
|
+
{
|
|
2888
|
+
"name": "Array.push",
|
|
2889
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2890
|
+
"section": "ECMAScript Builtins",
|
|
2891
|
+
"type": "method",
|
|
2892
|
+
"description": "Appends one or more elements to the end of an array and returns the new length.",
|
|
2893
|
+
"params": [
|
|
2894
|
+
"element"
|
|
2895
|
+
],
|
|
2896
|
+
"returnType": "number"
|
|
2897
|
+
},
|
|
2898
|
+
{
|
|
2899
|
+
"name": "Array.pop",
|
|
2900
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2901
|
+
"section": "ECMAScript Builtins",
|
|
2902
|
+
"type": "method",
|
|
2903
|
+
"description": "Removes and returns the last element from an array.",
|
|
2904
|
+
"returnType": "any"
|
|
2905
|
+
},
|
|
2906
|
+
{
|
|
2907
|
+
"name": "Array.shift",
|
|
2908
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2909
|
+
"section": "ECMAScript Builtins",
|
|
2910
|
+
"type": "method",
|
|
2911
|
+
"description": "Removes and returns the first element from an array.",
|
|
2912
|
+
"returnType": "any"
|
|
2913
|
+
},
|
|
2914
|
+
{
|
|
2915
|
+
"name": "Array.unshift",
|
|
2916
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2917
|
+
"section": "ECMAScript Builtins",
|
|
2918
|
+
"type": "method",
|
|
2919
|
+
"description": "Inserts one or more elements at the start of an array and returns the new length.",
|
|
2920
|
+
"params": [
|
|
2921
|
+
"element"
|
|
2922
|
+
],
|
|
2923
|
+
"returnType": "number"
|
|
2924
|
+
},
|
|
2925
|
+
{
|
|
2926
|
+
"name": "Array.concat",
|
|
2927
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2928
|
+
"section": "ECMAScript Builtins",
|
|
2929
|
+
"type": "method",
|
|
2930
|
+
"description": "Returns a new array formed by merging this array with other arrays or values.",
|
|
2931
|
+
"params": [
|
|
2932
|
+
"value"
|
|
2933
|
+
],
|
|
2934
|
+
"returnType": "array"
|
|
2935
|
+
},
|
|
2936
|
+
{
|
|
2937
|
+
"name": "Array.slice",
|
|
2938
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2939
|
+
"section": "ECMAScript Builtins",
|
|
2940
|
+
"type": "method",
|
|
2941
|
+
"description": "Returns a shallow copy of a portion of an array.",
|
|
2942
|
+
"params": [
|
|
2943
|
+
"start",
|
|
2944
|
+
"end"
|
|
2945
|
+
],
|
|
2946
|
+
"returnType": "array"
|
|
2947
|
+
},
|
|
2948
|
+
{
|
|
2949
|
+
"name": "Array.sort",
|
|
2950
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2951
|
+
"section": "ECMAScript Builtins",
|
|
2952
|
+
"type": "method",
|
|
2953
|
+
"description": "Sorts the array in place and returns it.",
|
|
2954
|
+
"params": [
|
|
2955
|
+
"compareFn"
|
|
2956
|
+
],
|
|
2957
|
+
"returnType": "array"
|
|
2958
|
+
},
|
|
2959
|
+
{
|
|
2960
|
+
"name": "Array.reverse",
|
|
2961
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2962
|
+
"section": "ECMAScript Builtins",
|
|
2963
|
+
"type": "method",
|
|
2964
|
+
"description": "Reverses the elements of an array in place.",
|
|
2965
|
+
"returnType": "array"
|
|
2966
|
+
},
|
|
2967
|
+
{
|
|
2968
|
+
"name": "Array.splice",
|
|
2969
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2970
|
+
"section": "ECMAScript Builtins",
|
|
2971
|
+
"type": "method",
|
|
2972
|
+
"description": "Removes or replaces elements and optionally inserts new ones in place.",
|
|
2973
|
+
"params": [
|
|
2974
|
+
"start",
|
|
2975
|
+
"deleteCount",
|
|
2976
|
+
"item"
|
|
2977
|
+
],
|
|
2978
|
+
"returnType": "array"
|
|
2979
|
+
},
|
|
2980
|
+
{
|
|
2981
|
+
"name": "Array.length",
|
|
2982
|
+
"url": "/ecmascript-builtins/array-methods/",
|
|
2983
|
+
"section": "ECMAScript Builtins",
|
|
2984
|
+
"type": "method",
|
|
2985
|
+
"description": "Returns the number of elements in the array.",
|
|
2986
|
+
"returnType": "number"
|
|
2987
|
+
},
|
|
2988
|
+
{
|
|
2989
|
+
"name": "String.charAt",
|
|
2990
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
2991
|
+
"section": "ECMAScript Builtins",
|
|
2992
|
+
"type": "method",
|
|
2993
|
+
"description": "Returns the character at the specified index.",
|
|
2994
|
+
"params": [
|
|
2995
|
+
"index"
|
|
2996
|
+
],
|
|
2997
|
+
"returnType": "string"
|
|
2998
|
+
},
|
|
2999
|
+
{
|
|
3000
|
+
"name": "String.charCodeAt",
|
|
3001
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3002
|
+
"section": "ECMAScript Builtins",
|
|
3003
|
+
"type": "method",
|
|
3004
|
+
"description": "Returns the UTF-16 code unit at the specified index.",
|
|
3005
|
+
"params": [
|
|
3006
|
+
"index"
|
|
3007
|
+
],
|
|
3008
|
+
"returnType": "number"
|
|
3009
|
+
},
|
|
3010
|
+
{
|
|
3011
|
+
"name": "String.indexOf",
|
|
3012
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3013
|
+
"section": "ECMAScript Builtins",
|
|
3014
|
+
"type": "method",
|
|
3015
|
+
"description": "Returns the index of the first occurrence of a substring, or -1 if not found.",
|
|
3016
|
+
"params": [
|
|
3017
|
+
"searchValue",
|
|
3018
|
+
"fromIndex"
|
|
3019
|
+
],
|
|
3020
|
+
"returnType": "number"
|
|
3021
|
+
},
|
|
3022
|
+
{
|
|
3023
|
+
"name": "String.lastIndexOf",
|
|
3024
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3025
|
+
"section": "ECMAScript Builtins",
|
|
3026
|
+
"type": "method",
|
|
3027
|
+
"description": "Returns the index of the last occurrence of a substring, or -1 if not found.",
|
|
3028
|
+
"params": [
|
|
3029
|
+
"searchValue",
|
|
3030
|
+
"fromIndex"
|
|
3031
|
+
],
|
|
3032
|
+
"returnType": "number"
|
|
3033
|
+
},
|
|
3034
|
+
{
|
|
3035
|
+
"name": "String.match",
|
|
3036
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3037
|
+
"section": "ECMAScript Builtins",
|
|
3038
|
+
"type": "method",
|
|
3039
|
+
"description": "Matches a string against a regular expression and returns the matches array.",
|
|
3040
|
+
"params": [
|
|
3041
|
+
"regexp"
|
|
3042
|
+
],
|
|
3043
|
+
"returnType": "array"
|
|
3044
|
+
},
|
|
3045
|
+
{
|
|
3046
|
+
"name": "String.replace",
|
|
3047
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3048
|
+
"section": "ECMAScript Builtins",
|
|
3049
|
+
"type": "method",
|
|
3050
|
+
"description": "Returns a new string with matches replaced by a replacement string or function.",
|
|
3051
|
+
"params": [
|
|
3052
|
+
"searchValue",
|
|
3053
|
+
"replaceValue"
|
|
3054
|
+
],
|
|
3055
|
+
"returnType": "string"
|
|
3056
|
+
},
|
|
3057
|
+
{
|
|
3058
|
+
"name": "String.search",
|
|
3059
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3060
|
+
"section": "ECMAScript Builtins",
|
|
3061
|
+
"type": "method",
|
|
3062
|
+
"description": "Searches for a match and returns the index of the first match, or -1.",
|
|
3063
|
+
"params": [
|
|
3064
|
+
"regexp"
|
|
3065
|
+
],
|
|
3066
|
+
"returnType": "number"
|
|
3067
|
+
},
|
|
3068
|
+
{
|
|
3069
|
+
"name": "String.slice",
|
|
3070
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3071
|
+
"section": "ECMAScript Builtins",
|
|
3072
|
+
"type": "method",
|
|
3073
|
+
"description": "Extracts a section of a string and returns it as a new string.",
|
|
3074
|
+
"params": [
|
|
3075
|
+
"start",
|
|
3076
|
+
"end"
|
|
3077
|
+
],
|
|
3078
|
+
"returnType": "string"
|
|
3079
|
+
},
|
|
3080
|
+
{
|
|
3081
|
+
"name": "String.split",
|
|
3082
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3083
|
+
"section": "ECMAScript Builtins",
|
|
3084
|
+
"type": "method",
|
|
3085
|
+
"description": "Splits a string into an array of substrings using a separator.",
|
|
3086
|
+
"params": [
|
|
3087
|
+
"separator",
|
|
3088
|
+
"limit"
|
|
3089
|
+
],
|
|
3090
|
+
"returnType": "array"
|
|
3091
|
+
},
|
|
3092
|
+
{
|
|
3093
|
+
"name": "String.substring",
|
|
3094
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3095
|
+
"section": "ECMAScript Builtins",
|
|
3096
|
+
"type": "method",
|
|
3097
|
+
"description": "Returns the characters between two indices of a string.",
|
|
3098
|
+
"params": [
|
|
3099
|
+
"start",
|
|
3100
|
+
"end"
|
|
3101
|
+
],
|
|
3102
|
+
"returnType": "string"
|
|
3103
|
+
},
|
|
3104
|
+
{
|
|
3105
|
+
"name": "String.toLowerCase",
|
|
3106
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3107
|
+
"section": "ECMAScript Builtins",
|
|
3108
|
+
"type": "method",
|
|
3109
|
+
"description": "Returns the string converted to lowercase.",
|
|
3110
|
+
"returnType": "string"
|
|
3111
|
+
},
|
|
3112
|
+
{
|
|
3113
|
+
"name": "String.toUpperCase",
|
|
3114
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3115
|
+
"section": "ECMAScript Builtins",
|
|
3116
|
+
"type": "method",
|
|
3117
|
+
"description": "Returns the string converted to uppercase.",
|
|
3118
|
+
"returnType": "string"
|
|
3119
|
+
},
|
|
3120
|
+
{
|
|
3121
|
+
"name": "String.concat",
|
|
3122
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3123
|
+
"section": "ECMAScript Builtins",
|
|
3124
|
+
"type": "method",
|
|
3125
|
+
"description": "Returns a new string formed by concatenating this string with one or more additional strings.",
|
|
3126
|
+
"params": [
|
|
3127
|
+
"string"
|
|
3128
|
+
],
|
|
3129
|
+
"returnType": "string"
|
|
3130
|
+
},
|
|
3131
|
+
{
|
|
3132
|
+
"name": "String.substr",
|
|
3133
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3134
|
+
"section": "ECMAScript Builtins",
|
|
3135
|
+
"type": "method",
|
|
3136
|
+
"description": "Returns a substring starting at start and running for length characters.",
|
|
3137
|
+
"params": [
|
|
3138
|
+
"start",
|
|
3139
|
+
"length"
|
|
3140
|
+
],
|
|
3141
|
+
"returnType": "string"
|
|
3142
|
+
},
|
|
3143
|
+
{
|
|
3144
|
+
"name": "String.length",
|
|
3145
|
+
"url": "/ecmascript-builtins/string-methods/",
|
|
3146
|
+
"section": "ECMAScript Builtins",
|
|
3147
|
+
"type": "method",
|
|
3148
|
+
"description": "Returns the number of characters in the string.",
|
|
3149
|
+
"returnType": "number"
|
|
3150
|
+
},
|
|
3151
|
+
{
|
|
3152
|
+
"name": "Math.abs",
|
|
3153
|
+
"url": "/ecmascript-builtins/math/",
|
|
3154
|
+
"section": "ECMAScript Builtins",
|
|
3155
|
+
"type": "method",
|
|
3156
|
+
"description": "Returns the absolute value of a number.",
|
|
3157
|
+
"params": [
|
|
3158
|
+
"x"
|
|
3159
|
+
],
|
|
3160
|
+
"returnType": "number"
|
|
3161
|
+
},
|
|
3162
|
+
{
|
|
3163
|
+
"name": "Math.ceil",
|
|
3164
|
+
"url": "/ecmascript-builtins/math/",
|
|
3165
|
+
"section": "ECMAScript Builtins",
|
|
3166
|
+
"type": "method",
|
|
3167
|
+
"description": "Rounds a number up to the next integer.",
|
|
3168
|
+
"params": [
|
|
3169
|
+
"x"
|
|
3170
|
+
],
|
|
3171
|
+
"returnType": "number"
|
|
3172
|
+
},
|
|
3173
|
+
{
|
|
3174
|
+
"name": "Math.floor",
|
|
3175
|
+
"url": "/ecmascript-builtins/math/",
|
|
3176
|
+
"section": "ECMAScript Builtins",
|
|
3177
|
+
"type": "method",
|
|
3178
|
+
"description": "Rounds a number down to the nearest integer.",
|
|
3179
|
+
"params": [
|
|
3180
|
+
"x"
|
|
3181
|
+
],
|
|
3182
|
+
"returnType": "number"
|
|
3183
|
+
},
|
|
3184
|
+
{
|
|
3185
|
+
"name": "Math.max",
|
|
3186
|
+
"url": "/ecmascript-builtins/math/",
|
|
3187
|
+
"section": "ECMAScript Builtins",
|
|
3188
|
+
"type": "method",
|
|
3189
|
+
"description": "Returns the largest of the supplied numbers.",
|
|
3190
|
+
"params": [
|
|
3191
|
+
"values"
|
|
3192
|
+
],
|
|
3193
|
+
"returnType": "number"
|
|
3194
|
+
},
|
|
3195
|
+
{
|
|
3196
|
+
"name": "Math.min",
|
|
3197
|
+
"url": "/ecmascript-builtins/math/",
|
|
3198
|
+
"section": "ECMAScript Builtins",
|
|
3199
|
+
"type": "method",
|
|
3200
|
+
"description": "Returns the smallest of the supplied numbers.",
|
|
3201
|
+
"params": [
|
|
3202
|
+
"values"
|
|
3203
|
+
],
|
|
3204
|
+
"returnType": "number"
|
|
3205
|
+
},
|
|
3206
|
+
{
|
|
3207
|
+
"name": "Math.pow",
|
|
3208
|
+
"url": "/ecmascript-builtins/math/",
|
|
3209
|
+
"section": "ECMAScript Builtins",
|
|
3210
|
+
"type": "method",
|
|
3211
|
+
"description": "Returns the base raised to the exponent power.",
|
|
3212
|
+
"params": [
|
|
3213
|
+
"base",
|
|
3214
|
+
"exponent"
|
|
3215
|
+
],
|
|
3216
|
+
"returnType": "number"
|
|
3217
|
+
},
|
|
3218
|
+
{
|
|
3219
|
+
"name": "Math.random",
|
|
3220
|
+
"url": "/ecmascript-builtins/math/",
|
|
3221
|
+
"section": "ECMAScript Builtins",
|
|
3222
|
+
"type": "method",
|
|
3223
|
+
"description": "Returns a pseudo-random floating-point number in [0, 1).",
|
|
3224
|
+
"returnType": "number"
|
|
3225
|
+
},
|
|
3226
|
+
{
|
|
3227
|
+
"name": "Math.round",
|
|
3228
|
+
"url": "/ecmascript-builtins/math/",
|
|
3229
|
+
"section": "ECMAScript Builtins",
|
|
3230
|
+
"type": "method",
|
|
3231
|
+
"description": "Rounds a number to the nearest integer.",
|
|
3232
|
+
"params": [
|
|
3233
|
+
"x"
|
|
3234
|
+
],
|
|
3235
|
+
"returnType": "number"
|
|
3236
|
+
},
|
|
3237
|
+
{
|
|
3238
|
+
"name": "Math.sqrt",
|
|
3239
|
+
"url": "/ecmascript-builtins/math/",
|
|
3240
|
+
"section": "ECMAScript Builtins",
|
|
3241
|
+
"type": "method",
|
|
3242
|
+
"description": "Returns the square root of a number.",
|
|
3243
|
+
"params": [
|
|
3244
|
+
"x"
|
|
3245
|
+
],
|
|
3246
|
+
"returnType": "number"
|
|
3247
|
+
},
|
|
3248
|
+
{
|
|
3249
|
+
"name": "Math.sin",
|
|
3250
|
+
"url": "/ecmascript-builtins/math/",
|
|
3251
|
+
"section": "ECMAScript Builtins",
|
|
3252
|
+
"type": "method",
|
|
3253
|
+
"description": "Returns the sine of an angle given in radians.",
|
|
3254
|
+
"params": [
|
|
3255
|
+
"x"
|
|
3256
|
+
],
|
|
3257
|
+
"returnType": "number"
|
|
3258
|
+
},
|
|
3259
|
+
{
|
|
3260
|
+
"name": "Math.cos",
|
|
3261
|
+
"url": "/ecmascript-builtins/math/",
|
|
3262
|
+
"section": "ECMAScript Builtins",
|
|
3263
|
+
"type": "method",
|
|
3264
|
+
"description": "Returns the cosine of an angle given in radians.",
|
|
3265
|
+
"params": [
|
|
3266
|
+
"x"
|
|
3267
|
+
],
|
|
3268
|
+
"returnType": "number"
|
|
3269
|
+
},
|
|
3270
|
+
{
|
|
3271
|
+
"name": "Math.tan",
|
|
3272
|
+
"url": "/ecmascript-builtins/math/",
|
|
3273
|
+
"section": "ECMAScript Builtins",
|
|
3274
|
+
"type": "method",
|
|
3275
|
+
"description": "Returns the tangent of an angle given in radians.",
|
|
3276
|
+
"params": [
|
|
3277
|
+
"x"
|
|
3278
|
+
],
|
|
3279
|
+
"returnType": "number"
|
|
3280
|
+
},
|
|
3281
|
+
{
|
|
3282
|
+
"name": "Math.asin",
|
|
3283
|
+
"url": "/ecmascript-builtins/math/",
|
|
3284
|
+
"section": "ECMAScript Builtins",
|
|
3285
|
+
"type": "method",
|
|
3286
|
+
"description": "Returns the arc sine (in radians) of a number in the range [-1, 1].",
|
|
3287
|
+
"params": [
|
|
3288
|
+
"x"
|
|
3289
|
+
],
|
|
3290
|
+
"returnType": "number"
|
|
3291
|
+
},
|
|
3292
|
+
{
|
|
3293
|
+
"name": "Math.acos",
|
|
3294
|
+
"url": "/ecmascript-builtins/math/",
|
|
3295
|
+
"section": "ECMAScript Builtins",
|
|
3296
|
+
"type": "method",
|
|
3297
|
+
"description": "Returns the arc cosine (in radians) of a number in the range [-1, 1].",
|
|
3298
|
+
"params": [
|
|
3299
|
+
"x"
|
|
3300
|
+
],
|
|
3301
|
+
"returnType": "number"
|
|
3302
|
+
},
|
|
3303
|
+
{
|
|
3304
|
+
"name": "Math.atan",
|
|
3305
|
+
"url": "/ecmascript-builtins/math/",
|
|
3306
|
+
"section": "ECMAScript Builtins",
|
|
3307
|
+
"type": "method",
|
|
3308
|
+
"description": "Returns the arc tangent (in radians) of a number.",
|
|
3309
|
+
"params": [
|
|
3310
|
+
"x"
|
|
3311
|
+
],
|
|
3312
|
+
"returnType": "number"
|
|
3313
|
+
},
|
|
3314
|
+
{
|
|
3315
|
+
"name": "Math.atan2",
|
|
3316
|
+
"url": "/ecmascript-builtins/math/",
|
|
3317
|
+
"section": "ECMAScript Builtins",
|
|
3318
|
+
"type": "method",
|
|
3319
|
+
"description": "Returns the angle (in radians) from the positive x-axis to the point (x, y).",
|
|
3320
|
+
"params": [
|
|
3321
|
+
"y",
|
|
3322
|
+
"x"
|
|
3323
|
+
],
|
|
3324
|
+
"returnType": "number"
|
|
3325
|
+
},
|
|
3326
|
+
{
|
|
3327
|
+
"name": "Math.exp",
|
|
3328
|
+
"url": "/ecmascript-builtins/math/",
|
|
3329
|
+
"section": "ECMAScript Builtins",
|
|
3330
|
+
"type": "method",
|
|
3331
|
+
"description": "Returns e raised to the power of x (e^x).",
|
|
3332
|
+
"params": [
|
|
3333
|
+
"x"
|
|
3334
|
+
],
|
|
3335
|
+
"returnType": "number"
|
|
3336
|
+
},
|
|
3337
|
+
{
|
|
3338
|
+
"name": "Math.log",
|
|
3339
|
+
"url": "/ecmascript-builtins/math/",
|
|
3340
|
+
"section": "ECMAScript Builtins",
|
|
3341
|
+
"type": "method",
|
|
3342
|
+
"description": "Returns the natural logarithm (base e) of a number.",
|
|
3343
|
+
"params": [
|
|
3344
|
+
"x"
|
|
3345
|
+
],
|
|
3346
|
+
"returnType": "number"
|
|
3347
|
+
},
|
|
3348
|
+
{
|
|
3349
|
+
"name": "Math.PI",
|
|
3350
|
+
"url": "/ecmascript-builtins/math/",
|
|
3351
|
+
"section": "ECMAScript Builtins",
|
|
3352
|
+
"type": "method",
|
|
3353
|
+
"description": "The ratio of a circle's circumference to its diameter (~3.",
|
|
3354
|
+
"returnType": "number"
|
|
3355
|
+
},
|
|
3356
|
+
{
|
|
3357
|
+
"name": "Math.E",
|
|
3358
|
+
"url": "/ecmascript-builtins/math/",
|
|
3359
|
+
"section": "ECMAScript Builtins",
|
|
3360
|
+
"type": "method",
|
|
3361
|
+
"description": "Euler's number, the base of the natural logarithm (~2.",
|
|
3362
|
+
"returnType": "number"
|
|
3363
|
+
},
|
|
3364
|
+
{
|
|
3365
|
+
"name": "Math.LN2",
|
|
3366
|
+
"url": "/ecmascript-builtins/math/",
|
|
3367
|
+
"section": "ECMAScript Builtins",
|
|
3368
|
+
"type": "method",
|
|
3369
|
+
"description": "The natural logarithm of 2 (~0.",
|
|
3370
|
+
"returnType": "number"
|
|
3371
|
+
},
|
|
3372
|
+
{
|
|
3373
|
+
"name": "Math.LN10",
|
|
3374
|
+
"url": "/ecmascript-builtins/math/",
|
|
3375
|
+
"section": "ECMAScript Builtins",
|
|
3376
|
+
"type": "method",
|
|
3377
|
+
"description": "The natural logarithm of 10 (~2.",
|
|
3378
|
+
"returnType": "number"
|
|
3379
|
+
},
|
|
3380
|
+
{
|
|
3381
|
+
"name": "Math.LOG2E",
|
|
3382
|
+
"url": "/ecmascript-builtins/math/",
|
|
3383
|
+
"section": "ECMAScript Builtins",
|
|
3384
|
+
"type": "method",
|
|
3385
|
+
"description": "The base-2 logarithm of e (~1.",
|
|
3386
|
+
"returnType": "number"
|
|
3387
|
+
},
|
|
3388
|
+
{
|
|
3389
|
+
"name": "Math.LOG10E",
|
|
3390
|
+
"url": "/ecmascript-builtins/math/",
|
|
3391
|
+
"section": "ECMAScript Builtins",
|
|
3392
|
+
"type": "method",
|
|
3393
|
+
"description": "The base-10 logarithm of e (~0.",
|
|
3394
|
+
"returnType": "number"
|
|
3395
|
+
},
|
|
3396
|
+
{
|
|
3397
|
+
"name": "Math.SQRT2",
|
|
3398
|
+
"url": "/ecmascript-builtins/math/",
|
|
3399
|
+
"section": "ECMAScript Builtins",
|
|
3400
|
+
"type": "method",
|
|
3401
|
+
"description": "The square root of 2 (~1.",
|
|
3402
|
+
"returnType": "number"
|
|
3403
|
+
},
|
|
3404
|
+
{
|
|
3405
|
+
"name": "Math.SQRT1_2",
|
|
3406
|
+
"url": "/ecmascript-builtins/math/",
|
|
3407
|
+
"section": "ECMAScript Builtins",
|
|
3408
|
+
"type": "method",
|
|
3409
|
+
"description": "The square root of 1/2 (~0.",
|
|
3410
|
+
"returnType": "number"
|
|
3411
|
+
},
|
|
3412
|
+
{
|
|
3413
|
+
"name": "Number.toFixed",
|
|
3414
|
+
"url": "/ecmascript-builtins/number-methods/",
|
|
3415
|
+
"section": "ECMAScript Builtins",
|
|
3416
|
+
"type": "method",
|
|
3417
|
+
"description": "Returns a string representing the number in fixed-point notation with the given number of decimal places.",
|
|
3418
|
+
"params": [
|
|
3419
|
+
"fractionDigits"
|
|
3420
|
+
],
|
|
3421
|
+
"returnType": "string"
|
|
3422
|
+
},
|
|
3423
|
+
{
|
|
3424
|
+
"name": "Number.toExponential",
|
|
3425
|
+
"url": "/ecmascript-builtins/number-methods/",
|
|
3426
|
+
"section": "ECMAScript Builtins",
|
|
3427
|
+
"type": "method",
|
|
3428
|
+
"description": "Returns a string representing the number in exponential notation.",
|
|
3429
|
+
"params": [
|
|
3430
|
+
"fractionDigits"
|
|
3431
|
+
],
|
|
3432
|
+
"returnType": "string"
|
|
3433
|
+
},
|
|
3434
|
+
{
|
|
3435
|
+
"name": "Number.toPrecision",
|
|
3436
|
+
"url": "/ecmascript-builtins/number-methods/",
|
|
3437
|
+
"section": "ECMAScript Builtins",
|
|
3438
|
+
"type": "method",
|
|
3439
|
+
"description": "Returns a string representing the number to the specified number of significant digits.",
|
|
3440
|
+
"params": [
|
|
3441
|
+
"precision"
|
|
3442
|
+
],
|
|
3443
|
+
"returnType": "string"
|
|
3444
|
+
},
|
|
3445
|
+
{
|
|
3446
|
+
"name": "Object.hasOwnProperty",
|
|
3447
|
+
"url": "/ecmascript-builtins/object-methods/",
|
|
3448
|
+
"section": "ECMAScript Builtins",
|
|
3449
|
+
"type": "method",
|
|
3450
|
+
"description": "Returns true if the object has the specified property as its own (not inherited) property.",
|
|
3451
|
+
"params": [
|
|
3452
|
+
"v"
|
|
3453
|
+
],
|
|
3454
|
+
"returnType": "boolean"
|
|
3455
|
+
},
|
|
3456
|
+
{
|
|
3457
|
+
"name": "String",
|
|
3458
|
+
"url": "/global-functions/string/",
|
|
3459
|
+
"section": "Global Functions",
|
|
3460
|
+
"type": "function",
|
|
3461
|
+
"description": "Native JavaScript function that converts any value to its string representation.",
|
|
3462
|
+
"params": [
|
|
3463
|
+
"value"
|
|
3464
|
+
],
|
|
3465
|
+
"returnType": "string"
|
|
3466
|
+
},
|
|
3467
|
+
{
|
|
3468
|
+
"name": "Error",
|
|
3469
|
+
"url": "/global-functions/error/",
|
|
3470
|
+
"section": "Global Functions",
|
|
3471
|
+
"type": "function",
|
|
3472
|
+
"description": "Native JavaScript Error constructor.",
|
|
3473
|
+
"params": [
|
|
3474
|
+
"message"
|
|
3475
|
+
],
|
|
3476
|
+
"returnType": "object"
|
|
3477
|
+
},
|
|
3478
|
+
{
|
|
3479
|
+
"name": "Base64Encode",
|
|
3480
|
+
"url": "/global-functions/base64encode/",
|
|
3481
|
+
"section": "Global Functions",
|
|
3482
|
+
"type": "function",
|
|
3483
|
+
"description": "Encodes plain text to a Base64 encoded string.",
|
|
3484
|
+
"params": [
|
|
3485
|
+
"string"
|
|
3486
|
+
],
|
|
3487
|
+
"returnType": "string"
|
|
3488
|
+
},
|
|
3489
|
+
{
|
|
3490
|
+
"name": "Base64Decode",
|
|
3491
|
+
"url": "/global-functions/base64decode/",
|
|
3492
|
+
"section": "Global Functions",
|
|
3493
|
+
"type": "function",
|
|
3494
|
+
"description": "Decodes a Base64 encoded string to plain text.",
|
|
3495
|
+
"params": [
|
|
3496
|
+
"encodedString"
|
|
3497
|
+
],
|
|
3498
|
+
"returnType": "string"
|
|
3499
|
+
},
|
|
3500
|
+
{
|
|
3501
|
+
"name": "Format",
|
|
3502
|
+
"url": "/global-functions/format/",
|
|
3503
|
+
"section": "Global Functions",
|
|
3504
|
+
"type": "function",
|
|
3505
|
+
"description": "Applies a formatting rule to a string or numeric value.",
|
|
3506
|
+
"params": [
|
|
3507
|
+
"textToFormat",
|
|
3508
|
+
"formatCode"
|
|
3509
|
+
],
|
|
3510
|
+
"returnType": "string"
|
|
3511
|
+
}
|
|
3512
|
+
]
|