aws-sdk-pinpoint 1.48.0 → 1.53.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +338 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-pinpoint.rb +2 -2
- data/lib/aws-sdk-pinpoint/client.rb +106 -12
- data/lib/aws-sdk-pinpoint/client_api.rb +12 -1
- data/lib/aws-sdk-pinpoint/errors.rb +1 -1
- data/lib/aws-sdk-pinpoint/resource.rb +1 -1
- data/lib/aws-sdk-pinpoint/types.rb +162 -16
- metadata +10 -7
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -840,7 +840,10 @@ module Aws::Pinpoint
|
|
840
840
|
|
841
841
|
CampaignSmsMessage.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
|
842
842
|
CampaignSmsMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
843
|
+
CampaignSmsMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
843
844
|
CampaignSmsMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
845
|
+
CampaignSmsMessage.add_member(:entity_id, Shapes::ShapeRef.new(shape: __string, location_name: "EntityId"))
|
846
|
+
CampaignSmsMessage.add_member(:template_id, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateId"))
|
844
847
|
CampaignSmsMessage.struct_class = Types::CampaignSmsMessage
|
845
848
|
|
846
849
|
CampaignState.add_member(:campaign_status, Shapes::ShapeRef.new(shape: CampaignStatus, location_name: "CampaignStatus"))
|
@@ -2028,6 +2031,7 @@ module Aws::Pinpoint
|
|
2028
2031
|
JourneyLimits.add_member(:daily_cap, Shapes::ShapeRef.new(shape: __integer, location_name: "DailyCap"))
|
2029
2032
|
JourneyLimits.add_member(:endpoint_reentry_cap, Shapes::ShapeRef.new(shape: __integer, location_name: "EndpointReentryCap"))
|
2030
2033
|
JourneyLimits.add_member(:messages_per_second, Shapes::ShapeRef.new(shape: __integer, location_name: "MessagesPerSecond"))
|
2034
|
+
JourneyLimits.add_member(:endpoint_reentry_interval, Shapes::ShapeRef.new(shape: __string, location_name: "EndpointReentryInterval"))
|
2031
2035
|
JourneyLimits.struct_class = Types::JourneyLimits
|
2032
2036
|
|
2033
2037
|
JourneyPushMessage.add_member(:time_to_live, Shapes::ShapeRef.new(shape: __string, location_name: "TimeToLive"))
|
@@ -2051,7 +2055,10 @@ module Aws::Pinpoint
|
|
2051
2055
|
JourneyResponse.struct_class = Types::JourneyResponse
|
2052
2056
|
|
2053
2057
|
JourneySMSMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
2058
|
+
JourneySMSMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
2054
2059
|
JourneySMSMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
2060
|
+
JourneySMSMessage.add_member(:entity_id, Shapes::ShapeRef.new(shape: __string, location_name: "EntityId"))
|
2061
|
+
JourneySMSMessage.add_member(:template_id, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateId"))
|
2055
2062
|
JourneySMSMessage.struct_class = Types::JourneySMSMessage
|
2056
2063
|
|
2057
2064
|
JourneySchedule.add_member(:end_time, Shapes::ShapeRef.new(shape: __timestampIso8601, location_name: "EndTime"))
|
@@ -2463,6 +2470,8 @@ module Aws::Pinpoint
|
|
2463
2470
|
SMSMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
2464
2471
|
SMSMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
2465
2472
|
SMSMessage.add_member(:substitutions, Shapes::ShapeRef.new(shape: MapOfListOf__string, location_name: "Substitutions"))
|
2473
|
+
SMSMessage.add_member(:entity_id, Shapes::ShapeRef.new(shape: __string, location_name: "EntityId"))
|
2474
|
+
SMSMessage.add_member(:template_id, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateId"))
|
2466
2475
|
SMSMessage.struct_class = Types::SMSMessage
|
2467
2476
|
|
2468
2477
|
SMSMessageActivity.add_member(:message_config, Shapes::ShapeRef.new(shape: JourneySMSMessage, location_name: "MessageConfig"))
|
@@ -3073,6 +3082,8 @@ module Aws::Pinpoint
|
|
3073
3082
|
WriteJourneyRequest.add_member(:start_activity, Shapes::ShapeRef.new(shape: __string, location_name: "StartActivity"))
|
3074
3083
|
WriteJourneyRequest.add_member(:start_condition, Shapes::ShapeRef.new(shape: StartCondition, location_name: "StartCondition"))
|
3075
3084
|
WriteJourneyRequest.add_member(:state, Shapes::ShapeRef.new(shape: State, location_name: "State"))
|
3085
|
+
WriteJourneyRequest.add_member(:wait_for_quiet_time, Shapes::ShapeRef.new(shape: __boolean, location_name: "WaitForQuietTime"))
|
3086
|
+
WriteJourneyRequest.add_member(:refresh_on_segment_update, Shapes::ShapeRef.new(shape: __boolean, location_name: "RefreshOnSegmentUpdate"))
|
3076
3087
|
WriteJourneyRequest.struct_class = Types::WriteJourneyRequest
|
3077
3088
|
|
3078
3089
|
WriteSegmentRequest.add_member(:dimensions, Shapes::ShapeRef.new(shape: SegmentDimensions, location_name: "Dimensions"))
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -1499,7 +1499,10 @@ module Aws::Pinpoint
|
|
1499
1499
|
# sms: {
|
1500
1500
|
# message_config: {
|
1501
1501
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
1502
|
+
# origination_number: "__string",
|
1502
1503
|
# sender_id: "__string",
|
1504
|
+
# entity_id: "__string",
|
1505
|
+
# template_id: "__string",
|
1503
1506
|
# },
|
1504
1507
|
# next_activity: "__string",
|
1505
1508
|
# template_name: "__string",
|
@@ -2798,7 +2801,10 @@ module Aws::Pinpoint
|
|
2798
2801
|
# {
|
2799
2802
|
# body: "__string",
|
2800
2803
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
2804
|
+
# origination_number: "__string",
|
2801
2805
|
# sender_id: "__string",
|
2806
|
+
# entity_id: "__string",
|
2807
|
+
# template_id: "__string",
|
2802
2808
|
# }
|
2803
2809
|
#
|
2804
2810
|
# @!attribute [rw] body
|
@@ -2812,17 +2818,38 @@ module Aws::Pinpoint
|
|
2812
2818
|
# time-sensitive, such as marketing messages).
|
2813
2819
|
# @return [String]
|
2814
2820
|
#
|
2821
|
+
# @!attribute [rw] origination_number
|
2822
|
+
# The long code to send the SMS message from. This value should be one
|
2823
|
+
# of the dedicated long codes that's assigned to your AWS account.
|
2824
|
+
# Although it isn't required, we recommend that you specify the long
|
2825
|
+
# code using an E.164 format to ensure prompt and accurate delivery of
|
2826
|
+
# the message. For example, +12065550100.
|
2827
|
+
# @return [String]
|
2828
|
+
#
|
2815
2829
|
# @!attribute [rw] sender_id
|
2816
2830
|
# The sender ID to display on recipients' devices when they receive
|
2817
2831
|
# the SMS message.
|
2818
2832
|
# @return [String]
|
2819
2833
|
#
|
2834
|
+
# @!attribute [rw] entity_id
|
2835
|
+
# The entity ID or Principal Entity (PE) id received from the
|
2836
|
+
# regulatory body for sending SMS in your country.
|
2837
|
+
# @return [String]
|
2838
|
+
#
|
2839
|
+
# @!attribute [rw] template_id
|
2840
|
+
# The template ID received from the regulatory body for sending SMS in
|
2841
|
+
# your country.
|
2842
|
+
# @return [String]
|
2843
|
+
#
|
2820
2844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignSmsMessage AWS API Documentation
|
2821
2845
|
#
|
2822
2846
|
class CampaignSmsMessage < Struct.new(
|
2823
2847
|
:body,
|
2824
2848
|
:message_type,
|
2825
|
-
:
|
2849
|
+
:origination_number,
|
2850
|
+
:sender_id,
|
2851
|
+
:entity_id,
|
2852
|
+
:template_id)
|
2826
2853
|
SENSITIVE = []
|
2827
2854
|
include Aws::Structure
|
2828
2855
|
end
|
@@ -3408,7 +3435,10 @@ module Aws::Pinpoint
|
|
3408
3435
|
# sms_message: {
|
3409
3436
|
# body: "__string",
|
3410
3437
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3438
|
+
# origination_number: "__string",
|
3411
3439
|
# sender_id: "__string",
|
3440
|
+
# entity_id: "__string",
|
3441
|
+
# template_id: "__string",
|
3412
3442
|
# },
|
3413
3443
|
# },
|
3414
3444
|
# schedule: {
|
@@ -3567,7 +3597,10 @@ module Aws::Pinpoint
|
|
3567
3597
|
# sms_message: {
|
3568
3598
|
# body: "__string",
|
3569
3599
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3600
|
+
# origination_number: "__string",
|
3570
3601
|
# sender_id: "__string",
|
3602
|
+
# entity_id: "__string",
|
3603
|
+
# template_id: "__string",
|
3571
3604
|
# },
|
3572
3605
|
# },
|
3573
3606
|
# name: "__string",
|
@@ -4060,7 +4093,10 @@ module Aws::Pinpoint
|
|
4060
4093
|
# sms: {
|
4061
4094
|
# message_config: {
|
4062
4095
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
4096
|
+
# origination_number: "__string",
|
4063
4097
|
# sender_id: "__string",
|
4098
|
+
# entity_id: "__string",
|
4099
|
+
# template_id: "__string",
|
4064
4100
|
# },
|
4065
4101
|
# next_activity: "__string",
|
4066
4102
|
# template_name: "__string",
|
@@ -4081,6 +4117,7 @@ module Aws::Pinpoint
|
|
4081
4117
|
# daily_cap: 1,
|
4082
4118
|
# endpoint_reentry_cap: 1,
|
4083
4119
|
# messages_per_second: 1,
|
4120
|
+
# endpoint_reentry_interval: "__string",
|
4084
4121
|
# },
|
4085
4122
|
# local_time: false,
|
4086
4123
|
# name: "__string", # required
|
@@ -4125,7 +4162,9 @@ module Aws::Pinpoint
|
|
4125
4162
|
# segment_id: "__string", # required
|
4126
4163
|
# },
|
4127
4164
|
# },
|
4128
|
-
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
4165
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
4166
|
+
# wait_for_quiet_time: false,
|
4167
|
+
# refresh_on_segment_update: false,
|
4129
4168
|
# },
|
4130
4169
|
# }
|
4131
4170
|
#
|
@@ -5936,6 +5975,8 @@ module Aws::Pinpoint
|
|
5936
5975
|
# substitutions: {
|
5937
5976
|
# "__string" => ["__string"],
|
5938
5977
|
# },
|
5978
|
+
# entity_id: "__string",
|
5979
|
+
# template_id: "__string",
|
5939
5980
|
# },
|
5940
5981
|
# voice_message: {
|
5941
5982
|
# body: "__string",
|
@@ -10722,6 +10763,7 @@ module Aws::Pinpoint
|
|
10722
10763
|
# daily_cap: 1,
|
10723
10764
|
# endpoint_reentry_cap: 1,
|
10724
10765
|
# messages_per_second: 1,
|
10766
|
+
# endpoint_reentry_interval: "__string",
|
10725
10767
|
# }
|
10726
10768
|
#
|
10727
10769
|
# @!attribute [rw] daily_cap
|
@@ -10740,12 +10782,16 @@ module Aws::Pinpoint
|
|
10740
10782
|
# second.
|
10741
10783
|
# @return [Integer]
|
10742
10784
|
#
|
10785
|
+
# @!attribute [rw] endpoint_reentry_interval
|
10786
|
+
# @return [String]
|
10787
|
+
#
|
10743
10788
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyLimits AWS API Documentation
|
10744
10789
|
#
|
10745
10790
|
class JourneyLimits < Struct.new(
|
10746
10791
|
:daily_cap,
|
10747
10792
|
:endpoint_reentry_cap,
|
10748
|
-
:messages_per_second
|
10793
|
+
:messages_per_second,
|
10794
|
+
:endpoint_reentry_interval)
|
10749
10795
|
SENSITIVE = []
|
10750
10796
|
include Aws::Structure
|
10751
10797
|
end
|
@@ -10871,6 +10917,10 @@ module Aws::Pinpoint
|
|
10871
10917
|
# status is ACTIVE, you can't add, change, or remove activities
|
10872
10918
|
# from it.
|
10873
10919
|
#
|
10920
|
+
# * PAUSED - The journey has been paused. Amazon Pinpoint continues to
|
10921
|
+
# perform activities that are currently in progress, until those
|
10922
|
+
# activities are complete.
|
10923
|
+
#
|
10874
10924
|
# * COMPLETED - The journey has been published and has finished
|
10875
10925
|
# running. All participants have entered the journey and no
|
10876
10926
|
# participants are waiting to complete the journey or any activities
|
@@ -10924,7 +10974,10 @@ module Aws::Pinpoint
|
|
10924
10974
|
#
|
10925
10975
|
# {
|
10926
10976
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
10977
|
+
# origination_number: "__string",
|
10927
10978
|
# sender_id: "__string",
|
10979
|
+
# entity_id: "__string",
|
10980
|
+
# template_id: "__string",
|
10928
10981
|
# }
|
10929
10982
|
#
|
10930
10983
|
# @!attribute [rw] message_type
|
@@ -10934,6 +10987,14 @@ module Aws::Pinpoint
|
|
10934
10987
|
# time-sensitive, such as marketing messages).
|
10935
10988
|
# @return [String]
|
10936
10989
|
#
|
10990
|
+
# @!attribute [rw] origination_number
|
10991
|
+
# The long code to send the SMS message from. This value should be one
|
10992
|
+
# of the dedicated long codes that's assigned to your AWS account.
|
10993
|
+
# Although it isn't required, we recommend that you specify the long
|
10994
|
+
# code using an E.164 format to ensure prompt and accurate delivery of
|
10995
|
+
# the message. For example, +12065550100.
|
10996
|
+
# @return [String]
|
10997
|
+
#
|
10937
10998
|
# @!attribute [rw] sender_id
|
10938
10999
|
# The sender ID to display as the sender of the message on a
|
10939
11000
|
# recipient's device. Support for sender IDs varies by country or
|
@@ -10945,11 +11006,24 @@ module Aws::Pinpoint
|
|
10945
11006
|
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html
|
10946
11007
|
# @return [String]
|
10947
11008
|
#
|
11009
|
+
# @!attribute [rw] entity_id
|
11010
|
+
# The entity ID or Principal Entity (PE) id received from the
|
11011
|
+
# regulatory body for sending SMS in your country.
|
11012
|
+
# @return [String]
|
11013
|
+
#
|
11014
|
+
# @!attribute [rw] template_id
|
11015
|
+
# The template ID received from the regulatory body for sending SMS in
|
11016
|
+
# your country.
|
11017
|
+
# @return [String]
|
11018
|
+
#
|
10948
11019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneySMSMessage AWS API Documentation
|
10949
11020
|
#
|
10950
11021
|
class JourneySMSMessage < Struct.new(
|
10951
11022
|
:message_type,
|
10952
|
-
:
|
11023
|
+
:origination_number,
|
11024
|
+
:sender_id,
|
11025
|
+
:entity_id,
|
11026
|
+
:template_id)
|
10953
11027
|
SENSITIVE = []
|
10954
11028
|
include Aws::Structure
|
10955
11029
|
end
|
@@ -11002,12 +11076,12 @@ module Aws::Pinpoint
|
|
11002
11076
|
# data as a hash:
|
11003
11077
|
#
|
11004
11078
|
# {
|
11005
|
-
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
11079
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
11006
11080
|
# }
|
11007
11081
|
#
|
11008
11082
|
# @!attribute [rw] state
|
11009
|
-
# The status of the journey. Currently,
|
11010
|
-
# CANCELLED
|
11083
|
+
# The status of the journey. Currently, Supported values are ACTIVE,
|
11084
|
+
# PAUSED, and CANCELLED
|
11011
11085
|
#
|
11012
11086
|
# If you cancel a journey, Amazon Pinpoint continues to perform
|
11013
11087
|
# activities that are currently in progress, until those activities
|
@@ -11020,6 +11094,14 @@ module Aws::Pinpoint
|
|
11020
11094
|
# activities from the journey. In addition, Amazon Pinpoint stops
|
11021
11095
|
# evaluating the journey and doesn't perform any activities that
|
11022
11096
|
# haven't started.
|
11097
|
+
#
|
11098
|
+
# When the journey is paused, Amazon Pinpoint continues to perform
|
11099
|
+
# activities that are currently in progress, until those activities
|
11100
|
+
# are complete. Endpoints will stop entering journeys when the journey
|
11101
|
+
# is paused and will resume entering the journey after the journey is
|
11102
|
+
# resumed. For wait activities, wait time is paused when the journey
|
11103
|
+
# is paused. Currently, PAUSED only supports journeys with a segment
|
11104
|
+
# refresh interval.
|
11023
11105
|
# @return [String]
|
11024
11106
|
#
|
11025
11107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyStateRequest AWS API Documentation
|
@@ -11467,7 +11549,10 @@ module Aws::Pinpoint
|
|
11467
11549
|
# sms_message: {
|
11468
11550
|
# body: "__string",
|
11469
11551
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
11552
|
+
# origination_number: "__string",
|
11470
11553
|
# sender_id: "__string",
|
11554
|
+
# entity_id: "__string",
|
11555
|
+
# template_id: "__string",
|
11471
11556
|
# },
|
11472
11557
|
# }
|
11473
11558
|
#
|
@@ -11715,6 +11800,8 @@ module Aws::Pinpoint
|
|
11715
11800
|
# substitutions: {
|
11716
11801
|
# "__string" => ["__string"],
|
11717
11802
|
# },
|
11803
|
+
# entity_id: "__string",
|
11804
|
+
# template_id: "__string",
|
11718
11805
|
# },
|
11719
11806
|
# voice_message: {
|
11720
11807
|
# body: "__string",
|
@@ -13509,6 +13596,8 @@ module Aws::Pinpoint
|
|
13509
13596
|
# substitutions: {
|
13510
13597
|
# "__string" => ["__string"],
|
13511
13598
|
# },
|
13599
|
+
# entity_id: "__string",
|
13600
|
+
# template_id: "__string",
|
13512
13601
|
# }
|
13513
13602
|
#
|
13514
13603
|
# @!attribute [rw] body
|
@@ -13550,6 +13639,16 @@ module Aws::Pinpoint
|
|
13550
13639
|
# the default variables with individual address variables.
|
13551
13640
|
# @return [Hash<String,Array<String>>]
|
13552
13641
|
#
|
13642
|
+
# @!attribute [rw] entity_id
|
13643
|
+
# The entity ID or Principal Entity (PE) id received from the
|
13644
|
+
# regulatory body for sending SMS in your country.
|
13645
|
+
# @return [String]
|
13646
|
+
#
|
13647
|
+
# @!attribute [rw] template_id
|
13648
|
+
# The template ID received from the regulatory body for sending SMS in
|
13649
|
+
# your country.
|
13650
|
+
# @return [String]
|
13651
|
+
#
|
13553
13652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSMessage AWS API Documentation
|
13554
13653
|
#
|
13555
13654
|
class SMSMessage < Struct.new(
|
@@ -13559,7 +13658,9 @@ module Aws::Pinpoint
|
|
13559
13658
|
:message_type,
|
13560
13659
|
:origination_number,
|
13561
13660
|
:sender_id,
|
13562
|
-
:substitutions
|
13661
|
+
:substitutions,
|
13662
|
+
:entity_id,
|
13663
|
+
:template_id)
|
13563
13664
|
SENSITIVE = []
|
13564
13665
|
include Aws::Structure
|
13565
13666
|
end
|
@@ -13573,7 +13674,10 @@ module Aws::Pinpoint
|
|
13573
13674
|
# {
|
13574
13675
|
# message_config: {
|
13575
13676
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
13677
|
+
# origination_number: "__string",
|
13576
13678
|
# sender_id: "__string",
|
13679
|
+
# entity_id: "__string",
|
13680
|
+
# template_id: "__string",
|
13577
13681
|
# },
|
13578
13682
|
# next_activity: "__string",
|
13579
13683
|
# template_name: "__string",
|
@@ -14744,6 +14848,8 @@ module Aws::Pinpoint
|
|
14744
14848
|
# substitutions: {
|
14745
14849
|
# "__string" => ["__string"],
|
14746
14850
|
# },
|
14851
|
+
# entity_id: "__string",
|
14852
|
+
# template_id: "__string",
|
14747
14853
|
# },
|
14748
14854
|
# voice_message: {
|
14749
14855
|
# body: "__string",
|
@@ -14961,6 +15067,8 @@ module Aws::Pinpoint
|
|
14961
15067
|
# substitutions: {
|
14962
15068
|
# "__string" => ["__string"],
|
14963
15069
|
# },
|
15070
|
+
# entity_id: "__string",
|
15071
|
+
# template_id: "__string",
|
14964
15072
|
# },
|
14965
15073
|
# voice_message: {
|
14966
15074
|
# body: "__string",
|
@@ -15234,6 +15342,8 @@ module Aws::Pinpoint
|
|
15234
15342
|
# substitutions: {
|
15235
15343
|
# "__string" => ["__string"],
|
15236
15344
|
# },
|
15345
|
+
# entity_id: "__string",
|
15346
|
+
# template_id: "__string",
|
15237
15347
|
# },
|
15238
15348
|
# voice_message: {
|
15239
15349
|
# body: "__string",
|
@@ -16561,7 +16671,10 @@ module Aws::Pinpoint
|
|
16561
16671
|
# sms_message: {
|
16562
16672
|
# body: "__string",
|
16563
16673
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
16674
|
+
# origination_number: "__string",
|
16564
16675
|
# sender_id: "__string",
|
16676
|
+
# entity_id: "__string",
|
16677
|
+
# template_id: "__string",
|
16565
16678
|
# },
|
16566
16679
|
# },
|
16567
16680
|
# schedule: {
|
@@ -16720,7 +16833,10 @@ module Aws::Pinpoint
|
|
16720
16833
|
# sms_message: {
|
16721
16834
|
# body: "__string",
|
16722
16835
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
16836
|
+
# origination_number: "__string",
|
16723
16837
|
# sender_id: "__string",
|
16838
|
+
# entity_id: "__string",
|
16839
|
+
# template_id: "__string",
|
16724
16840
|
# },
|
16725
16841
|
# },
|
16726
16842
|
# name: "__string",
|
@@ -17378,7 +17494,10 @@ module Aws::Pinpoint
|
|
17378
17494
|
# sms: {
|
17379
17495
|
# message_config: {
|
17380
17496
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
17497
|
+
# origination_number: "__string",
|
17381
17498
|
# sender_id: "__string",
|
17499
|
+
# entity_id: "__string",
|
17500
|
+
# template_id: "__string",
|
17382
17501
|
# },
|
17383
17502
|
# next_activity: "__string",
|
17384
17503
|
# template_name: "__string",
|
@@ -17399,6 +17518,7 @@ module Aws::Pinpoint
|
|
17399
17518
|
# daily_cap: 1,
|
17400
17519
|
# endpoint_reentry_cap: 1,
|
17401
17520
|
# messages_per_second: 1,
|
17521
|
+
# endpoint_reentry_interval: "__string",
|
17402
17522
|
# },
|
17403
17523
|
# local_time: false,
|
17404
17524
|
# name: "__string", # required
|
@@ -17443,7 +17563,9 @@ module Aws::Pinpoint
|
|
17443
17563
|
# segment_id: "__string", # required
|
17444
17564
|
# },
|
17445
17565
|
# },
|
17446
|
-
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
17566
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
17567
|
+
# wait_for_quiet_time: false,
|
17568
|
+
# refresh_on_segment_update: false,
|
17447
17569
|
# },
|
17448
17570
|
# }
|
17449
17571
|
#
|
@@ -17487,7 +17609,7 @@ module Aws::Pinpoint
|
|
17487
17609
|
# application_id: "__string", # required
|
17488
17610
|
# journey_id: "__string", # required
|
17489
17611
|
# journey_state_request: { # required
|
17490
|
-
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
17612
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
17491
17613
|
# },
|
17492
17614
|
# }
|
17493
17615
|
#
|
@@ -18838,7 +18960,10 @@ module Aws::Pinpoint
|
|
18838
18960
|
# sms_message: {
|
18839
18961
|
# body: "__string",
|
18840
18962
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
18963
|
+
# origination_number: "__string",
|
18841
18964
|
# sender_id: "__string",
|
18965
|
+
# entity_id: "__string",
|
18966
|
+
# template_id: "__string",
|
18842
18967
|
# },
|
18843
18968
|
# },
|
18844
18969
|
# schedule: {
|
@@ -18997,7 +19122,10 @@ module Aws::Pinpoint
|
|
18997
19122
|
# sms_message: {
|
18998
19123
|
# body: "__string",
|
18999
19124
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
19125
|
+
# origination_number: "__string",
|
19000
19126
|
# sender_id: "__string",
|
19127
|
+
# entity_id: "__string",
|
19128
|
+
# template_id: "__string",
|
19001
19129
|
# },
|
19002
19130
|
# },
|
19003
19131
|
# name: "__string",
|
@@ -19456,7 +19584,10 @@ module Aws::Pinpoint
|
|
19456
19584
|
# sms: {
|
19457
19585
|
# message_config: {
|
19458
19586
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
19587
|
+
# origination_number: "__string",
|
19459
19588
|
# sender_id: "__string",
|
19589
|
+
# entity_id: "__string",
|
19590
|
+
# template_id: "__string",
|
19460
19591
|
# },
|
19461
19592
|
# next_activity: "__string",
|
19462
19593
|
# template_name: "__string",
|
@@ -19477,6 +19608,7 @@ module Aws::Pinpoint
|
|
19477
19608
|
# daily_cap: 1,
|
19478
19609
|
# endpoint_reentry_cap: 1,
|
19479
19610
|
# messages_per_second: 1,
|
19611
|
+
# endpoint_reentry_interval: "__string",
|
19480
19612
|
# },
|
19481
19613
|
# local_time: false,
|
19482
19614
|
# name: "__string", # required
|
@@ -19521,7 +19653,9 @@ module Aws::Pinpoint
|
|
19521
19653
|
# segment_id: "__string", # required
|
19522
19654
|
# },
|
19523
19655
|
# },
|
19524
|
-
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
19656
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED
|
19657
|
+
# wait_for_quiet_time: false,
|
19658
|
+
# refresh_on_segment_update: false,
|
19525
19659
|
# }
|
19526
19660
|
#
|
19527
19661
|
# @!attribute [rw] activities
|
@@ -19608,13 +19742,20 @@ module Aws::Pinpoint
|
|
19608
19742
|
# the scheduled start time. If a journey's status is ACTIVE, you
|
19609
19743
|
# can't add, change, or remove activities from it.
|
19610
19744
|
#
|
19611
|
-
#
|
19612
|
-
# requests to create or update a journey. To cancel
|
19613
|
-
#
|
19745
|
+
# PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in
|
19746
|
+
# requests to create or update a journey. To cancel, pause, or resume
|
19747
|
+
# a journey, use the <link
|
19748
|
+
# linkend="apps-application-id-journeys-journey-id-state" />
|
19614
19749
|
#
|
19615
19750
|
# Journey State</link> resource.
|
19616
19751
|
# @return [String]
|
19617
19752
|
#
|
19753
|
+
# @!attribute [rw] wait_for_quiet_time
|
19754
|
+
# @return [Boolean]
|
19755
|
+
#
|
19756
|
+
# @!attribute [rw] refresh_on_segment_update
|
19757
|
+
# @return [Boolean]
|
19758
|
+
#
|
19618
19759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteJourneyRequest AWS API Documentation
|
19619
19760
|
#
|
19620
19761
|
class WriteJourneyRequest < Struct.new(
|
@@ -19629,7 +19770,9 @@ module Aws::Pinpoint
|
|
19629
19770
|
:schedule,
|
19630
19771
|
:start_activity,
|
19631
19772
|
:start_condition,
|
19632
|
-
:state
|
19773
|
+
:state,
|
19774
|
+
:wait_for_quiet_time,
|
19775
|
+
:refresh_on_segment_update)
|
19633
19776
|
SENSITIVE = []
|
19634
19777
|
include Aws::Structure
|
19635
19778
|
end
|
@@ -19921,7 +20064,10 @@ module Aws::Pinpoint
|
|
19921
20064
|
# sms_message: {
|
19922
20065
|
# body: "__string",
|
19923
20066
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
20067
|
+
# origination_number: "__string",
|
19924
20068
|
# sender_id: "__string",
|
20069
|
+
# entity_id: "__string",
|
20070
|
+
# template_id: "__string",
|
19925
20071
|
# },
|
19926
20072
|
# },
|
19927
20073
|
# schedule: {
|