@pushwoosh/rpc-v2-http-api-data 0.2.502 → 0.2.504
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/data.js +321 -3
- package/package.json +1 -1
- package/presets.d.ts +20 -0
- package/pushwoosh_channels_messagingApi_v2.d.ts +170 -6
package/data.js
CHANGED
|
@@ -9896,6 +9896,12 @@ export const data = {
|
|
|
9896
9896
|
"method": "post",
|
|
9897
9897
|
"path": "/messaging/v2/update"
|
|
9898
9898
|
},
|
|
9899
|
+
"Rename": {
|
|
9900
|
+
"request": "pushwoosh.channels.messagingApi.v2.RenameRequest",
|
|
9901
|
+
"response": "pushwoosh.channels.messagingApi.v2.RenameResponse",
|
|
9902
|
+
"method": "post",
|
|
9903
|
+
"path": "/messaging/v2/rename"
|
|
9904
|
+
},
|
|
9899
9905
|
"Delete": {
|
|
9900
9906
|
"request": "pushwoosh.channels.messagingApi.v2.DeleteRequest",
|
|
9901
9907
|
"response": "pushwoosh.channels.messagingApi.v2.DeleteResponse",
|
|
@@ -10046,6 +10052,21 @@ export const data = {
|
|
|
10046
10052
|
}
|
|
10047
10053
|
}
|
|
10048
10054
|
},
|
|
10055
|
+
"pushwoosh.channels.messagingApi.v2.RenameRequest": {
|
|
10056
|
+
"type": "I",
|
|
10057
|
+
"fields": {
|
|
10058
|
+
"messageCode": {
|
|
10059
|
+
"type": "string"
|
|
10060
|
+
},
|
|
10061
|
+
"campaignName": {
|
|
10062
|
+
"type": "string"
|
|
10063
|
+
}
|
|
10064
|
+
}
|
|
10065
|
+
},
|
|
10066
|
+
"pushwoosh.channels.messagingApi.v2.RenameResponse": {
|
|
10067
|
+
"type": "I",
|
|
10068
|
+
"fields": {}
|
|
10069
|
+
},
|
|
10049
10070
|
"pushwoosh.channels.messagingApi.v2.DeleteRequest": {
|
|
10050
10071
|
"type": "I",
|
|
10051
10072
|
"fields": {
|
|
@@ -10063,7 +10084,17 @@ export const data = {
|
|
|
10063
10084
|
"values": [
|
|
10064
10085
|
"MESSAGE_TYPE_UNSPECIFIED",
|
|
10065
10086
|
"MESSAGE_TYPE_MARKETING",
|
|
10066
|
-
"MESSAGE_TYPE_TRANSACTIONAL"
|
|
10087
|
+
"MESSAGE_TYPE_TRANSACTIONAL",
|
|
10088
|
+
"MESSAGE_TYPE_FUNCTIONAL"
|
|
10089
|
+
]
|
|
10090
|
+
},
|
|
10091
|
+
"pushwoosh.channels.messagingApi.v2.MessageTypeSource": {
|
|
10092
|
+
"type": "E",
|
|
10093
|
+
"values": [
|
|
10094
|
+
"MESSAGE_TYPE_SOURCE_UNSPECIFIED",
|
|
10095
|
+
"MESSAGE_TYPE_SOURCE_CLIENT",
|
|
10096
|
+
"MESSAGE_TYPE_SOURCE_DEFAULT",
|
|
10097
|
+
"MESSAGE_TYPE_SOURCE_APP_DEFAULT"
|
|
10067
10098
|
]
|
|
10068
10099
|
},
|
|
10069
10100
|
"pushwoosh.channels.messagingApi.v2.RegistrationType": {
|
|
@@ -10136,6 +10167,9 @@ export const data = {
|
|
|
10136
10167
|
"appInboxPayload": {
|
|
10137
10168
|
"type": "pushwoosh.channels.messagingApi.v2.AppInboxPayload"
|
|
10138
10169
|
},
|
|
10170
|
+
"inAppPayload": {
|
|
10171
|
+
"type": "pushwoosh.channels.messagingApi.v2.InAppPayload"
|
|
10172
|
+
},
|
|
10139
10173
|
"frequencyCapping": {
|
|
10140
10174
|
"type": "pushwoosh.channels.messagingApi.v2.FrequencyCapping"
|
|
10141
10175
|
},
|
|
@@ -10163,6 +10197,21 @@ export const data = {
|
|
|
10163
10197
|
},
|
|
10164
10198
|
"holdoutPercentage": {
|
|
10165
10199
|
"type": "number"
|
|
10200
|
+
},
|
|
10201
|
+
"campaignName": {
|
|
10202
|
+
"type": "string"
|
|
10203
|
+
},
|
|
10204
|
+
"messageTypeSource": {
|
|
10205
|
+
"type": "pushwoosh.channels.messagingApi.v2.MessageTypeSource"
|
|
10206
|
+
},
|
|
10207
|
+
"contentPlaceholders": {
|
|
10208
|
+
"type": "object"
|
|
10209
|
+
},
|
|
10210
|
+
"resend": {
|
|
10211
|
+
"type": "pushwoosh.channels.messagingApi.v2.Resend"
|
|
10212
|
+
},
|
|
10213
|
+
"geoZone": {
|
|
10214
|
+
"type": "pushwoosh.channels.messagingApi.v2.GeoZone"
|
|
10166
10215
|
}
|
|
10167
10216
|
},
|
|
10168
10217
|
"oneofs": {
|
|
@@ -10178,11 +10227,26 @@ export const data = {
|
|
|
10178
10227
|
"payload",
|
|
10179
10228
|
"emailPayload",
|
|
10180
10229
|
"smsPayload",
|
|
10181
|
-
"appInboxPayload"
|
|
10230
|
+
"appInboxPayload",
|
|
10231
|
+
"inAppPayload"
|
|
10182
10232
|
]
|
|
10183
10233
|
}
|
|
10184
10234
|
}
|
|
10185
10235
|
},
|
|
10236
|
+
"pushwoosh.channels.messagingApi.v2.GeoZone": {
|
|
10237
|
+
"type": "I",
|
|
10238
|
+
"fields": {
|
|
10239
|
+
"lat": {
|
|
10240
|
+
"type": "number"
|
|
10241
|
+
},
|
|
10242
|
+
"lng": {
|
|
10243
|
+
"type": "number"
|
|
10244
|
+
},
|
|
10245
|
+
"range": {
|
|
10246
|
+
"type": "number"
|
|
10247
|
+
}
|
|
10248
|
+
}
|
|
10249
|
+
},
|
|
10186
10250
|
"pushwoosh.channels.messagingApi.v2.NotifyTransactional.HwidsList": {
|
|
10187
10251
|
"type": "I",
|
|
10188
10252
|
"fields": {
|
|
@@ -10247,6 +10311,9 @@ export const data = {
|
|
|
10247
10311
|
"appInboxPayload": {
|
|
10248
10312
|
"type": "pushwoosh.channels.messagingApi.v2.AppInboxPayload"
|
|
10249
10313
|
},
|
|
10314
|
+
"inAppPayload": {
|
|
10315
|
+
"type": "pushwoosh.channels.messagingApi.v2.InAppPayload"
|
|
10316
|
+
},
|
|
10250
10317
|
"returnUnknownIdentifiers": {
|
|
10251
10318
|
"type": "boolean"
|
|
10252
10319
|
},
|
|
@@ -10280,6 +10347,18 @@ export const data = {
|
|
|
10280
10347
|
},
|
|
10281
10348
|
"controlGroup": {
|
|
10282
10349
|
"type": "string"
|
|
10350
|
+
},
|
|
10351
|
+
"campaignName": {
|
|
10352
|
+
"type": "string"
|
|
10353
|
+
},
|
|
10354
|
+
"messageTypeSource": {
|
|
10355
|
+
"type": "pushwoosh.channels.messagingApi.v2.MessageTypeSource"
|
|
10356
|
+
},
|
|
10357
|
+
"contentPlaceholders": {
|
|
10358
|
+
"type": "object"
|
|
10359
|
+
},
|
|
10360
|
+
"resend": {
|
|
10361
|
+
"type": "pushwoosh.channels.messagingApi.v2.Resend"
|
|
10283
10362
|
}
|
|
10284
10363
|
},
|
|
10285
10364
|
"oneofs": {
|
|
@@ -10296,7 +10375,8 @@ export const data = {
|
|
|
10296
10375
|
"payload",
|
|
10297
10376
|
"emailPayload",
|
|
10298
10377
|
"smsPayload",
|
|
10299
|
-
"appInboxPayload"
|
|
10378
|
+
"appInboxPayload",
|
|
10379
|
+
"inAppPayload"
|
|
10300
10380
|
]
|
|
10301
10381
|
}
|
|
10302
10382
|
}
|
|
@@ -10324,6 +10404,12 @@ export const data = {
|
|
|
10324
10404
|
},
|
|
10325
10405
|
"pastTimezonesBehaviour": {
|
|
10326
10406
|
"type": "pushwoosh.channels.messagingApi.v2.Schedule.PastTimezonesBehaviour"
|
|
10407
|
+
},
|
|
10408
|
+
"bestTimeToSend": {
|
|
10409
|
+
"type": "Date"
|
|
10410
|
+
},
|
|
10411
|
+
"timezone": {
|
|
10412
|
+
"type": "string"
|
|
10327
10413
|
}
|
|
10328
10414
|
},
|
|
10329
10415
|
"oneofs": {
|
|
@@ -10379,6 +10465,37 @@ export const data = {
|
|
|
10379
10465
|
}
|
|
10380
10466
|
}
|
|
10381
10467
|
},
|
|
10468
|
+
"pushwoosh.channels.messagingApi.v2.ResendAction": {
|
|
10469
|
+
"type": "E",
|
|
10470
|
+
"values": [
|
|
10471
|
+
"RESEND_ACTION_UNSPECIFIED",
|
|
10472
|
+
"RESEND_ACTION_CREATE",
|
|
10473
|
+
"RESEND_ACTION_UPDATE",
|
|
10474
|
+
"RESEND_ACTION_CANCEL"
|
|
10475
|
+
]
|
|
10476
|
+
},
|
|
10477
|
+
"pushwoosh.channels.messagingApi.v2.Resend": {
|
|
10478
|
+
"type": "I",
|
|
10479
|
+
"fields": {
|
|
10480
|
+
"segment": {
|
|
10481
|
+
"type": "pushwoosh.channels.messagingApi.v2.NotifySegment"
|
|
10482
|
+
},
|
|
10483
|
+
"transactional": {
|
|
10484
|
+
"type": "pushwoosh.channels.messagingApi.v2.NotifyTransactional"
|
|
10485
|
+
},
|
|
10486
|
+
"action": {
|
|
10487
|
+
"type": "pushwoosh.channels.messagingApi.v2.ResendAction"
|
|
10488
|
+
}
|
|
10489
|
+
},
|
|
10490
|
+
"oneofs": {
|
|
10491
|
+
"message": {
|
|
10492
|
+
"oneof": [
|
|
10493
|
+
"segment",
|
|
10494
|
+
"transactional"
|
|
10495
|
+
]
|
|
10496
|
+
}
|
|
10497
|
+
}
|
|
10498
|
+
},
|
|
10382
10499
|
"pushwoosh.channels.messagingApi.v2.DeliveryPriority": {
|
|
10383
10500
|
"type": "E",
|
|
10384
10501
|
"values": [
|
|
@@ -10601,6 +10718,48 @@ export const data = {
|
|
|
10601
10718
|
}
|
|
10602
10719
|
}
|
|
10603
10720
|
},
|
|
10721
|
+
"pushwoosh.channels.messagingApi.v2.PushButton.Action": {
|
|
10722
|
+
"type": "E",
|
|
10723
|
+
"values": [
|
|
10724
|
+
"ACTION_UNSPECIFIED",
|
|
10725
|
+
"ACTION_OPEN",
|
|
10726
|
+
"ACTION_URL",
|
|
10727
|
+
"ACTION_DEEPLINK",
|
|
10728
|
+
"ACTION_CUSTOM"
|
|
10729
|
+
]
|
|
10730
|
+
},
|
|
10731
|
+
"pushwoosh.channels.messagingApi.v2.PushButton.Style": {
|
|
10732
|
+
"type": "E",
|
|
10733
|
+
"values": [
|
|
10734
|
+
"STYLE_UNSPECIFIED",
|
|
10735
|
+
"STYLE_DEFAULT",
|
|
10736
|
+
"STYLE_DESTRUCTIVE"
|
|
10737
|
+
]
|
|
10738
|
+
},
|
|
10739
|
+
"pushwoosh.channels.messagingApi.v2.PushButton": {
|
|
10740
|
+
"type": "I",
|
|
10741
|
+
"fields": {
|
|
10742
|
+
"id": {
|
|
10743
|
+
"type": "string"
|
|
10744
|
+
},
|
|
10745
|
+
"label": {
|
|
10746
|
+
"type": "string"
|
|
10747
|
+
},
|
|
10748
|
+
"action": {
|
|
10749
|
+
"type": "pushwoosh.channels.messagingApi.v2.PushButton.Action"
|
|
10750
|
+
},
|
|
10751
|
+
"url": {
|
|
10752
|
+
"type": "string"
|
|
10753
|
+
},
|
|
10754
|
+
"platformUrls": {
|
|
10755
|
+
"type": "string",
|
|
10756
|
+
"mapKeyType": "number"
|
|
10757
|
+
},
|
|
10758
|
+
"style": {
|
|
10759
|
+
"type": "pushwoosh.channels.messagingApi.v2.PushButton.Style"
|
|
10760
|
+
}
|
|
10761
|
+
}
|
|
10762
|
+
},
|
|
10604
10763
|
"pushwoosh.channels.messagingApi.v2.Inbox": {
|
|
10605
10764
|
"type": "I",
|
|
10606
10765
|
"fields": {
|
|
@@ -10609,6 +10768,9 @@ export const data = {
|
|
|
10609
10768
|
},
|
|
10610
10769
|
"expirationDate": {
|
|
10611
10770
|
"type": "Date"
|
|
10771
|
+
},
|
|
10772
|
+
"expiresIn": {
|
|
10773
|
+
"type": "Duration"
|
|
10612
10774
|
}
|
|
10613
10775
|
}
|
|
10614
10776
|
},
|
|
@@ -10682,6 +10844,9 @@ export const data = {
|
|
|
10682
10844
|
},
|
|
10683
10845
|
"stories": {
|
|
10684
10846
|
"type": "pushwoosh.channels.messagingApi.v2.Stories"
|
|
10847
|
+
},
|
|
10848
|
+
"silent": {
|
|
10849
|
+
"type": "boolean"
|
|
10685
10850
|
}
|
|
10686
10851
|
}
|
|
10687
10852
|
},
|
|
@@ -10747,6 +10912,9 @@ export const data = {
|
|
|
10747
10912
|
},
|
|
10748
10913
|
"liveUpdate": {
|
|
10749
10914
|
"type": "pushwoosh.channels.messagingApi.v2.LiveUpdate"
|
|
10915
|
+
},
|
|
10916
|
+
"silent": {
|
|
10917
|
+
"type": "boolean"
|
|
10750
10918
|
}
|
|
10751
10919
|
}
|
|
10752
10920
|
},
|
|
@@ -10964,6 +11132,9 @@ export const data = {
|
|
|
10964
11132
|
},
|
|
10965
11133
|
"inbox": {
|
|
10966
11134
|
"type": "pushwoosh.channels.messagingApi.v2.Inbox"
|
|
11135
|
+
},
|
|
11136
|
+
"silent": {
|
|
11137
|
+
"type": "boolean"
|
|
10967
11138
|
}
|
|
10968
11139
|
}
|
|
10969
11140
|
},
|
|
@@ -11023,6 +11194,9 @@ export const data = {
|
|
|
11023
11194
|
},
|
|
11024
11195
|
"inbox": {
|
|
11025
11196
|
"type": "pushwoosh.channels.messagingApi.v2.Inbox"
|
|
11197
|
+
},
|
|
11198
|
+
"silent": {
|
|
11199
|
+
"type": "boolean"
|
|
11026
11200
|
}
|
|
11027
11201
|
}
|
|
11028
11202
|
},
|
|
@@ -11152,6 +11326,17 @@ export const data = {
|
|
|
11152
11326
|
}
|
|
11153
11327
|
}
|
|
11154
11328
|
},
|
|
11329
|
+
"pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesSMS.RCS": {
|
|
11330
|
+
"type": "I",
|
|
11331
|
+
"fields": {
|
|
11332
|
+
"contentSid": {
|
|
11333
|
+
"type": "string"
|
|
11334
|
+
},
|
|
11335
|
+
"contentVariables": {
|
|
11336
|
+
"type": "string"
|
|
11337
|
+
}
|
|
11338
|
+
}
|
|
11339
|
+
},
|
|
11155
11340
|
"pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesSMS": {
|
|
11156
11341
|
"type": "I",
|
|
11157
11342
|
"fields": {
|
|
@@ -11167,6 +11352,9 @@ export const data = {
|
|
|
11167
11352
|
},
|
|
11168
11353
|
"messageAt": {
|
|
11169
11354
|
"type": "number"
|
|
11355
|
+
},
|
|
11356
|
+
"rcs": {
|
|
11357
|
+
"type": "pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesSMS.RCS"
|
|
11170
11358
|
}
|
|
11171
11359
|
}
|
|
11172
11360
|
},
|
|
@@ -11192,6 +11380,9 @@ export const data = {
|
|
|
11192
11380
|
},
|
|
11193
11381
|
"messageTag": {
|
|
11194
11382
|
"type": "string"
|
|
11383
|
+
},
|
|
11384
|
+
"message": {
|
|
11385
|
+
"type": "string"
|
|
11195
11386
|
}
|
|
11196
11387
|
}
|
|
11197
11388
|
},
|
|
@@ -11222,6 +11413,46 @@ export const data = {
|
|
|
11222
11413
|
},
|
|
11223
11414
|
"buttonAction": {
|
|
11224
11415
|
"type": "string"
|
|
11416
|
+
},
|
|
11417
|
+
"carousel": {
|
|
11418
|
+
"type": "pushwoosh.channels.messagingApi.v2.Content.ViberCarousel"
|
|
11419
|
+
}
|
|
11420
|
+
}
|
|
11421
|
+
},
|
|
11422
|
+
"pushwoosh.channels.messagingApi.v2.Content.ViberCarousel": {
|
|
11423
|
+
"type": "I",
|
|
11424
|
+
"fields": {
|
|
11425
|
+
"items": {
|
|
11426
|
+
"type": "pushwoosh.channels.messagingApi.v2.Content.ViberCarouselItem",
|
|
11427
|
+
"array": true
|
|
11428
|
+
}
|
|
11429
|
+
}
|
|
11430
|
+
},
|
|
11431
|
+
"pushwoosh.channels.messagingApi.v2.Content.ViberCarouselItem": {
|
|
11432
|
+
"type": "I",
|
|
11433
|
+
"fields": {
|
|
11434
|
+
"title": {
|
|
11435
|
+
"type": "string"
|
|
11436
|
+
},
|
|
11437
|
+
"image": {
|
|
11438
|
+
"type": "string"
|
|
11439
|
+
},
|
|
11440
|
+
"primaryButton": {
|
|
11441
|
+
"type": "pushwoosh.channels.messagingApi.v2.Content.ViberCarouselButton"
|
|
11442
|
+
},
|
|
11443
|
+
"secondaryButton": {
|
|
11444
|
+
"type": "pushwoosh.channels.messagingApi.v2.Content.ViberCarouselButton"
|
|
11445
|
+
}
|
|
11446
|
+
}
|
|
11447
|
+
},
|
|
11448
|
+
"pushwoosh.channels.messagingApi.v2.Content.ViberCarouselButton": {
|
|
11449
|
+
"type": "I",
|
|
11450
|
+
"fields": {
|
|
11451
|
+
"caption": {
|
|
11452
|
+
"type": "string"
|
|
11453
|
+
},
|
|
11454
|
+
"action": {
|
|
11455
|
+
"type": "string"
|
|
11225
11456
|
}
|
|
11226
11457
|
}
|
|
11227
11458
|
},
|
|
@@ -11273,6 +11504,9 @@ export const data = {
|
|
|
11273
11504
|
},
|
|
11274
11505
|
"attachment": {
|
|
11275
11506
|
"type": "string"
|
|
11507
|
+
},
|
|
11508
|
+
"interactive": {
|
|
11509
|
+
"type": "string"
|
|
11276
11510
|
}
|
|
11277
11511
|
}
|
|
11278
11512
|
},
|
|
@@ -11338,6 +11572,10 @@ export const data = {
|
|
|
11338
11572
|
},
|
|
11339
11573
|
"fbMessenger": {
|
|
11340
11574
|
"type": "pushwoosh.channels.messagingApi.v2.Content.PlatformPropertiesFBMessenger"
|
|
11575
|
+
},
|
|
11576
|
+
"buttons": {
|
|
11577
|
+
"type": "pushwoosh.channels.messagingApi.v2.PushButton",
|
|
11578
|
+
"array": true
|
|
11341
11579
|
}
|
|
11342
11580
|
}
|
|
11343
11581
|
},
|
|
@@ -11377,6 +11615,9 @@ export const data = {
|
|
|
11377
11615
|
},
|
|
11378
11616
|
"appleWalletPassSerial": {
|
|
11379
11617
|
"type": "string"
|
|
11618
|
+
},
|
|
11619
|
+
"customDataRaw": {
|
|
11620
|
+
"type": "string"
|
|
11380
11621
|
}
|
|
11381
11622
|
},
|
|
11382
11623
|
"oneofs": {
|
|
@@ -11438,6 +11679,20 @@ export const data = {
|
|
|
11438
11679
|
},
|
|
11439
11680
|
"emailPreset": {
|
|
11440
11681
|
"type": "string"
|
|
11682
|
+
},
|
|
11683
|
+
"bcc": {
|
|
11684
|
+
"type": "string",
|
|
11685
|
+
"array": true
|
|
11686
|
+
},
|
|
11687
|
+
"bypassUnsubscribedEmails": {
|
|
11688
|
+
"type": "boolean"
|
|
11689
|
+
},
|
|
11690
|
+
"emailCategory": {
|
|
11691
|
+
"type": "string"
|
|
11692
|
+
},
|
|
11693
|
+
"localizedBody": {
|
|
11694
|
+
"type": "string",
|
|
11695
|
+
"mapKeyType": "string"
|
|
11441
11696
|
}
|
|
11442
11697
|
}
|
|
11443
11698
|
},
|
|
@@ -11466,6 +11721,20 @@ export const data = {
|
|
|
11466
11721
|
}
|
|
11467
11722
|
}
|
|
11468
11723
|
},
|
|
11724
|
+
"pushwoosh.channels.messagingApi.v2.InAppPayload": {
|
|
11725
|
+
"type": "I",
|
|
11726
|
+
"fields": {
|
|
11727
|
+
"richMedia": {
|
|
11728
|
+
"type": "pushwoosh.channels.messagingApi.v2.RichMedia"
|
|
11729
|
+
},
|
|
11730
|
+
"customData": {
|
|
11731
|
+
"type": "object"
|
|
11732
|
+
},
|
|
11733
|
+
"timeToLive": {
|
|
11734
|
+
"type": "Duration"
|
|
11735
|
+
}
|
|
11736
|
+
}
|
|
11737
|
+
},
|
|
11469
11738
|
"pushwoosh.channels.messagingApi.v2.SMSPayload": {
|
|
11470
11739
|
"type": "I",
|
|
11471
11740
|
"fields": {
|
|
@@ -34757,6 +35026,40 @@ export const data = {
|
|
|
34757
35026
|
}
|
|
34758
35027
|
}
|
|
34759
35028
|
},
|
|
35029
|
+
"pushwoosh.rpc_v2.presets.PresetButton": {
|
|
35030
|
+
"type": "I",
|
|
35031
|
+
"fields": {
|
|
35032
|
+
"id": {
|
|
35033
|
+
"type": "string"
|
|
35034
|
+
},
|
|
35035
|
+
"localizedLabel": {
|
|
35036
|
+
"type": "string",
|
|
35037
|
+
"mapKeyType": "string"
|
|
35038
|
+
},
|
|
35039
|
+
"action": {
|
|
35040
|
+
"type": "pushwoosh.channels.messagingApi.v2.PushButton.Action"
|
|
35041
|
+
},
|
|
35042
|
+
"url": {
|
|
35043
|
+
"type": "string"
|
|
35044
|
+
},
|
|
35045
|
+
"platformUrls": {
|
|
35046
|
+
"type": "string",
|
|
35047
|
+
"mapKeyType": "number"
|
|
35048
|
+
},
|
|
35049
|
+
"style": {
|
|
35050
|
+
"type": "pushwoosh.channels.messagingApi.v2.PushButton.Style"
|
|
35051
|
+
}
|
|
35052
|
+
}
|
|
35053
|
+
},
|
|
35054
|
+
"pushwoosh.rpc_v2.presets.PresetButtons": {
|
|
35055
|
+
"type": "I",
|
|
35056
|
+
"fields": {
|
|
35057
|
+
"items": {
|
|
35058
|
+
"type": "pushwoosh.rpc_v2.presets.PresetButton",
|
|
35059
|
+
"array": true
|
|
35060
|
+
}
|
|
35061
|
+
}
|
|
35062
|
+
},
|
|
34760
35063
|
"pushwoosh.rpc_v2.presets.Preset": {
|
|
34761
35064
|
"type": "I",
|
|
34762
35065
|
"fields": {
|
|
@@ -34909,6 +35212,10 @@ export const data = {
|
|
|
34909
35212
|
},
|
|
34910
35213
|
"adCampaignId": {
|
|
34911
35214
|
"type": "number"
|
|
35215
|
+
},
|
|
35216
|
+
"buttons": {
|
|
35217
|
+
"type": "pushwoosh.rpc_v2.presets.PresetButton",
|
|
35218
|
+
"array": true
|
|
34912
35219
|
}
|
|
34913
35220
|
}
|
|
34914
35221
|
},
|
|
@@ -35093,6 +35400,10 @@ export const data = {
|
|
|
35093
35400
|
},
|
|
35094
35401
|
"adCampaignId": {
|
|
35095
35402
|
"type": "number"
|
|
35403
|
+
},
|
|
35404
|
+
"buttons": {
|
|
35405
|
+
"type": "pushwoosh.rpc_v2.presets.PresetButton",
|
|
35406
|
+
"array": true
|
|
35096
35407
|
}
|
|
35097
35408
|
}
|
|
35098
35409
|
},
|
|
@@ -35242,6 +35553,10 @@ export const data = {
|
|
|
35242
35553
|
},
|
|
35243
35554
|
"adCampaignId": {
|
|
35244
35555
|
"type": "number"
|
|
35556
|
+
},
|
|
35557
|
+
"buttons": {
|
|
35558
|
+
"type": "pushwoosh.rpc_v2.presets.PresetButton",
|
|
35559
|
+
"array": true
|
|
35245
35560
|
}
|
|
35246
35561
|
}
|
|
35247
35562
|
},
|
|
@@ -35372,6 +35687,9 @@ export const data = {
|
|
|
35372
35687
|
},
|
|
35373
35688
|
"adCampaignId": {
|
|
35374
35689
|
"type": "number"
|
|
35690
|
+
},
|
|
35691
|
+
"buttons": {
|
|
35692
|
+
"type": "pushwoosh.rpc_v2.presets.PresetButtons"
|
|
35375
35693
|
}
|
|
35376
35694
|
}
|
|
35377
35695
|
},
|
package/package.json
CHANGED
package/presets.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { RpcMethod } from './commonTypes';
|
|
2
|
+
import { PushButton_Action as pushwoosh_channels_messagingApi_v2_PushButton_Action } from './pushwoosh_channels_messagingApi_v2';
|
|
3
|
+
import { PushButton_Style as pushwoosh_channels_messagingApi_v2_PushButton_Style } from './pushwoosh_channels_messagingApi_v2';
|
|
2
4
|
import { Content as pushwoosh_channels_messagingApi_v2_Content } from './pushwoosh_channels_messagingApi_v2';
|
|
3
5
|
import { OpenAction as pushwoosh_channels_messagingApi_v2_OpenAction } from './pushwoosh_channels_messagingApi_v2';
|
|
4
6
|
export type presetsService_List = RpcMethod<ListPresetsRequest, ListPresetsResponse>;
|
|
@@ -122,6 +124,17 @@ export type PlatformProperties = {
|
|
|
122
124
|
deliveryPriority: string;
|
|
123
125
|
iosInterruptionLevel: string;
|
|
124
126
|
};
|
|
127
|
+
export type PresetButton = {
|
|
128
|
+
id: string;
|
|
129
|
+
localizedLabel: Record<string, string>;
|
|
130
|
+
action: pushwoosh_channels_messagingApi_v2_PushButton_Action;
|
|
131
|
+
url: string;
|
|
132
|
+
platformUrls: Record<number, string>;
|
|
133
|
+
style: pushwoosh_channels_messagingApi_v2_PushButton_Style;
|
|
134
|
+
};
|
|
135
|
+
export type PresetButtons = {
|
|
136
|
+
items: PresetButton[];
|
|
137
|
+
};
|
|
125
138
|
export type Preset = {
|
|
126
139
|
name: string;
|
|
127
140
|
code: string;
|
|
@@ -200,6 +213,8 @@ export type Preset = {
|
|
|
200
213
|
* instead of its own content. 0 = an ordinary push.
|
|
201
214
|
*/
|
|
202
215
|
adCampaignId: number;
|
|
216
|
+
/** Up to 3 action buttons for iOS, Android and Huawei. */
|
|
217
|
+
buttons: PresetButton[];
|
|
203
218
|
};
|
|
204
219
|
export type ListPresetsResponse = {
|
|
205
220
|
presets: Preset[];
|
|
@@ -285,6 +300,8 @@ export type CreatePresetRequest = {
|
|
|
285
300
|
contentSource?: ContentSource;
|
|
286
301
|
/** Ad campaign the preset sells; 0 = an ordinary push. */
|
|
287
302
|
adCampaignId?: number;
|
|
303
|
+
/** Up to 3 action buttons for iOS, Android and Huawei. */
|
|
304
|
+
buttons?: PresetButton[];
|
|
288
305
|
};
|
|
289
306
|
export type CreatePresetResponse = {
|
|
290
307
|
preset: Preset;
|
|
@@ -359,6 +376,8 @@ export type UpdatePresetRequest = {
|
|
|
359
376
|
contentSource?: ContentSource;
|
|
360
377
|
/** Ad campaign the preset sells; absent leaves it as it is, 0 clears it. */
|
|
361
378
|
adCampaignId?: number;
|
|
379
|
+
/** Up to 3 action buttons for iOS, Android and Huawei; omitted means none, like every other field here. */
|
|
380
|
+
buttons?: PresetButton[];
|
|
362
381
|
};
|
|
363
382
|
export type UpdatePresetPartialRequest = {
|
|
364
383
|
/** Preset code of the push preset to patch. */
|
|
@@ -423,6 +442,7 @@ export type UpdatePresetPartialRequest = {
|
|
|
423
442
|
contentSource?: ContentSource;
|
|
424
443
|
/** Ad campaign the preset sells; absent leaves it as it is, 0 clears it. */
|
|
425
444
|
adCampaignId?: number;
|
|
445
|
+
buttons?: PresetButtons;
|
|
426
446
|
};
|
|
427
447
|
export type UpdatePresetResponse = {
|
|
428
448
|
preset: Preset;
|
|
@@ -47,6 +47,7 @@ export type MessagingService_Notify = RpcMethod<NotifyRequest, NotifyResponse>;
|
|
|
47
47
|
export type MessagingService_NotifyBatch = RpcMethod<NotifyBatchRequest, NotifyBatchResponse>;
|
|
48
48
|
export type MessagingService_Cancel = RpcMethod<CancelRequest, CancelResponse>;
|
|
49
49
|
export type MessagingService_Update = RpcMethod<UpdateRequest, UpdateResponse>;
|
|
50
|
+
export type MessagingService_Rename = RpcMethod<RenameRequest, RenameResponse>;
|
|
50
51
|
export type MessagingService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
|
|
51
52
|
export interface MessagingService {
|
|
52
53
|
/** Notify creates a new message. Can be targeted to a segment or a list of users. */
|
|
@@ -75,6 +76,12 @@ export interface MessagingService {
|
|
|
75
76
|
* updated. The message_code does not change.
|
|
76
77
|
*/
|
|
77
78
|
Update: MessagingService_Update;
|
|
79
|
+
/**
|
|
80
|
+
* Rename sets the campaign name of a message still in the pending (scheduled)
|
|
81
|
+
* state, identified by message_code. An empty name clears it, and Message
|
|
82
|
+
* History falls back to the message title. Nothing else about the message changes.
|
|
83
|
+
*/
|
|
84
|
+
Rename: MessagingService_Rename;
|
|
78
85
|
/**
|
|
79
86
|
* Delete permanently removes a previously created message identified by
|
|
80
87
|
* message_code. Only messages in a cancelable state (pending, waiting,
|
|
@@ -184,12 +191,26 @@ export type UpdateResponse = {
|
|
|
184
191
|
/** Result carries the (unchanged) message_code and any unknown identifiers. */
|
|
185
192
|
result: NotifyResult;
|
|
186
193
|
};
|
|
194
|
+
export type RenameRequest = {
|
|
195
|
+
/** Code of the message to rename (as returned by Notify in NotifyResult.message_code). */
|
|
196
|
+
messageCode?: string;
|
|
197
|
+
/** New internal campaign name, trimmed and cut to 255 characters. Empty clears it. */
|
|
198
|
+
campaignName?: string;
|
|
199
|
+
};
|
|
200
|
+
export type RenameResponse = {};
|
|
187
201
|
export type DeleteRequest = {
|
|
188
202
|
/** Code of the message to delete (as returned by Notify in NotifyResult.message_code). */
|
|
189
203
|
messageCode?: string;
|
|
190
204
|
};
|
|
191
205
|
export type DeleteResponse = {};
|
|
192
|
-
export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'MESSAGE_TYPE_MARKETING' | 'MESSAGE_TYPE_TRANSACTIONAL'
|
|
206
|
+
export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'MESSAGE_TYPE_MARKETING' | 'MESSAGE_TYPE_TRANSACTIONAL'
|
|
207
|
+
/** A push with nothing to show (silent, data-only); set by the platform, a client may not choose it. */
|
|
208
|
+
| 'MESSAGE_TYPE_FUNCTIONAL';
|
|
209
|
+
/**
|
|
210
|
+
* MessageTypeSource tells where message_type came from; UNSPECIFIED is "none". Stored as the
|
|
211
|
+
* message_type_source property: client, default, app_default (channels/sdk pkg/messagetype).
|
|
212
|
+
*/
|
|
213
|
+
export type MessageTypeSource = 'MESSAGE_TYPE_SOURCE_UNSPECIFIED' | 'MESSAGE_TYPE_SOURCE_CLIENT' | 'MESSAGE_TYPE_SOURCE_DEFAULT' | 'MESSAGE_TYPE_SOURCE_APP_DEFAULT';
|
|
193
214
|
/**
|
|
194
215
|
* RegistrationType controls whether destinations referenced by hwid / push token /
|
|
195
216
|
* user_id / email address / phone number that are NOT yet present in Pushwoosh
|
|
@@ -238,7 +259,11 @@ export type NotifySegment_messagePayload_appInboxPayload = {
|
|
|
238
259
|
type: 'appInboxPayload';
|
|
239
260
|
data: AppInboxPayload;
|
|
240
261
|
};
|
|
241
|
-
export type
|
|
262
|
+
export type NotifySegment_messagePayload_inAppPayload = {
|
|
263
|
+
type: 'inAppPayload';
|
|
264
|
+
data: InAppPayload;
|
|
265
|
+
};
|
|
266
|
+
export type NotifySegment_messagePayload = NotifySegment_messagePayload_payload | NotifySegment_messagePayload_emailPayload | NotifySegment_messagePayload_smsPayload | NotifySegment_messagePayload_appInboxPayload | NotifySegment_messagePayload_inAppPayload;
|
|
242
267
|
/**
|
|
243
268
|
* NotifySegment defines a request to send a message to a segment of users.
|
|
244
269
|
* Segment can be defined either by a segment code or by a seglang expression.
|
|
@@ -277,9 +302,25 @@ export type NotifySegment = {
|
|
|
277
302
|
* its own. Mutually exclusive with control_group.
|
|
278
303
|
*/
|
|
279
304
|
holdoutPercentage: number;
|
|
305
|
+
/**
|
|
306
|
+
* Internal name of the message shown in Message History and exports instead of the title.
|
|
307
|
+
* Trimmed and cut to 255 characters; empty keeps the title.
|
|
308
|
+
*/
|
|
309
|
+
campaignName: string;
|
|
310
|
+
/** Internal: where message_type came from, e.g. a journey default baked at publish; ignored for external requests. */
|
|
311
|
+
messageTypeSource: MessageTypeSource;
|
|
312
|
+
/** Placeholder name to the value substituted into the message content; wins over dynamic_content_placeholders on the same key. */
|
|
313
|
+
contentPlaceholders: object;
|
|
314
|
+
resend: Resend;
|
|
315
|
+
geoZone: GeoZone;
|
|
280
316
|
target: NotifySegment_target;
|
|
281
317
|
messagePayload: NotifySegment_messagePayload;
|
|
282
318
|
};
|
|
319
|
+
export type GeoZone = {
|
|
320
|
+
lat: number;
|
|
321
|
+
lng: number;
|
|
322
|
+
range: number;
|
|
323
|
+
};
|
|
283
324
|
export type NotifyTransactional_HwidsList = {
|
|
284
325
|
list: string[];
|
|
285
326
|
};
|
|
@@ -322,7 +363,11 @@ export type NotifyTransactional_messagePayload_appInboxPayload = {
|
|
|
322
363
|
type: 'appInboxPayload';
|
|
323
364
|
data: AppInboxPayload;
|
|
324
365
|
};
|
|
325
|
-
export type
|
|
366
|
+
export type NotifyTransactional_messagePayload_inAppPayload = {
|
|
367
|
+
type: 'inAppPayload';
|
|
368
|
+
data: InAppPayload;
|
|
369
|
+
};
|
|
370
|
+
export type NotifyTransactional_messagePayload = NotifyTransactional_messagePayload_payload | NotifyTransactional_messagePayload_emailPayload | NotifyTransactional_messagePayload_smsPayload | NotifyTransactional_messagePayload_appInboxPayload | NotifyTransactional_messagePayload_inAppPayload;
|
|
326
371
|
export type NotifyTransactional = {
|
|
327
372
|
/** Message schedule. */
|
|
328
373
|
schedule: Schedule;
|
|
@@ -369,6 +414,16 @@ export type NotifyTransactional = {
|
|
|
369
414
|
* effect on a marketing message: a transactional one is never held back.
|
|
370
415
|
*/
|
|
371
416
|
controlGroup: string;
|
|
417
|
+
/**
|
|
418
|
+
* Internal name of the message shown in Message History and exports instead of the title.
|
|
419
|
+
* Trimmed and cut to 255 characters; empty keeps the title.
|
|
420
|
+
*/
|
|
421
|
+
campaignName: string;
|
|
422
|
+
/** Internal: where message_type came from, e.g. a journey default baked at publish; ignored for external requests. */
|
|
423
|
+
messageTypeSource: MessageTypeSource;
|
|
424
|
+
/** Placeholder name to the value substituted into the message content; wins over dynamic_content_placeholders on the same key. */
|
|
425
|
+
contentPlaceholders: object;
|
|
426
|
+
resend: Resend;
|
|
372
427
|
target: NotifyTransactional_target;
|
|
373
428
|
messagePayload: NotifyTransactional_messagePayload;
|
|
374
429
|
};
|
|
@@ -394,6 +449,17 @@ export type Schedule = {
|
|
|
394
449
|
followUserTimezone: boolean;
|
|
395
450
|
/** What to do with past timezones. */
|
|
396
451
|
pastTimezonesBehaviour: Schedule_PastTimezonesBehaviour;
|
|
452
|
+
/**
|
|
453
|
+
* Best time to send: each device gets the message at its own best hour within 24 hours from this time.
|
|
454
|
+
* Devices without a best hour get it at send_date. Segment messages only; send_date must be in the future and not
|
|
455
|
+
* later than it plus 24 hours; follow_user_timezone must be false; must be from the next full hour to 30 days ahead.
|
|
456
|
+
*/
|
|
457
|
+
bestTimeToSend: Date;
|
|
458
|
+
/**
|
|
459
|
+
* IANA timezone name send_date was picked in. Kept with the message so editors show the time in it;
|
|
460
|
+
* it does not change when the message is sent. Ignored when it is not a valid IANA name.
|
|
461
|
+
*/
|
|
462
|
+
timezone: string;
|
|
397
463
|
sendDate: Schedule_sendDate;
|
|
398
464
|
};
|
|
399
465
|
/** FrequencyCappingMode anchors the capping counting window. */
|
|
@@ -425,6 +491,20 @@ export type SendRate = {
|
|
|
425
491
|
/** Send at full speed, ignoring any configured send rate. */
|
|
426
492
|
avoid: boolean;
|
|
427
493
|
};
|
|
494
|
+
export type ResendAction = 'RESEND_ACTION_UNSPECIFIED' | 'RESEND_ACTION_CREATE' | 'RESEND_ACTION_UPDATE' | 'RESEND_ACTION_CANCEL';
|
|
495
|
+
export type Resend_message_segment = {
|
|
496
|
+
type: 'segment';
|
|
497
|
+
data: NotifySegment;
|
|
498
|
+
};
|
|
499
|
+
export type Resend_message_transactional = {
|
|
500
|
+
type: 'transactional';
|
|
501
|
+
data: NotifyTransactional;
|
|
502
|
+
};
|
|
503
|
+
export type Resend_message = Resend_message_segment | Resend_message_transactional;
|
|
504
|
+
export type Resend = {
|
|
505
|
+
action: ResendAction;
|
|
506
|
+
message: Resend_message;
|
|
507
|
+
};
|
|
428
508
|
export type DeliveryPriority = 'NORMAL' | 'HIGH';
|
|
429
509
|
export type NotificationPriority = 'PRIORITY_UNSPECIFIED' | 'PRIORITY_MIN' | 'PRIORITY_LOW' | 'PRIORITY_DEFAULT' | 'PRIORITY_HIGH' | 'PRIORITY_MAX';
|
|
430
510
|
export type LiveActivity = {
|
|
@@ -555,11 +635,23 @@ export type OpenAction_kind = OpenAction_kind_richMedia | OpenAction_kind_deepLi
|
|
|
555
635
|
export type OpenAction = {
|
|
556
636
|
kind: OpenAction_kind;
|
|
557
637
|
};
|
|
638
|
+
export type PushButton_Action = 'ACTION_UNSPECIFIED' | 'ACTION_OPEN' | 'ACTION_URL' | 'ACTION_DEEPLINK' | 'ACTION_CUSTOM';
|
|
639
|
+
export type PushButton_Style = 'STYLE_UNSPECIFIED' | 'STYLE_DEFAULT' | 'STYLE_DESTRUCTIVE';
|
|
640
|
+
export type PushButton = {
|
|
641
|
+
id: string;
|
|
642
|
+
label: string;
|
|
643
|
+
action: PushButton_Action;
|
|
644
|
+
url: string;
|
|
645
|
+
platformUrls: Record<number, string>;
|
|
646
|
+
style: PushButton_Style;
|
|
647
|
+
};
|
|
558
648
|
export type Inbox = {
|
|
559
649
|
/** Image shown in the Message Inbox entry. */
|
|
560
650
|
imageUrl: string;
|
|
561
651
|
/** When the entry is removed from the Message Inbox. */
|
|
562
652
|
expirationDate: Date;
|
|
653
|
+
/** How long after the send date the entry stays in the Message Inbox; ignored when expiration_date is set. */
|
|
654
|
+
expiresIn: Duration;
|
|
563
655
|
};
|
|
564
656
|
export type Content_GlobalProperties = {
|
|
565
657
|
/** TTL applied to every platform block that has none of its own. */
|
|
@@ -609,6 +701,7 @@ export type Content_PlatformPropertiesIos = {
|
|
|
609
701
|
apnsPriority: number;
|
|
610
702
|
/** Push stories shown when the notification is expanded; needs the SDK stories Content Extension. */
|
|
611
703
|
stories: Stories;
|
|
704
|
+
silent: boolean;
|
|
612
705
|
};
|
|
613
706
|
export type Content_PlatformPropertiesAndroid = {
|
|
614
707
|
/** Notification title. */
|
|
@@ -651,6 +744,7 @@ export type Content_PlatformPropertiesAndroid = {
|
|
|
651
744
|
inbox: Inbox;
|
|
652
745
|
/** Android Live Updates payload (Android 16+, FCM only). */
|
|
653
746
|
liveUpdate: LiveUpdate;
|
|
747
|
+
silent: boolean;
|
|
654
748
|
};
|
|
655
749
|
export type Content_PlatformPropertiesChrome = {
|
|
656
750
|
/** Notification title. */
|
|
@@ -787,6 +881,7 @@ export type Content_PlatformPropertiesBaiduAndroid = {
|
|
|
787
881
|
groupId: string;
|
|
788
882
|
/** Message Inbox entry created for this notification. */
|
|
789
883
|
inbox: Inbox;
|
|
884
|
+
silent: boolean;
|
|
790
885
|
};
|
|
791
886
|
export type Content_PlatformPropertiesHuaweiAndroid = {
|
|
792
887
|
/** Notification title. */
|
|
@@ -825,6 +920,7 @@ export type Content_PlatformPropertiesHuaweiAndroid = {
|
|
|
825
920
|
groupId: string;
|
|
826
921
|
/** Message Inbox entry created for this notification. */
|
|
827
922
|
inbox: Inbox;
|
|
923
|
+
silent: boolean;
|
|
828
924
|
};
|
|
829
925
|
export type Content_PlatformPropertiesIE = {
|
|
830
926
|
/** Notification title. */
|
|
@@ -895,6 +991,12 @@ export type Content_PlatformPropertiesAppInbox = {
|
|
|
895
991
|
/** Per-platform override of open_action, keyed by the numeric platform code. */
|
|
896
992
|
openActions: Record<number, OpenAction>;
|
|
897
993
|
};
|
|
994
|
+
export type Content_PlatformPropertiesSMS_RCS = {
|
|
995
|
+
/** Twilio Content template SID (HX followed by 32 hex characters). */
|
|
996
|
+
contentSid: string;
|
|
997
|
+
/** JSON object of template variables; values may hold tags and Liquid. */
|
|
998
|
+
contentVariables: string;
|
|
999
|
+
};
|
|
898
1000
|
export type Content_PlatformPropertiesSMS = {
|
|
899
1001
|
/** Notification body text. */
|
|
900
1002
|
body: string;
|
|
@@ -906,6 +1008,11 @@ export type Content_PlatformPropertiesSMS = {
|
|
|
906
1008
|
fileUrls: string[];
|
|
907
1009
|
/** Attachment index the body text is shown after; 0 means after the first attachment. */
|
|
908
1010
|
messageAt: number;
|
|
1011
|
+
/**
|
|
1012
|
+
* RCS: a Twilio Content template sent instead of the body; Twilio falls back to the template's
|
|
1013
|
+
* own SMS text. Accepted only for Twilio applications with their own credentials and a Messaging Service.
|
|
1014
|
+
*/
|
|
1015
|
+
rcs: Content_PlatformPropertiesSMS_RCS;
|
|
909
1016
|
};
|
|
910
1017
|
export type Content_PlatformPropertiesTelegram = {
|
|
911
1018
|
/** Message text. */
|
|
@@ -923,6 +1030,11 @@ export type Content_PlatformPropertiesFBMessenger = {
|
|
|
923
1030
|
* HUMAN_AGENT). Required to reach a user outside the 24-hour messaging window.
|
|
924
1031
|
*/
|
|
925
1032
|
messageTag: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Complete Send API `message` object as JSON (text, attachment, template, quick_replies), as stored
|
|
1035
|
+
* in an FB Messenger preset. Sent instead of `body`; `body` stays the plain-text form of the message.
|
|
1036
|
+
*/
|
|
1037
|
+
message: string;
|
|
926
1038
|
};
|
|
927
1039
|
export type Content_PlatformPropertiesViber = {
|
|
928
1040
|
/** Notification body text. */
|
|
@@ -947,6 +1059,27 @@ export type Content_PlatformPropertiesViber = {
|
|
|
947
1059
|
image: string;
|
|
948
1060
|
buttonCaption: string;
|
|
949
1061
|
buttonAction: string;
|
|
1062
|
+
/** Carousel (MStat type 901): body plus 2-5 cards; excludes image, button and template_id. */
|
|
1063
|
+
carousel: Content_ViberCarousel;
|
|
1064
|
+
};
|
|
1065
|
+
export type Content_ViberCarousel = {
|
|
1066
|
+
/** 2-5 cards. */
|
|
1067
|
+
items: Content_ViberCarouselItem[];
|
|
1068
|
+
};
|
|
1069
|
+
export type Content_ViberCarouselItem = {
|
|
1070
|
+
/** 2-38 characters. */
|
|
1071
|
+
title: string;
|
|
1072
|
+
/** Public image URL. */
|
|
1073
|
+
image: string;
|
|
1074
|
+
/** Required; caption up to 10 characters. */
|
|
1075
|
+
primaryButton: Content_ViberCarouselButton;
|
|
1076
|
+
/** Optional; caption up to 12 characters. */
|
|
1077
|
+
secondaryButton: Content_ViberCarouselButton;
|
|
1078
|
+
};
|
|
1079
|
+
export type Content_ViberCarouselButton = {
|
|
1080
|
+
caption: string;
|
|
1081
|
+
/** URL, {lp-XXX}/{https://...} tracking token or viber:// deep link. */
|
|
1082
|
+
action: string;
|
|
950
1083
|
};
|
|
951
1084
|
export type Content_PlatformPropertiesKakao = {
|
|
952
1085
|
/** Message text. */
|
|
@@ -959,7 +1092,7 @@ export type Content_PlatformPropertiesKakao = {
|
|
|
959
1092
|
export type Content_PlatformPropertiesLine = {
|
|
960
1093
|
/** Plain text body. */
|
|
961
1094
|
content: string;
|
|
962
|
-
/**
|
|
1095
|
+
/** LINE template JSON: {"image": ...}, {"image_carousel": ...} or {"raw": ...}, as stored in a LINE preset. */
|
|
963
1096
|
template: string;
|
|
964
1097
|
};
|
|
965
1098
|
export type Content_PlatformPropertiesWhatsApp = {
|
|
@@ -1004,6 +1137,11 @@ export type Content_PlatformPropertiesWhatsApp = {
|
|
|
1004
1137
|
* The media kind (image / document / video) is derived from the extension.
|
|
1005
1138
|
*/
|
|
1006
1139
|
attachment: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* Interactive message (buttons, list, media) as Cloud API JSON, as stored in a chat-projected WhatsApp
|
|
1142
|
+
* preset. Sent instead of the template while the 24-hour window is open, or alone when there is no template.
|
|
1143
|
+
*/
|
|
1144
|
+
interactive: string;
|
|
1007
1145
|
};
|
|
1008
1146
|
export type Content = {
|
|
1009
1147
|
/** iOS push content. */
|
|
@@ -1046,6 +1184,8 @@ export type Content = {
|
|
|
1046
1184
|
appInbox: Content_PlatformPropertiesAppInbox;
|
|
1047
1185
|
/** Facebook Messenger message content. */
|
|
1048
1186
|
fbMessenger: Content_PlatformPropertiesFBMessenger;
|
|
1187
|
+
/** Up to 3 action buttons shown under the push on iOS, Android and Huawei; needs an up-to-date SDK. */
|
|
1188
|
+
buttons: PushButton[];
|
|
1049
1189
|
};
|
|
1050
1190
|
export type LocalizedContent = {
|
|
1051
1191
|
/** Locale code (ISO 639-1, "zh-Hant"/"zh-Hans", or "default") to the content sent to devices in that language. */
|
|
@@ -1061,7 +1201,10 @@ export type Payload_kind_silent = {
|
|
|
1061
1201
|
};
|
|
1062
1202
|
export type Payload_kind = Payload_kind_content | Payload_kind_silent;
|
|
1063
1203
|
export type Payload = {
|
|
1064
|
-
/**
|
|
1204
|
+
/**
|
|
1205
|
+
* Preset code (XXXXX-XXXXX) whose content this message starts from: a push preset, a LINE preset when platforms include LINE,
|
|
1206
|
+
* an FB Messenger preset when platforms include FB_MESSENGER, or a WhatsApp preset when platforms include WHATSAPP.
|
|
1207
|
+
*/
|
|
1065
1208
|
preset: string;
|
|
1066
1209
|
/** Free-form JSON delivered to the SDK as the `u` parameter. */
|
|
1067
1210
|
customData: object;
|
|
@@ -1073,6 +1216,11 @@ export type Payload = {
|
|
|
1073
1216
|
voipPush: boolean;
|
|
1074
1217
|
/** Serial of the Apple Wallet pass to update; requires the APPLE_WALLET platform. */
|
|
1075
1218
|
appleWalletPassSerial: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* Free-form JSON object as text, delivered as the `u` parameter; mutually exclusive with custom_data.
|
|
1221
|
+
* Use it to keep integers beyond 2^53 exact: custom_data stores every number as a double.
|
|
1222
|
+
*/
|
|
1223
|
+
customDataRaw: string;
|
|
1076
1224
|
kind: Payload_kind;
|
|
1077
1225
|
};
|
|
1078
1226
|
/** Email attachments. */
|
|
@@ -1090,7 +1238,7 @@ export type EmailPayload_Address = {
|
|
|
1090
1238
|
export type EmailPayload = {
|
|
1091
1239
|
/** Subject line for the email. Per-locale values */
|
|
1092
1240
|
subject: Record<string, string>;
|
|
1093
|
-
/** Email body HTML content. Use
|
|
1241
|
+
/** Email body HTML content. Use localized_body to provide per-locale values. */
|
|
1094
1242
|
body: string;
|
|
1095
1243
|
attachments: EmailPayload_Attachment[];
|
|
1096
1244
|
/** Custom URL for the List-Unsubscribe header. */
|
|
@@ -1106,6 +1254,14 @@ export type EmailPayload = {
|
|
|
1106
1254
|
* email_template + subject + from + reply_to (inline fields override the preset).
|
|
1107
1255
|
*/
|
|
1108
1256
|
emailPreset: string;
|
|
1257
|
+
/** Blind carbon copy recipients. */
|
|
1258
|
+
bcc: string[];
|
|
1259
|
+
/** Send to recipients who unsubscribed from emails. */
|
|
1260
|
+
bypassUnsubscribedEmails: boolean;
|
|
1261
|
+
/** Email category code or name; required for marketing emails when the application has email categories enabled. */
|
|
1262
|
+
emailCategory: string;
|
|
1263
|
+
/** Email body HTML per locale (locale -> HTML); mutually exclusive with body. */
|
|
1264
|
+
localizedBody: Record<string, string>;
|
|
1109
1265
|
};
|
|
1110
1266
|
export type AppInboxPayload_expiration_expirationDate = {
|
|
1111
1267
|
type: 'expirationDate';
|
|
@@ -1127,6 +1283,14 @@ export type AppInboxPayload = {
|
|
|
1127
1283
|
content: LocalizedContent;
|
|
1128
1284
|
expiration: AppInboxPayload_expiration;
|
|
1129
1285
|
};
|
|
1286
|
+
export type InAppPayload = {
|
|
1287
|
+
/** Rich media page to show: a code or a remote page URL. Required. */
|
|
1288
|
+
richMedia: RichMedia;
|
|
1289
|
+
/** Free-form JSON delivered to the SDK as the `u` parameter. */
|
|
1290
|
+
customData: object;
|
|
1291
|
+
/** How long the push service keeps the message for an offline device on iOS, Android and Huawei. */
|
|
1292
|
+
timeToLive: Duration;
|
|
1293
|
+
};
|
|
1130
1294
|
export type SMSPayload = {
|
|
1131
1295
|
/**
|
|
1132
1296
|
* preset references a saved SMS preset by code. When set, messaging-api resolves the
|