aws-sdk-pinpoint 1.30.0 → 1.31.0
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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +221 -3
- data/lib/aws-sdk-pinpoint/client_api.rb +141 -0
- data/lib/aws-sdk-pinpoint/types.rb +565 -57
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 825be33ff96e1dc125f1ff387bbc1d044f6d5ce3
|
4
|
+
data.tar.gz: df1a7405a50240f76c34cd617546431af5c7b7b9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 900681a2be673cfe0c4ec0a8b044f81b4cef5ea33787a648f2fc7b75a0819e22c021204f55a420bb29c1e4cbf3b0dfd97869c8b4684ba2b79c2908086133773c
|
7
|
+
data.tar.gz: e56a5310dc71ab777c2a58ef001663c1dfe4124c69fd1e505c68214987c37d4843e7e271788677fc81a33a9b08a8251e33a7dca2ac7bf28f6642cfe2063fd061
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
@@ -437,6 +437,9 @@ module Aws::Pinpoint
|
|
437
437
|
# sms_template: {
|
438
438
|
# name: "__string",
|
439
439
|
# },
|
440
|
+
# voice_template: {
|
441
|
+
# name: "__string",
|
442
|
+
# },
|
440
443
|
# },
|
441
444
|
# treatment_description: "__string",
|
442
445
|
# treatment_name: "__string",
|
@@ -587,6 +590,9 @@ module Aws::Pinpoint
|
|
587
590
|
# sms_template: {
|
588
591
|
# name: "__string",
|
589
592
|
# },
|
593
|
+
# voice_template: {
|
594
|
+
# name: "__string",
|
595
|
+
# },
|
590
596
|
# },
|
591
597
|
# treatment_description: "__string",
|
592
598
|
# treatment_name: "__string",
|
@@ -687,6 +693,7 @@ module Aws::Pinpoint
|
|
687
693
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
688
694
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
689
695
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
696
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
690
697
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
691
698
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
692
699
|
# resp.campaign_response.application_id #=> String
|
@@ -799,6 +806,7 @@ module Aws::Pinpoint
|
|
799
806
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
800
807
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
801
808
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
809
|
+
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
802
810
|
# resp.campaign_response.treatment_description #=> String
|
803
811
|
# resp.campaign_response.treatment_name #=> String
|
804
812
|
# resp.campaign_response.version #=> Integer
|
@@ -829,11 +837,13 @@ module Aws::Pinpoint
|
|
829
837
|
#
|
830
838
|
# resp = client.create_email_template({
|
831
839
|
# email_template_request: { # required
|
840
|
+
# default_substitutions: "__string",
|
832
841
|
# html_part: "__string",
|
833
842
|
# subject: "__string",
|
834
843
|
# tags: {
|
835
844
|
# "__string" => "__string",
|
836
845
|
# },
|
846
|
+
# template_description: "__string",
|
837
847
|
# text_part: "__string",
|
838
848
|
# },
|
839
849
|
# template_name: "__string", # required
|
@@ -1429,6 +1439,7 @@ module Aws::Pinpoint
|
|
1429
1439
|
# body: "__string",
|
1430
1440
|
# image_icon_url: "__string",
|
1431
1441
|
# image_url: "__string",
|
1442
|
+
# raw_content: "__string",
|
1432
1443
|
# small_image_icon_url: "__string",
|
1433
1444
|
# sound: "__string",
|
1434
1445
|
# title: "__string",
|
@@ -1438,6 +1449,7 @@ module Aws::Pinpoint
|
|
1438
1449
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1439
1450
|
# body: "__string",
|
1440
1451
|
# media_url: "__string",
|
1452
|
+
# raw_content: "__string",
|
1441
1453
|
# sound: "__string",
|
1442
1454
|
# title: "__string",
|
1443
1455
|
# url: "__string",
|
@@ -1447,6 +1459,7 @@ module Aws::Pinpoint
|
|
1447
1459
|
# body: "__string",
|
1448
1460
|
# image_icon_url: "__string",
|
1449
1461
|
# image_url: "__string",
|
1462
|
+
# raw_content: "__string",
|
1450
1463
|
# small_image_icon_url: "__string",
|
1451
1464
|
# sound: "__string",
|
1452
1465
|
# title: "__string",
|
@@ -1459,11 +1472,13 @@ module Aws::Pinpoint
|
|
1459
1472
|
# title: "__string",
|
1460
1473
|
# url: "__string",
|
1461
1474
|
# },
|
1475
|
+
# default_substitutions: "__string",
|
1462
1476
|
# gcm: {
|
1463
1477
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
1464
1478
|
# body: "__string",
|
1465
1479
|
# image_icon_url: "__string",
|
1466
1480
|
# image_url: "__string",
|
1481
|
+
# raw_content: "__string",
|
1467
1482
|
# small_image_icon_url: "__string",
|
1468
1483
|
# sound: "__string",
|
1469
1484
|
# title: "__string",
|
@@ -1472,6 +1487,7 @@ module Aws::Pinpoint
|
|
1472
1487
|
# tags: {
|
1473
1488
|
# "__string" => "__string",
|
1474
1489
|
# },
|
1490
|
+
# template_description: "__string",
|
1475
1491
|
# },
|
1476
1492
|
# template_name: "__string", # required
|
1477
1493
|
# })
|
@@ -1794,9 +1810,11 @@ module Aws::Pinpoint
|
|
1794
1810
|
# resp = client.create_sms_template({
|
1795
1811
|
# sms_template_request: { # required
|
1796
1812
|
# body: "__string",
|
1813
|
+
# default_substitutions: "__string",
|
1797
1814
|
# tags: {
|
1798
1815
|
# "__string" => "__string",
|
1799
1816
|
# },
|
1817
|
+
# template_description: "__string",
|
1800
1818
|
# },
|
1801
1819
|
# template_name: "__string", # required
|
1802
1820
|
# })
|
@@ -1816,6 +1834,50 @@ module Aws::Pinpoint
|
|
1816
1834
|
req.send_request(options)
|
1817
1835
|
end
|
1818
1836
|
|
1837
|
+
# Creates a message template that you can use in messages that are sent
|
1838
|
+
# through the voice channel.
|
1839
|
+
#
|
1840
|
+
# @option params [required, String] :template_name
|
1841
|
+
#
|
1842
|
+
# @option params [required, Types::VoiceTemplateRequest] :voice_template_request
|
1843
|
+
# Specifies the content and settings for a message template that can be
|
1844
|
+
# used in messages that are sent through the voice channel.
|
1845
|
+
#
|
1846
|
+
# @return [Types::CreateVoiceTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1847
|
+
#
|
1848
|
+
# * {Types::CreateVoiceTemplateResponse#create_template_message_body #create_template_message_body} => Types::CreateTemplateMessageBody
|
1849
|
+
#
|
1850
|
+
# @example Request syntax with placeholder values
|
1851
|
+
#
|
1852
|
+
# resp = client.create_voice_template({
|
1853
|
+
# template_name: "__string", # required
|
1854
|
+
# voice_template_request: { # required
|
1855
|
+
# body: "__string",
|
1856
|
+
# default_substitutions: "__string",
|
1857
|
+
# language_code: "__string",
|
1858
|
+
# tags: {
|
1859
|
+
# "__string" => "__string",
|
1860
|
+
# },
|
1861
|
+
# template_description: "__string",
|
1862
|
+
# voice_id: "__string",
|
1863
|
+
# },
|
1864
|
+
# })
|
1865
|
+
#
|
1866
|
+
# @example Response structure
|
1867
|
+
#
|
1868
|
+
# resp.create_template_message_body.arn #=> String
|
1869
|
+
# resp.create_template_message_body.message #=> String
|
1870
|
+
# resp.create_template_message_body.request_id #=> String
|
1871
|
+
#
|
1872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateVoiceTemplate AWS API Documentation
|
1873
|
+
#
|
1874
|
+
# @overload create_voice_template(params = {})
|
1875
|
+
# @param [Hash] params ({})
|
1876
|
+
def create_voice_template(params = {}, options = {})
|
1877
|
+
req = build_request(:create_voice_template, params)
|
1878
|
+
req.send_request(options)
|
1879
|
+
end
|
1880
|
+
|
1819
1881
|
# Disables the ADM channel for an application and deletes any existing
|
1820
1882
|
# settings for the channel.
|
1821
1883
|
#
|
@@ -2189,6 +2251,7 @@ module Aws::Pinpoint
|
|
2189
2251
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
2190
2252
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
2191
2253
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
2254
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
2192
2255
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
2193
2256
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
2194
2257
|
# resp.campaign_response.application_id #=> String
|
@@ -2301,6 +2364,7 @@ module Aws::Pinpoint
|
|
2301
2364
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
2302
2365
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
2303
2366
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
2367
|
+
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
2304
2368
|
# resp.campaign_response.treatment_description #=> String
|
2305
2369
|
# resp.campaign_response.treatment_name #=> String
|
2306
2370
|
# resp.campaign_response.version #=> Integer
|
@@ -3016,6 +3080,35 @@ module Aws::Pinpoint
|
|
3016
3080
|
req.send_request(options)
|
3017
3081
|
end
|
3018
3082
|
|
3083
|
+
# Deletes a message template that was designed for use in messages that
|
3084
|
+
# were sent through the voice channel.
|
3085
|
+
#
|
3086
|
+
# @option params [required, String] :template_name
|
3087
|
+
#
|
3088
|
+
# @return [Types::DeleteVoiceTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3089
|
+
#
|
3090
|
+
# * {Types::DeleteVoiceTemplateResponse#message_body #message_body} => Types::MessageBody
|
3091
|
+
#
|
3092
|
+
# @example Request syntax with placeholder values
|
3093
|
+
#
|
3094
|
+
# resp = client.delete_voice_template({
|
3095
|
+
# template_name: "__string", # required
|
3096
|
+
# })
|
3097
|
+
#
|
3098
|
+
# @example Response structure
|
3099
|
+
#
|
3100
|
+
# resp.message_body.message #=> String
|
3101
|
+
# resp.message_body.request_id #=> String
|
3102
|
+
#
|
3103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteVoiceTemplate AWS API Documentation
|
3104
|
+
#
|
3105
|
+
# @overload delete_voice_template(params = {})
|
3106
|
+
# @param [Hash] params ({})
|
3107
|
+
def delete_voice_template(params = {}, options = {})
|
3108
|
+
req = build_request(:delete_voice_template, params)
|
3109
|
+
req.send_request(options)
|
3110
|
+
end
|
3111
|
+
|
3019
3112
|
# Retrieves information about the status and settings of the ADM channel
|
3020
3113
|
# for an application.
|
3021
3114
|
#
|
@@ -3519,6 +3612,7 @@ module Aws::Pinpoint
|
|
3519
3612
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
3520
3613
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
3521
3614
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
3615
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
3522
3616
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
3523
3617
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
3524
3618
|
# resp.campaign_response.application_id #=> String
|
@@ -3631,6 +3725,7 @@ module Aws::Pinpoint
|
|
3631
3725
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
3632
3726
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
3633
3727
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
3728
|
+
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
3634
3729
|
# resp.campaign_response.treatment_description #=> String
|
3635
3730
|
# resp.campaign_response.treatment_name #=> String
|
3636
3731
|
# resp.campaign_response.version #=> Integer
|
@@ -3869,6 +3964,7 @@ module Aws::Pinpoint
|
|
3869
3964
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
3870
3965
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
3871
3966
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
3967
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
3872
3968
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
3873
3969
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
3874
3970
|
# resp.campaign_response.application_id #=> String
|
@@ -3981,6 +4077,7 @@ module Aws::Pinpoint
|
|
3981
4077
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
3982
4078
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
3983
4079
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
4080
|
+
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
3984
4081
|
# resp.campaign_response.treatment_description #=> String
|
3985
4082
|
# resp.campaign_response.treatment_name #=> String
|
3986
4083
|
# resp.campaign_response.version #=> Integer
|
@@ -4113,6 +4210,7 @@ module Aws::Pinpoint
|
|
4113
4210
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
|
4114
4211
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
|
4115
4212
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
|
4213
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.name #=> String
|
4116
4214
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
|
4117
4215
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
|
4118
4216
|
# resp.campaigns_response.item[0].application_id #=> String
|
@@ -4225,6 +4323,7 @@ module Aws::Pinpoint
|
|
4225
4323
|
# resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
|
4226
4324
|
# resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
|
4227
4325
|
# resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
|
4326
|
+
# resp.campaigns_response.item[0].template_configuration.voice_template.name #=> String
|
4228
4327
|
# resp.campaigns_response.item[0].treatment_description #=> String
|
4229
4328
|
# resp.campaigns_response.item[0].treatment_name #=> String
|
4230
4329
|
# resp.campaigns_response.item[0].version #=> Integer
|
@@ -4356,6 +4455,7 @@ module Aws::Pinpoint
|
|
4356
4455
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.email_template.name #=> String
|
4357
4456
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.push_template.name #=> String
|
4358
4457
|
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.sms_template.name #=> String
|
4458
|
+
# resp.campaigns_response.item[0].additional_treatments[0].template_configuration.voice_template.name #=> String
|
4359
4459
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
|
4360
4460
|
# resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
|
4361
4461
|
# resp.campaigns_response.item[0].application_id #=> String
|
@@ -4468,6 +4568,7 @@ module Aws::Pinpoint
|
|
4468
4568
|
# resp.campaigns_response.item[0].template_configuration.email_template.name #=> String
|
4469
4569
|
# resp.campaigns_response.item[0].template_configuration.push_template.name #=> String
|
4470
4570
|
# resp.campaigns_response.item[0].template_configuration.sms_template.name #=> String
|
4571
|
+
# resp.campaigns_response.item[0].template_configuration.voice_template.name #=> String
|
4471
4572
|
# resp.campaigns_response.item[0].treatment_description #=> String
|
4472
4573
|
# resp.campaigns_response.item[0].treatment_name #=> String
|
4473
4574
|
# resp.campaigns_response.item[0].version #=> Integer
|
@@ -4580,11 +4681,13 @@ module Aws::Pinpoint
|
|
4580
4681
|
#
|
4581
4682
|
# resp.email_template_response.arn #=> String
|
4582
4683
|
# resp.email_template_response.creation_date #=> String
|
4684
|
+
# resp.email_template_response.default_substitutions #=> String
|
4583
4685
|
# resp.email_template_response.html_part #=> String
|
4584
4686
|
# resp.email_template_response.last_modified_date #=> String
|
4585
4687
|
# resp.email_template_response.subject #=> String
|
4586
4688
|
# resp.email_template_response.tags #=> Hash
|
4587
4689
|
# resp.email_template_response.tags["__string"] #=> String
|
4690
|
+
# resp.email_template_response.template_description #=> String
|
4588
4691
|
# resp.email_template_response.template_name #=> String
|
4589
4692
|
# resp.email_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
4590
4693
|
# resp.email_template_response.text_part #=> String
|
@@ -5279,6 +5382,7 @@ module Aws::Pinpoint
|
|
5279
5382
|
# resp.push_notification_template_response.adm.body #=> String
|
5280
5383
|
# resp.push_notification_template_response.adm.image_icon_url #=> String
|
5281
5384
|
# resp.push_notification_template_response.adm.image_url #=> String
|
5385
|
+
# resp.push_notification_template_response.adm.raw_content #=> String
|
5282
5386
|
# resp.push_notification_template_response.adm.small_image_icon_url #=> String
|
5283
5387
|
# resp.push_notification_template_response.adm.sound #=> String
|
5284
5388
|
# resp.push_notification_template_response.adm.title #=> String
|
@@ -5286,6 +5390,7 @@ module Aws::Pinpoint
|
|
5286
5390
|
# resp.push_notification_template_response.apns.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
5287
5391
|
# resp.push_notification_template_response.apns.body #=> String
|
5288
5392
|
# resp.push_notification_template_response.apns.media_url #=> String
|
5393
|
+
# resp.push_notification_template_response.apns.raw_content #=> String
|
5289
5394
|
# resp.push_notification_template_response.apns.sound #=> String
|
5290
5395
|
# resp.push_notification_template_response.apns.title #=> String
|
5291
5396
|
# resp.push_notification_template_response.apns.url #=> String
|
@@ -5294,6 +5399,7 @@ module Aws::Pinpoint
|
|
5294
5399
|
# resp.push_notification_template_response.baidu.body #=> String
|
5295
5400
|
# resp.push_notification_template_response.baidu.image_icon_url #=> String
|
5296
5401
|
# resp.push_notification_template_response.baidu.image_url #=> String
|
5402
|
+
# resp.push_notification_template_response.baidu.raw_content #=> String
|
5297
5403
|
# resp.push_notification_template_response.baidu.small_image_icon_url #=> String
|
5298
5404
|
# resp.push_notification_template_response.baidu.sound #=> String
|
5299
5405
|
# resp.push_notification_template_response.baidu.title #=> String
|
@@ -5304,10 +5410,12 @@ module Aws::Pinpoint
|
|
5304
5410
|
# resp.push_notification_template_response.default.sound #=> String
|
5305
5411
|
# resp.push_notification_template_response.default.title #=> String
|
5306
5412
|
# resp.push_notification_template_response.default.url #=> String
|
5413
|
+
# resp.push_notification_template_response.default_substitutions #=> String
|
5307
5414
|
# resp.push_notification_template_response.gcm.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
5308
5415
|
# resp.push_notification_template_response.gcm.body #=> String
|
5309
5416
|
# resp.push_notification_template_response.gcm.image_icon_url #=> String
|
5310
5417
|
# resp.push_notification_template_response.gcm.image_url #=> String
|
5418
|
+
# resp.push_notification_template_response.gcm.raw_content #=> String
|
5311
5419
|
# resp.push_notification_template_response.gcm.small_image_icon_url #=> String
|
5312
5420
|
# resp.push_notification_template_response.gcm.sound #=> String
|
5313
5421
|
# resp.push_notification_template_response.gcm.title #=> String
|
@@ -5315,6 +5423,7 @@ module Aws::Pinpoint
|
|
5315
5423
|
# resp.push_notification_template_response.last_modified_date #=> String
|
5316
5424
|
# resp.push_notification_template_response.tags #=> Hash
|
5317
5425
|
# resp.push_notification_template_response.tags["__string"] #=> String
|
5426
|
+
# resp.push_notification_template_response.template_description #=> String
|
5318
5427
|
# resp.push_notification_template_response.template_name #=> String
|
5319
5428
|
# resp.push_notification_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
5320
5429
|
#
|
@@ -6037,9 +6146,11 @@ module Aws::Pinpoint
|
|
6037
6146
|
# resp.sms_template_response.arn #=> String
|
6038
6147
|
# resp.sms_template_response.body #=> String
|
6039
6148
|
# resp.sms_template_response.creation_date #=> String
|
6149
|
+
# resp.sms_template_response.default_substitutions #=> String
|
6040
6150
|
# resp.sms_template_response.last_modified_date #=> String
|
6041
6151
|
# resp.sms_template_response.tags #=> Hash
|
6042
6152
|
# resp.sms_template_response.tags["__string"] #=> String
|
6153
|
+
# resp.sms_template_response.template_description #=> String
|
6043
6154
|
# resp.sms_template_response.template_name #=> String
|
6044
6155
|
# resp.sms_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
6045
6156
|
#
|
@@ -6153,6 +6264,45 @@ module Aws::Pinpoint
|
|
6153
6264
|
req.send_request(options)
|
6154
6265
|
end
|
6155
6266
|
|
6267
|
+
# Retrieves the content and settings for a message template that you can
|
6268
|
+
# use in messages that are sent through the voice channel.
|
6269
|
+
#
|
6270
|
+
# @option params [required, String] :template_name
|
6271
|
+
#
|
6272
|
+
# @return [Types::GetVoiceTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6273
|
+
#
|
6274
|
+
# * {Types::GetVoiceTemplateResponse#voice_template_response #voice_template_response} => Types::VoiceTemplateResponse
|
6275
|
+
#
|
6276
|
+
# @example Request syntax with placeholder values
|
6277
|
+
#
|
6278
|
+
# resp = client.get_voice_template({
|
6279
|
+
# template_name: "__string", # required
|
6280
|
+
# })
|
6281
|
+
#
|
6282
|
+
# @example Response structure
|
6283
|
+
#
|
6284
|
+
# resp.voice_template_response.arn #=> String
|
6285
|
+
# resp.voice_template_response.body #=> String
|
6286
|
+
# resp.voice_template_response.creation_date #=> String
|
6287
|
+
# resp.voice_template_response.default_substitutions #=> String
|
6288
|
+
# resp.voice_template_response.language_code #=> String
|
6289
|
+
# resp.voice_template_response.last_modified_date #=> String
|
6290
|
+
# resp.voice_template_response.tags #=> Hash
|
6291
|
+
# resp.voice_template_response.tags["__string"] #=> String
|
6292
|
+
# resp.voice_template_response.template_description #=> String
|
6293
|
+
# resp.voice_template_response.template_name #=> String
|
6294
|
+
# resp.voice_template_response.template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
6295
|
+
# resp.voice_template_response.voice_id #=> String
|
6296
|
+
#
|
6297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetVoiceTemplate AWS API Documentation
|
6298
|
+
#
|
6299
|
+
# @overload get_voice_template(params = {})
|
6300
|
+
# @param [Hash] params ({})
|
6301
|
+
def get_voice_template(params = {}, options = {})
|
6302
|
+
req = build_request(:get_voice_template, params)
|
6303
|
+
req.send_request(options)
|
6304
|
+
end
|
6305
|
+
|
6156
6306
|
# Retrieves information about the status, configuration, and other
|
6157
6307
|
# settings for all the journeys that are associated with an application.
|
6158
6308
|
#
|
@@ -6389,9 +6539,11 @@ module Aws::Pinpoint
|
|
6389
6539
|
# resp.templates_response.item #=> Array
|
6390
6540
|
# resp.templates_response.item[0].arn #=> String
|
6391
6541
|
# resp.templates_response.item[0].creation_date #=> String
|
6542
|
+
# resp.templates_response.item[0].default_substitutions #=> String
|
6392
6543
|
# resp.templates_response.item[0].last_modified_date #=> String
|
6393
6544
|
# resp.templates_response.item[0].tags #=> Hash
|
6394
6545
|
# resp.templates_response.item[0].tags["__string"] #=> String
|
6546
|
+
# resp.templates_response.item[0].template_description #=> String
|
6395
6547
|
# resp.templates_response.item[0].template_name #=> String
|
6396
6548
|
# resp.templates_response.item[0].template_type #=> String, one of "EMAIL", "SMS", "VOICE", "PUSH"
|
6397
6549
|
# resp.templates_response.next_token #=> String
|
@@ -6640,8 +6792,7 @@ module Aws::Pinpoint
|
|
6640
6792
|
# @option params [required, String] :application_id
|
6641
6793
|
#
|
6642
6794
|
# @option params [required, Types::MessageRequest] :message_request
|
6643
|
-
# Specifies the
|
6644
|
-
# a message.
|
6795
|
+
# Specifies the configuration and other settings for a message.
|
6645
6796
|
#
|
6646
6797
|
# @return [Types::SendMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6647
6798
|
#
|
@@ -6847,6 +6998,9 @@ module Aws::Pinpoint
|
|
6847
6998
|
# sms_template: {
|
6848
6999
|
# name: "__string",
|
6849
7000
|
# },
|
7001
|
+
# voice_template: {
|
7002
|
+
# name: "__string",
|
7003
|
+
# },
|
6850
7004
|
# },
|
6851
7005
|
# trace_id: "__string",
|
6852
7006
|
# },
|
@@ -7064,6 +7218,9 @@ module Aws::Pinpoint
|
|
7064
7218
|
# sms_template: {
|
7065
7219
|
# name: "__string",
|
7066
7220
|
# },
|
7221
|
+
# voice_template: {
|
7222
|
+
# name: "__string",
|
7223
|
+
# },
|
7067
7224
|
# },
|
7068
7225
|
# trace_id: "__string",
|
7069
7226
|
# users: { # required
|
@@ -7671,6 +7828,9 @@ module Aws::Pinpoint
|
|
7671
7828
|
# sms_template: {
|
7672
7829
|
# name: "__string",
|
7673
7830
|
# },
|
7831
|
+
# voice_template: {
|
7832
|
+
# name: "__string",
|
7833
|
+
# },
|
7674
7834
|
# },
|
7675
7835
|
# treatment_description: "__string",
|
7676
7836
|
# treatment_name: "__string",
|
@@ -7821,6 +7981,9 @@ module Aws::Pinpoint
|
|
7821
7981
|
# sms_template: {
|
7822
7982
|
# name: "__string",
|
7823
7983
|
# },
|
7984
|
+
# voice_template: {
|
7985
|
+
# name: "__string",
|
7986
|
+
# },
|
7824
7987
|
# },
|
7825
7988
|
# treatment_description: "__string",
|
7826
7989
|
# treatment_name: "__string",
|
@@ -7921,6 +8084,7 @@ module Aws::Pinpoint
|
|
7921
8084
|
# resp.campaign_response.additional_treatments[0].template_configuration.email_template.name #=> String
|
7922
8085
|
# resp.campaign_response.additional_treatments[0].template_configuration.push_template.name #=> String
|
7923
8086
|
# resp.campaign_response.additional_treatments[0].template_configuration.sms_template.name #=> String
|
8087
|
+
# resp.campaign_response.additional_treatments[0].template_configuration.voice_template.name #=> String
|
7924
8088
|
# resp.campaign_response.additional_treatments[0].treatment_description #=> String
|
7925
8089
|
# resp.campaign_response.additional_treatments[0].treatment_name #=> String
|
7926
8090
|
# resp.campaign_response.application_id #=> String
|
@@ -8033,6 +8197,7 @@ module Aws::Pinpoint
|
|
8033
8197
|
# resp.campaign_response.template_configuration.email_template.name #=> String
|
8034
8198
|
# resp.campaign_response.template_configuration.push_template.name #=> String
|
8035
8199
|
# resp.campaign_response.template_configuration.sms_template.name #=> String
|
8200
|
+
# resp.campaign_response.template_configuration.voice_template.name #=> String
|
8036
8201
|
# resp.campaign_response.treatment_description #=> String
|
8037
8202
|
# resp.campaign_response.treatment_name #=> String
|
8038
8203
|
# resp.campaign_response.version #=> Integer
|
@@ -8116,11 +8281,13 @@ module Aws::Pinpoint
|
|
8116
8281
|
#
|
8117
8282
|
# resp = client.update_email_template({
|
8118
8283
|
# email_template_request: { # required
|
8284
|
+
# default_substitutions: "__string",
|
8119
8285
|
# html_part: "__string",
|
8120
8286
|
# subject: "__string",
|
8121
8287
|
# tags: {
|
8122
8288
|
# "__string" => "__string",
|
8123
8289
|
# },
|
8290
|
+
# template_description: "__string",
|
8124
8291
|
# text_part: "__string",
|
8125
8292
|
# },
|
8126
8293
|
# template_name: "__string", # required
|
@@ -8984,6 +9151,7 @@ module Aws::Pinpoint
|
|
8984
9151
|
# body: "__string",
|
8985
9152
|
# image_icon_url: "__string",
|
8986
9153
|
# image_url: "__string",
|
9154
|
+
# raw_content: "__string",
|
8987
9155
|
# small_image_icon_url: "__string",
|
8988
9156
|
# sound: "__string",
|
8989
9157
|
# title: "__string",
|
@@ -8993,6 +9161,7 @@ module Aws::Pinpoint
|
|
8993
9161
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
8994
9162
|
# body: "__string",
|
8995
9163
|
# media_url: "__string",
|
9164
|
+
# raw_content: "__string",
|
8996
9165
|
# sound: "__string",
|
8997
9166
|
# title: "__string",
|
8998
9167
|
# url: "__string",
|
@@ -9002,6 +9171,7 @@ module Aws::Pinpoint
|
|
9002
9171
|
# body: "__string",
|
9003
9172
|
# image_icon_url: "__string",
|
9004
9173
|
# image_url: "__string",
|
9174
|
+
# raw_content: "__string",
|
9005
9175
|
# small_image_icon_url: "__string",
|
9006
9176
|
# sound: "__string",
|
9007
9177
|
# title: "__string",
|
@@ -9014,11 +9184,13 @@ module Aws::Pinpoint
|
|
9014
9184
|
# title: "__string",
|
9015
9185
|
# url: "__string",
|
9016
9186
|
# },
|
9187
|
+
# default_substitutions: "__string",
|
9017
9188
|
# gcm: {
|
9018
9189
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
9019
9190
|
# body: "__string",
|
9020
9191
|
# image_icon_url: "__string",
|
9021
9192
|
# image_url: "__string",
|
9193
|
+
# raw_content: "__string",
|
9022
9194
|
# small_image_icon_url: "__string",
|
9023
9195
|
# sound: "__string",
|
9024
9196
|
# title: "__string",
|
@@ -9027,6 +9199,7 @@ module Aws::Pinpoint
|
|
9027
9199
|
# tags: {
|
9028
9200
|
# "__string" => "__string",
|
9029
9201
|
# },
|
9202
|
+
# template_description: "__string",
|
9030
9203
|
# },
|
9031
9204
|
# template_name: "__string", # required
|
9032
9205
|
# })
|
@@ -9401,9 +9574,11 @@ module Aws::Pinpoint
|
|
9401
9574
|
# resp = client.update_sms_template({
|
9402
9575
|
# sms_template_request: { # required
|
9403
9576
|
# body: "__string",
|
9577
|
+
# default_substitutions: "__string",
|
9404
9578
|
# tags: {
|
9405
9579
|
# "__string" => "__string",
|
9406
9580
|
# },
|
9581
|
+
# template_description: "__string",
|
9407
9582
|
# },
|
9408
9583
|
# template_name: "__string", # required
|
9409
9584
|
# })
|
@@ -9466,6 +9641,49 @@ module Aws::Pinpoint
|
|
9466
9641
|
req.send_request(options)
|
9467
9642
|
end
|
9468
9643
|
|
9644
|
+
# Updates an existing message template that you can use in messages that
|
9645
|
+
# are sent through the voice channel.
|
9646
|
+
#
|
9647
|
+
# @option params [required, String] :template_name
|
9648
|
+
#
|
9649
|
+
# @option params [required, Types::VoiceTemplateRequest] :voice_template_request
|
9650
|
+
# Specifies the content and settings for a message template that can be
|
9651
|
+
# used in messages that are sent through the voice channel.
|
9652
|
+
#
|
9653
|
+
# @return [Types::UpdateVoiceTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9654
|
+
#
|
9655
|
+
# * {Types::UpdateVoiceTemplateResponse#message_body #message_body} => Types::MessageBody
|
9656
|
+
#
|
9657
|
+
# @example Request syntax with placeholder values
|
9658
|
+
#
|
9659
|
+
# resp = client.update_voice_template({
|
9660
|
+
# template_name: "__string", # required
|
9661
|
+
# voice_template_request: { # required
|
9662
|
+
# body: "__string",
|
9663
|
+
# default_substitutions: "__string",
|
9664
|
+
# language_code: "__string",
|
9665
|
+
# tags: {
|
9666
|
+
# "__string" => "__string",
|
9667
|
+
# },
|
9668
|
+
# template_description: "__string",
|
9669
|
+
# voice_id: "__string",
|
9670
|
+
# },
|
9671
|
+
# })
|
9672
|
+
#
|
9673
|
+
# @example Response structure
|
9674
|
+
#
|
9675
|
+
# resp.message_body.message #=> String
|
9676
|
+
# resp.message_body.request_id #=> String
|
9677
|
+
#
|
9678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateVoiceTemplate AWS API Documentation
|
9679
|
+
#
|
9680
|
+
# @overload update_voice_template(params = {})
|
9681
|
+
# @param [Hash] params ({})
|
9682
|
+
def update_voice_template(params = {}, options = {})
|
9683
|
+
req = build_request(:update_voice_template, params)
|
9684
|
+
req.send_request(options)
|
9685
|
+
end
|
9686
|
+
|
9469
9687
|
# @!endgroup
|
9470
9688
|
|
9471
9689
|
# @param params ({})
|
@@ -9479,7 +9697,7 @@ module Aws::Pinpoint
|
|
9479
9697
|
params: params,
|
9480
9698
|
config: config)
|
9481
9699
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
9482
|
-
context[:gem_version] = '1.
|
9700
|
+
context[:gem_version] = '1.31.0'
|
9483
9701
|
Seahorse::Client::Request.new(handlers, context)
|
9484
9702
|
end
|
9485
9703
|
|