@aws-sdk/client-pinpoint 3.427.0 → 3.429.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.
|
@@ -166,7 +166,7 @@ export interface AttributeDimension {
|
|
|
166
166
|
* @public
|
|
167
167
|
* <p>The type of segment dimension to use. Valid values are: <ul><li>INCLUSIVE - endpoints that have attributes matching the values are included in the segment.</li><li>EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.</li><li>CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.</li><li>BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.</li><li>AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.</li><li>ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.</li><li>BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.</li></p>
|
|
168
168
|
*/
|
|
169
|
-
AttributeType?: AttributeType
|
|
169
|
+
AttributeType?: AttributeType;
|
|
170
170
|
/**
|
|
171
171
|
* @public
|
|
172
172
|
* <p>The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.</p>
|
|
@@ -194,7 +194,7 @@ export interface SetDimension {
|
|
|
194
194
|
* @public
|
|
195
195
|
* <p>The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.</p>
|
|
196
196
|
*/
|
|
197
|
-
DimensionType?: DimensionType
|
|
197
|
+
DimensionType?: DimensionType;
|
|
198
198
|
/**
|
|
199
199
|
* @public
|
|
200
200
|
* <p>The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.</p>
|
|
@@ -300,12 +300,12 @@ export interface RecencyDimension {
|
|
|
300
300
|
* @public
|
|
301
301
|
* <p>The duration to use when determining whether an endpoint is active or inactive.</p>
|
|
302
302
|
*/
|
|
303
|
-
Duration: Duration |
|
|
303
|
+
Duration: Duration | undefined;
|
|
304
304
|
/**
|
|
305
305
|
* @public
|
|
306
306
|
* <p>The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.</p>
|
|
307
307
|
*/
|
|
308
|
-
RecencyType: RecencyType |
|
|
308
|
+
RecencyType: RecencyType | undefined;
|
|
309
309
|
}
|
|
310
310
|
/**
|
|
311
311
|
* @public
|
|
@@ -485,7 +485,7 @@ export interface Condition {
|
|
|
485
485
|
* @public
|
|
486
486
|
* <p>Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.</p>
|
|
487
487
|
*/
|
|
488
|
-
Operator?: Operator
|
|
488
|
+
Operator?: Operator;
|
|
489
489
|
}
|
|
490
490
|
/**
|
|
491
491
|
* @public
|
|
@@ -564,7 +564,7 @@ export interface CustomMessageActivity {
|
|
|
564
564
|
* @public
|
|
565
565
|
* <p>The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.</p>
|
|
566
566
|
*/
|
|
567
|
-
EndpointTypes?:
|
|
567
|
+
EndpointTypes?: __EndpointTypesElement[];
|
|
568
568
|
/**
|
|
569
569
|
* @public
|
|
570
570
|
* <p>Specifies the message data included in a custom channel message that's sent to participants in a journey.</p>
|
|
@@ -761,7 +761,7 @@ export interface JourneySMSMessage {
|
|
|
761
761
|
* @public
|
|
762
762
|
* <p>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</p>
|
|
763
763
|
*/
|
|
764
|
-
MessageType?: MessageType
|
|
764
|
+
MessageType?: MessageType;
|
|
765
765
|
/**
|
|
766
766
|
* @public
|
|
767
767
|
* <p>The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.</p>
|
|
@@ -923,7 +923,7 @@ export interface AddressConfiguration {
|
|
|
923
923
|
* @public
|
|
924
924
|
* <p>The channel to use when sending the message.</p>
|
|
925
925
|
*/
|
|
926
|
-
ChannelType?: ChannelType
|
|
926
|
+
ChannelType?: ChannelType;
|
|
927
927
|
/**
|
|
928
928
|
* @public
|
|
929
929
|
* <p>An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.</p> <p>For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>
|
|
@@ -1031,7 +1031,7 @@ export interface ADMMessage {
|
|
|
1031
1031
|
* @public
|
|
1032
1032
|
* <p>The action to occur if the recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
1033
1033
|
*/
|
|
1034
|
-
Action?: Action
|
|
1034
|
+
Action?: Action;
|
|
1035
1035
|
/**
|
|
1036
1036
|
* @public
|
|
1037
1037
|
* <p>The body of the notification message.</p>
|
|
@@ -1130,7 +1130,7 @@ export interface AndroidPushNotificationTemplate {
|
|
|
1130
1130
|
* @public
|
|
1131
1131
|
* <p>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
1132
1132
|
*/
|
|
1133
|
-
Action?: Action
|
|
1133
|
+
Action?: Action;
|
|
1134
1134
|
/**
|
|
1135
1135
|
* @public
|
|
1136
1136
|
* <p>The message body to use in a push notification that's based on the message template.</p>
|
|
@@ -1298,7 +1298,7 @@ export interface APNSMessage {
|
|
|
1298
1298
|
* @public
|
|
1299
1299
|
* <p>The action to occur if the recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
1300
1300
|
*/
|
|
1301
|
-
Action?: Action
|
|
1301
|
+
Action?: Action;
|
|
1302
1302
|
/**
|
|
1303
1303
|
* @public
|
|
1304
1304
|
* <p>The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.</p>
|
|
@@ -1389,7 +1389,7 @@ export interface APNSPushNotificationTemplate {
|
|
|
1389
1389
|
* @public
|
|
1390
1390
|
* <p>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
1391
1391
|
*/
|
|
1392
|
-
Action?: Action
|
|
1392
|
+
Action?: Action;
|
|
1393
1393
|
/**
|
|
1394
1394
|
* @public
|
|
1395
1395
|
* <p>The message body to use in push notifications that are based on the message template.</p>
|
|
@@ -1935,7 +1935,7 @@ export interface CampaignHook {
|
|
|
1935
1935
|
* @public
|
|
1936
1936
|
* <p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize the segment that's used by a campaign.</p></li> <li><p>DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.</p></li></ul>
|
|
1937
1937
|
*/
|
|
1938
|
-
Mode?: Mode
|
|
1938
|
+
Mode?: Mode;
|
|
1939
1939
|
/**
|
|
1940
1940
|
* @public
|
|
1941
1941
|
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.</p>
|
|
@@ -2175,7 +2175,7 @@ export interface BaiduMessage {
|
|
|
2175
2175
|
* @public
|
|
2176
2176
|
* <p>The action to occur if the recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
2177
2177
|
*/
|
|
2178
|
-
Action?: Action
|
|
2178
|
+
Action?: Action;
|
|
2179
2179
|
/**
|
|
2180
2180
|
* @public
|
|
2181
2181
|
* <p>The body of the notification message.</p>
|
|
@@ -2359,7 +2359,7 @@ export interface CampaignEventFilter {
|
|
|
2359
2359
|
* @public
|
|
2360
2360
|
* <p>The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (<link linkend="apps-application-id-events">Events</link> resource) occurs.</p>
|
|
2361
2361
|
*/
|
|
2362
|
-
FilterType: FilterType |
|
|
2362
|
+
FilterType: FilterType | undefined;
|
|
2363
2363
|
}
|
|
2364
2364
|
/**
|
|
2365
2365
|
* @public
|
|
@@ -2370,7 +2370,7 @@ export interface InAppMessageBodyConfig {
|
|
|
2370
2370
|
* @public
|
|
2371
2371
|
* <p>The alignment of the text. Valid values: LEFT, CENTER, RIGHT.</p>
|
|
2372
2372
|
*/
|
|
2373
|
-
Alignment: Alignment |
|
|
2373
|
+
Alignment: Alignment | undefined;
|
|
2374
2374
|
/**
|
|
2375
2375
|
* @public
|
|
2376
2376
|
* <p>Message Body.</p>
|
|
@@ -2391,7 +2391,7 @@ export interface InAppMessageHeaderConfig {
|
|
|
2391
2391
|
* @public
|
|
2392
2392
|
* <p>The alignment of the text. Valid values: LEFT, CENTER, RIGHT.</p>
|
|
2393
2393
|
*/
|
|
2394
|
-
Alignment: Alignment |
|
|
2394
|
+
Alignment: Alignment | undefined;
|
|
2395
2395
|
/**
|
|
2396
2396
|
* @public
|
|
2397
2397
|
* <p>Message Header.</p>
|
|
@@ -2412,7 +2412,7 @@ export interface OverrideButtonConfiguration {
|
|
|
2412
2412
|
* @public
|
|
2413
2413
|
* <p>Action triggered by the button.</p>
|
|
2414
2414
|
*/
|
|
2415
|
-
ButtonAction: ButtonAction |
|
|
2415
|
+
ButtonAction: ButtonAction | undefined;
|
|
2416
2416
|
/**
|
|
2417
2417
|
* @public
|
|
2418
2418
|
* <p>Button destination.</p>
|
|
@@ -2438,7 +2438,7 @@ export interface DefaultButtonConfiguration {
|
|
|
2438
2438
|
* @public
|
|
2439
2439
|
* <p>Action triggered by the button.</p>
|
|
2440
2440
|
*/
|
|
2441
|
-
ButtonAction: ButtonAction |
|
|
2441
|
+
ButtonAction: ButtonAction | undefined;
|
|
2442
2442
|
/**
|
|
2443
2443
|
* @public
|
|
2444
2444
|
* <p>Button destination.</p>
|
|
@@ -2557,7 +2557,7 @@ export interface CampaignInAppMessage {
|
|
|
2557
2557
|
* @public
|
|
2558
2558
|
* <p>In-app message layout.</p>
|
|
2559
2559
|
*/
|
|
2560
|
-
Layout?: Layout
|
|
2560
|
+
Layout?: Layout;
|
|
2561
2561
|
}
|
|
2562
2562
|
/**
|
|
2563
2563
|
* @public
|
|
@@ -2573,7 +2573,7 @@ export interface CustomDeliveryConfiguration {
|
|
|
2573
2573
|
* @public
|
|
2574
2574
|
* <p>The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.</p>
|
|
2575
2575
|
*/
|
|
2576
|
-
EndpointTypes?:
|
|
2576
|
+
EndpointTypes?: __EndpointTypesElement[];
|
|
2577
2577
|
}
|
|
2578
2578
|
/**
|
|
2579
2579
|
* @public
|
|
@@ -2584,7 +2584,7 @@ export interface Message {
|
|
|
2584
2584
|
* @public
|
|
2585
2585
|
* <p>The action to occur if a recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
2586
2586
|
*/
|
|
2587
|
-
Action?: Action
|
|
2587
|
+
Action?: Action;
|
|
2588
2588
|
/**
|
|
2589
2589
|
* @public
|
|
2590
2590
|
* <p>The body of the notification message. The maximum number of characters is 200.</p>
|
|
@@ -2655,7 +2655,7 @@ export interface CampaignSmsMessage {
|
|
|
2655
2655
|
* @public
|
|
2656
2656
|
* <p>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</p>
|
|
2657
2657
|
*/
|
|
2658
|
-
MessageType?: MessageType
|
|
2658
|
+
MessageType?: MessageType;
|
|
2659
2659
|
/**
|
|
2660
2660
|
* @public
|
|
2661
2661
|
* <p>The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.</p>
|
|
@@ -2764,7 +2764,7 @@ export interface Schedule {
|
|
|
2764
2764
|
* @public
|
|
2765
2765
|
* <p>Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.</p>
|
|
2766
2766
|
*/
|
|
2767
|
-
Frequency?: Frequency
|
|
2767
|
+
Frequency?: Frequency;
|
|
2768
2768
|
/**
|
|
2769
2769
|
* @public
|
|
2770
2770
|
* <p>Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.</p>
|
|
@@ -2815,7 +2815,7 @@ export interface CampaignState {
|
|
|
2815
2815
|
* @public
|
|
2816
2816
|
* <p>The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.</p> <p>If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.</p>
|
|
2817
2817
|
*/
|
|
2818
|
-
CampaignStatus?: CampaignStatus
|
|
2818
|
+
CampaignStatus?: CampaignStatus;
|
|
2819
2819
|
}
|
|
2820
2820
|
/**
|
|
2821
2821
|
* @public
|
|
@@ -3745,7 +3745,7 @@ export interface ExportJobResponse {
|
|
|
3745
3745
|
* @public
|
|
3746
3746
|
* <p>The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.</p>
|
|
3747
3747
|
*/
|
|
3748
|
-
JobStatus: JobStatus |
|
|
3748
|
+
JobStatus: JobStatus | undefined;
|
|
3749
3749
|
/**
|
|
3750
3750
|
* @public
|
|
3751
3751
|
* <p>The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.</p>
|
|
@@ -3808,7 +3808,7 @@ export interface ImportJobRequest {
|
|
|
3808
3808
|
* @public
|
|
3809
3809
|
* <p>The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.</p>
|
|
3810
3810
|
*/
|
|
3811
|
-
Format: Format |
|
|
3811
|
+
Format: Format | undefined;
|
|
3812
3812
|
/**
|
|
3813
3813
|
* @public
|
|
3814
3814
|
* <p>Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.</p>
|
|
@@ -3869,7 +3869,7 @@ export interface ImportJobResource {
|
|
|
3869
3869
|
* @public
|
|
3870
3870
|
* <p>The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.</p> <p>If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.</p>
|
|
3871
3871
|
*/
|
|
3872
|
-
Format: Format |
|
|
3872
|
+
Format: Format | undefined;
|
|
3873
3873
|
/**
|
|
3874
3874
|
* @public
|
|
3875
3875
|
* <p>Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.</p>
|
|
@@ -3945,7 +3945,7 @@ export interface ImportJobResponse {
|
|
|
3945
3945
|
* @public
|
|
3946
3946
|
* <p>The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.</p>
|
|
3947
3947
|
*/
|
|
3948
|
-
JobStatus: JobStatus |
|
|
3948
|
+
JobStatus: JobStatus | undefined;
|
|
3949
3949
|
/**
|
|
3950
3950
|
* @public
|
|
3951
3951
|
* <p>The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.</p>
|
|
@@ -3996,7 +3996,7 @@ export interface InAppTemplateRequest {
|
|
|
3996
3996
|
* @public
|
|
3997
3997
|
* <p>The layout of the message.</p>
|
|
3998
3998
|
*/
|
|
3999
|
-
Layout?: Layout
|
|
3999
|
+
Layout?: Layout;
|
|
4000
4000
|
/**
|
|
4001
4001
|
* @public
|
|
4002
4002
|
* <note><p>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
@@ -4148,27 +4148,27 @@ export interface OpenHours {
|
|
|
4148
4148
|
* @public
|
|
4149
4149
|
* <p>Specifies the schedule settings for the email channel.</p>
|
|
4150
4150
|
*/
|
|
4151
|
-
EMAIL?: Record<
|
|
4151
|
+
EMAIL?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
4152
4152
|
/**
|
|
4153
4153
|
* @public
|
|
4154
4154
|
* <p>Specifies the schedule settings for the SMS channel.</p>
|
|
4155
4155
|
*/
|
|
4156
|
-
SMS?: Record<
|
|
4156
|
+
SMS?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
4157
4157
|
/**
|
|
4158
4158
|
* @public
|
|
4159
4159
|
* <p>Specifies the schedule settings for the push channel.</p>
|
|
4160
4160
|
*/
|
|
4161
|
-
PUSH?: Record<
|
|
4161
|
+
PUSH?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
4162
4162
|
/**
|
|
4163
4163
|
* @public
|
|
4164
4164
|
* <p>Specifies the schedule settings for the voice channel.</p>
|
|
4165
4165
|
*/
|
|
4166
|
-
VOICE?: Record<
|
|
4166
|
+
VOICE?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
4167
4167
|
/**
|
|
4168
4168
|
* @public
|
|
4169
4169
|
* <p>Specifies the schedule settings for the custom channel.</p>
|
|
4170
4170
|
*/
|
|
4171
|
-
CUSTOM?: Record<
|
|
4171
|
+
CUSTOM?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
4172
4172
|
}
|
|
4173
4173
|
/**
|
|
4174
4174
|
* @public
|
|
@@ -4210,7 +4210,7 @@ export interface EventFilter {
|
|
|
4210
4210
|
* @public
|
|
4211
4211
|
* <p>The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (<link linkend="apps-application-id-events">Events resource</link>) occurs.</p>
|
|
4212
4212
|
*/
|
|
4213
|
-
FilterType: FilterType |
|
|
4213
|
+
FilterType: FilterType | undefined;
|
|
4214
4214
|
}
|
|
4215
4215
|
/**
|
|
4216
4216
|
* @public
|
|
@@ -4325,7 +4325,7 @@ export interface WriteJourneyRequest {
|
|
|
4325
4325
|
* @public
|
|
4326
4326
|
* <p>The status of the journey. Valid values are:</p> <ul><li><p>DRAFT - Saves the journey and doesn't publish it.</p></li> <li><p>ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.</p></li></ul> <p>PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the <link linkend="apps-application-id-journeys-journey-id-state">Journey State</link> resource.</p>
|
|
4327
4327
|
*/
|
|
4328
|
-
State?: State
|
|
4328
|
+
State?: State;
|
|
4329
4329
|
/**
|
|
4330
4330
|
* @public
|
|
4331
4331
|
* <p>Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.</p>
|
|
@@ -4360,7 +4360,7 @@ export interface WriteJourneyRequest {
|
|
|
4360
4360
|
* @public
|
|
4361
4361
|
* <p>An array of time zone estimation methods, if any, to use for determining an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html">Endpoints</a> time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.</p> <ul> <li><p>PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.</p></li> <li><p>POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.</p> <note><p>POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.</p></note></li> </ul>
|
|
4362
4362
|
*/
|
|
4363
|
-
TimezoneEstimationMethods?:
|
|
4363
|
+
TimezoneEstimationMethods?: __TimezoneEstimationMethodsElement[];
|
|
4364
4364
|
}
|
|
4365
4365
|
/**
|
|
4366
4366
|
* @public
|
|
@@ -4451,7 +4451,7 @@ export interface JourneyResponse {
|
|
|
4451
4451
|
* @public
|
|
4452
4452
|
* <p>The current status of the journey. Possible values are:</p> <ul><li><p>DRAFT - The journey is being developed and hasn't been published yet.</p></li> <li><p>ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.</p></li> <li><p>COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.</p></li> <li><p>CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.</p></li> <li><p>CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.</p></li></ul>
|
|
4453
4453
|
*/
|
|
4454
|
-
State?: State
|
|
4454
|
+
State?: State;
|
|
4455
4455
|
/**
|
|
4456
4456
|
* @public
|
|
4457
4457
|
* <p>This object is not used or supported.</p>
|
|
@@ -4491,7 +4491,7 @@ export interface JourneyResponse {
|
|
|
4491
4491
|
* @public
|
|
4492
4492
|
* <p>An array of time zone estimation methods, if any, to use for determining an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html">Endpoints</a> time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.</p> <ul> <li><p>PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.</p></li> <li><p>POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.</p> <note><p>POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.</p></note></li> </ul>
|
|
4493
4493
|
*/
|
|
4494
|
-
TimezoneEstimationMethods?:
|
|
4494
|
+
TimezoneEstimationMethods?: __TimezoneEstimationMethodsElement[];
|
|
4495
4495
|
}
|
|
4496
4496
|
/**
|
|
4497
4497
|
* @public
|
|
@@ -4512,7 +4512,7 @@ export interface DefaultPushNotificationTemplate {
|
|
|
4512
4512
|
* @public
|
|
4513
4513
|
* <p>The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
4514
4514
|
*/
|
|
4515
|
-
Action?: Action
|
|
4515
|
+
Action?: Action;
|
|
4516
4516
|
/**
|
|
4517
4517
|
* @public
|
|
4518
4518
|
* <p>The message body to use in push notifications that are based on the message template.</p>
|
|
@@ -4808,12 +4808,12 @@ export interface SegmentGroup {
|
|
|
4808
4808
|
* @public
|
|
4809
4809
|
* <p>Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.</p>
|
|
4810
4810
|
*/
|
|
4811
|
-
SourceType?: SourceType
|
|
4811
|
+
SourceType?: SourceType;
|
|
4812
4812
|
/**
|
|
4813
4813
|
* @public
|
|
4814
4814
|
* <p>Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.</p>
|
|
4815
4815
|
*/
|
|
4816
|
-
Type?: Type
|
|
4816
|
+
Type?: Type;
|
|
4817
4817
|
}
|
|
4818
4818
|
/**
|
|
4819
4819
|
* @public
|
|
@@ -4842,7 +4842,7 @@ export interface SegmentGroupList {
|
|
|
4842
4842
|
* @public
|
|
4843
4843
|
* <p>Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.</p>
|
|
4844
4844
|
*/
|
|
4845
|
-
Include?: Include
|
|
4845
|
+
Include?: Include;
|
|
4846
4846
|
}
|
|
4847
4847
|
/**
|
|
4848
4848
|
* @public
|
|
@@ -4904,7 +4904,7 @@ export interface SegmentImportResource {
|
|
|
4904
4904
|
* @public
|
|
4905
4905
|
* <p>The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.</p>
|
|
4906
4906
|
*/
|
|
4907
|
-
Format: Format |
|
|
4907
|
+
Format: Format | undefined;
|
|
4908
4908
|
/**
|
|
4909
4909
|
* @public
|
|
4910
4910
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.</p>
|
|
@@ -4987,7 +4987,7 @@ export interface SegmentResponse {
|
|
|
4987
4987
|
* @public
|
|
4988
4988
|
* <p>The segment type. Valid values are:</p> <ul><li><p>DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.</p></li> <li><p>IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.</p></li></ul>
|
|
4989
4989
|
*/
|
|
4990
|
-
SegmentType: SegmentType |
|
|
4990
|
+
SegmentType: SegmentType | undefined;
|
|
4991
4991
|
/**
|
|
4992
4992
|
* @public
|
|
4993
4993
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.</p>
|
|
@@ -5151,7 +5151,7 @@ export interface DefaultPushNotificationMessage {
|
|
|
5151
5151
|
* @public
|
|
5152
5152
|
* <p>The default action to occur if a recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
5153
5153
|
*/
|
|
5154
|
-
Action?: Action
|
|
5154
|
+
Action?: Action;
|
|
5155
5155
|
/**
|
|
5156
5156
|
* @public
|
|
5157
5157
|
* <p>The default body of the notification message.</p>
|
|
@@ -5627,7 +5627,7 @@ export interface EndpointResponse {
|
|
|
5627
5627
|
* @public
|
|
5628
5628
|
* <p>The channel that's used when sending messages or push notifications to the endpoint.</p>
|
|
5629
5629
|
*/
|
|
5630
|
-
ChannelType?: ChannelType
|
|
5630
|
+
ChannelType?: ChannelType;
|
|
5631
5631
|
/**
|
|
5632
5632
|
* @public
|
|
5633
5633
|
* <p>A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.</p>
|
|
@@ -6336,7 +6336,7 @@ export interface GCMMessage {
|
|
|
6336
6336
|
* @public
|
|
6337
6337
|
* <p>The action to occur if the recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>
|
|
6338
6338
|
*/
|
|
6339
|
-
Action?: Action
|
|
6339
|
+
Action?: Action;
|
|
6340
6340
|
/**
|
|
6341
6341
|
* @public
|
|
6342
6342
|
* <p>The body of the notification message.</p>
|
|
@@ -6447,7 +6447,7 @@ export interface SMSMessage {
|
|
|
6447
6447
|
* @public
|
|
6448
6448
|
* <p>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</p>
|
|
6449
6449
|
*/
|
|
6450
|
-
MessageType?: MessageType
|
|
6450
|
+
MessageType?: MessageType;
|
|
6451
6451
|
/**
|
|
6452
6452
|
* @public
|
|
6453
6453
|
* <p>The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.</p>
|
|
@@ -6661,7 +6661,7 @@ export interface EmailTemplateResponse {
|
|
|
6661
6661
|
* @public
|
|
6662
6662
|
* <p>The type of channel that the message template is designed for. For an email template, this value is EMAIL.</p>
|
|
6663
6663
|
*/
|
|
6664
|
-
TemplateType: TemplateType |
|
|
6664
|
+
TemplateType: TemplateType | undefined;
|
|
6665
6665
|
/**
|
|
6666
6666
|
* @public
|
|
6667
6667
|
* <p>The message body, in plain text format, that's used in email messages that are based on the message template.</p>
|
|
@@ -6692,7 +6692,7 @@ export interface EndpointBatchItem {
|
|
|
6692
6692
|
* @public
|
|
6693
6693
|
* <p>The channel to use when sending messages or push notifications to the endpoint.</p>
|
|
6694
6694
|
*/
|
|
6695
|
-
ChannelType?: ChannelType
|
|
6695
|
+
ChannelType?: ChannelType;
|
|
6696
6696
|
/**
|
|
6697
6697
|
* @public
|
|
6698
6698
|
* <p>The demographic information for the endpoint, such as the time zone and platform.</p>
|
|
@@ -6780,7 +6780,7 @@ export interface EndpointMessageResult {
|
|
|
6780
6780
|
* @public
|
|
6781
6781
|
* <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
|
|
6782
6782
|
*/
|
|
6783
|
-
DeliveryStatus: DeliveryStatus |
|
|
6783
|
+
DeliveryStatus: DeliveryStatus | undefined;
|
|
6784
6784
|
/**
|
|
6785
6785
|
* @public
|
|
6786
6786
|
* <p>The unique identifier for the message that was sent.</p>
|
|
@@ -6821,7 +6821,7 @@ export interface EndpointRequest {
|
|
|
6821
6821
|
* @public
|
|
6822
6822
|
* <p>The channel to use when sending messages or push notifications to the endpoint.</p>
|
|
6823
6823
|
*/
|
|
6824
|
-
ChannelType?: ChannelType
|
|
6824
|
+
ChannelType?: ChannelType;
|
|
6825
6825
|
/**
|
|
6826
6826
|
* @public
|
|
6827
6827
|
* <p>The demographic information for the endpoint, such as the time zone and platform.</p>
|
|
@@ -7011,7 +7011,7 @@ export interface PublicEndpoint {
|
|
|
7011
7011
|
* @public
|
|
7012
7012
|
* <p>The channel that's used when sending messages or push notifications to the endpoint.</p>
|
|
7013
7013
|
*/
|
|
7014
|
-
ChannelType?: ChannelType
|
|
7014
|
+
ChannelType?: ChannelType;
|
|
7015
7015
|
/**
|
|
7016
7016
|
* @public
|
|
7017
7017
|
* <p>The demographic information for the endpoint, such as the time zone and platform.</p>
|
|
@@ -334,7 +334,7 @@ export interface InAppMessage {
|
|
|
334
334
|
* @public
|
|
335
335
|
* <p>The layout of the message.</p>
|
|
336
336
|
*/
|
|
337
|
-
Layout?: Layout
|
|
337
|
+
Layout?: Layout;
|
|
338
338
|
}
|
|
339
339
|
/**
|
|
340
340
|
* @public
|
|
@@ -473,7 +473,7 @@ export interface InAppTemplateResponse {
|
|
|
473
473
|
* @public
|
|
474
474
|
* <p>The layout of the message.</p>
|
|
475
475
|
*/
|
|
476
|
-
Layout?: Layout
|
|
476
|
+
Layout?: Layout;
|
|
477
477
|
/**
|
|
478
478
|
* @public
|
|
479
479
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
@@ -493,7 +493,7 @@ export interface InAppTemplateResponse {
|
|
|
493
493
|
* @public
|
|
494
494
|
* <p>The type of the template.</p>
|
|
495
495
|
*/
|
|
496
|
-
TemplateType: TemplateType |
|
|
496
|
+
TemplateType: TemplateType | undefined;
|
|
497
497
|
/**
|
|
498
498
|
* @public
|
|
499
499
|
* <p>The version id of the template.</p>
|
|
@@ -983,7 +983,7 @@ export interface JourneyRunResponse {
|
|
|
983
983
|
* @public
|
|
984
984
|
* <p>The current status of the journey run.</p>
|
|
985
985
|
*/
|
|
986
|
-
Status: JourneyRunStatus |
|
|
986
|
+
Status: JourneyRunStatus | undefined;
|
|
987
987
|
}
|
|
988
988
|
/**
|
|
989
989
|
* @public
|
|
@@ -1100,7 +1100,7 @@ export interface PushNotificationTemplateResponse {
|
|
|
1100
1100
|
* @public
|
|
1101
1101
|
* <p>The type of channel that the message template is designed for. For a push notification template, this value is PUSH.</p>
|
|
1102
1102
|
*/
|
|
1103
|
-
TemplateType: TemplateType |
|
|
1103
|
+
TemplateType: TemplateType | undefined;
|
|
1104
1104
|
/**
|
|
1105
1105
|
* @public
|
|
1106
1106
|
* <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
|
|
@@ -1473,7 +1473,7 @@ export interface SMSTemplateResponse {
|
|
|
1473
1473
|
* @public
|
|
1474
1474
|
* <p>The type of channel that the message template is designed for. For an SMS template, this value is SMS.</p>
|
|
1475
1475
|
*/
|
|
1476
|
-
TemplateType: TemplateType |
|
|
1476
|
+
TemplateType: TemplateType | undefined;
|
|
1477
1477
|
/**
|
|
1478
1478
|
* @public
|
|
1479
1479
|
* <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
|
|
@@ -1604,7 +1604,7 @@ export interface VoiceTemplateResponse {
|
|
|
1604
1604
|
* @public
|
|
1605
1605
|
* <p>The type of channel that the message template is designed for. For a voice template, this value is VOICE.</p>
|
|
1606
1606
|
*/
|
|
1607
|
-
TemplateType: TemplateType |
|
|
1607
|
+
TemplateType: TemplateType | undefined;
|
|
1608
1608
|
/**
|
|
1609
1609
|
* @public
|
|
1610
1610
|
* <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
|
|
@@ -1651,7 +1651,7 @@ export interface JourneyStateRequest {
|
|
|
1651
1651
|
* @public
|
|
1652
1652
|
* <p>The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED</p> <p>If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.</p> <p>After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.</p> <p>When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.</p>
|
|
1653
1653
|
*/
|
|
1654
|
-
State?: State
|
|
1654
|
+
State?: State;
|
|
1655
1655
|
}
|
|
1656
1656
|
/**
|
|
1657
1657
|
* @public
|
|
@@ -1727,7 +1727,7 @@ export interface TemplateResponse {
|
|
|
1727
1727
|
* @public
|
|
1728
1728
|
* <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.</p>
|
|
1729
1729
|
*/
|
|
1730
|
-
TemplateType: TemplateType |
|
|
1730
|
+
TemplateType: TemplateType | undefined;
|
|
1731
1731
|
/**
|
|
1732
1732
|
* @public
|
|
1733
1733
|
* <p>The unique identifier, as an integer, for the active version of the message template.</p>
|
|
@@ -1927,7 +1927,7 @@ export interface MessageResult {
|
|
|
1927
1927
|
* @public
|
|
1928
1928
|
* <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
|
|
1929
1929
|
*/
|
|
1930
|
-
DeliveryStatus: DeliveryStatus |
|
|
1930
|
+
DeliveryStatus: DeliveryStatus | undefined;
|
|
1931
1931
|
/**
|
|
1932
1932
|
* @public
|
|
1933
1933
|
* <p>The unique identifier for the message that was sent.</p>
|
|
@@ -60,7 +60,7 @@ export declare const AttributeType: {
|
|
|
60
60
|
};
|
|
61
61
|
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
62
62
|
export interface AttributeDimension {
|
|
63
|
-
AttributeType?: AttributeType
|
|
63
|
+
AttributeType?: AttributeType;
|
|
64
64
|
Values: string[] | undefined;
|
|
65
65
|
}
|
|
66
66
|
export declare const DimensionType: {
|
|
@@ -69,7 +69,7 @@ export declare const DimensionType: {
|
|
|
69
69
|
};
|
|
70
70
|
export type DimensionType = (typeof DimensionType)[keyof typeof DimensionType];
|
|
71
71
|
export interface SetDimension {
|
|
72
|
-
DimensionType?: DimensionType
|
|
72
|
+
DimensionType?: DimensionType;
|
|
73
73
|
Values: string[] | undefined;
|
|
74
74
|
}
|
|
75
75
|
export interface MetricDimension {
|
|
@@ -101,8 +101,8 @@ export declare const RecencyType: {
|
|
|
101
101
|
};
|
|
102
102
|
export type RecencyType = (typeof RecencyType)[keyof typeof RecencyType];
|
|
103
103
|
export interface RecencyDimension {
|
|
104
|
-
Duration: Duration |
|
|
105
|
-
RecencyType: RecencyType |
|
|
104
|
+
Duration: Duration | undefined;
|
|
105
|
+
RecencyType: RecencyType | undefined;
|
|
106
106
|
}
|
|
107
107
|
export interface SegmentBehaviors {
|
|
108
108
|
Recency?: RecencyDimension;
|
|
@@ -147,7 +147,7 @@ export declare const Operator: {
|
|
|
147
147
|
export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
148
148
|
export interface Condition {
|
|
149
149
|
Conditions?: SimpleCondition[];
|
|
150
|
-
Operator?: Operator
|
|
150
|
+
Operator?: Operator;
|
|
151
151
|
}
|
|
152
152
|
export interface WaitTime {
|
|
153
153
|
WaitFor?: string;
|
|
@@ -167,7 +167,7 @@ export interface JourneyCustomMessage {
|
|
|
167
167
|
}
|
|
168
168
|
export interface CustomMessageActivity {
|
|
169
169
|
DeliveryUri?: string;
|
|
170
|
-
EndpointTypes?:
|
|
170
|
+
EndpointTypes?: __EndpointTypesElement[];
|
|
171
171
|
MessageConfig?: JourneyCustomMessage;
|
|
172
172
|
NextActivity?: string;
|
|
173
173
|
TemplateName?: string;
|
|
@@ -217,7 +217,7 @@ export declare const MessageType: {
|
|
|
217
217
|
};
|
|
218
218
|
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
219
219
|
export interface JourneySMSMessage {
|
|
220
|
-
MessageType?: MessageType
|
|
220
|
+
MessageType?: MessageType;
|
|
221
221
|
OriginationNumber?: string;
|
|
222
222
|
SenderId?: string;
|
|
223
223
|
EntityId?: string;
|
|
@@ -264,7 +264,7 @@ export declare const ChannelType: {
|
|
|
264
264
|
export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];
|
|
265
265
|
export interface AddressConfiguration {
|
|
266
266
|
BodyOverride?: string;
|
|
267
|
-
ChannelType?: ChannelType
|
|
267
|
+
ChannelType?: ChannelType;
|
|
268
268
|
Context?: Record<string, string>;
|
|
269
269
|
RawContent?: string;
|
|
270
270
|
Substitutions?: Record<string, string[]>;
|
|
@@ -288,7 +288,7 @@ export interface ADMChannelResponse {
|
|
|
288
288
|
Version?: number;
|
|
289
289
|
}
|
|
290
290
|
export interface ADMMessage {
|
|
291
|
-
Action?: Action
|
|
291
|
+
Action?: Action;
|
|
292
292
|
Body?: string;
|
|
293
293
|
ConsolidationKey?: string;
|
|
294
294
|
Data?: Record<string, string>;
|
|
@@ -312,7 +312,7 @@ export declare const Alignment: {
|
|
|
312
312
|
};
|
|
313
313
|
export type Alignment = (typeof Alignment)[keyof typeof Alignment];
|
|
314
314
|
export interface AndroidPushNotificationTemplate {
|
|
315
|
-
Action?: Action
|
|
315
|
+
Action?: Action;
|
|
316
316
|
Body?: string;
|
|
317
317
|
ImageIconUrl?: string;
|
|
318
318
|
ImageUrl?: string;
|
|
@@ -348,7 +348,7 @@ export interface APNSChannelResponse {
|
|
|
348
348
|
}
|
|
349
349
|
export interface APNSMessage {
|
|
350
350
|
APNSPushType?: string;
|
|
351
|
-
Action?: Action
|
|
351
|
+
Action?: Action;
|
|
352
352
|
Badge?: number;
|
|
353
353
|
Body?: string;
|
|
354
354
|
Category?: string;
|
|
@@ -367,7 +367,7 @@ export interface APNSMessage {
|
|
|
367
367
|
Url?: string;
|
|
368
368
|
}
|
|
369
369
|
export interface APNSPushNotificationTemplate {
|
|
370
|
-
Action?: Action
|
|
370
|
+
Action?: Action;
|
|
371
371
|
Body?: string;
|
|
372
372
|
MediaUrl?: string;
|
|
373
373
|
RawContent?: string;
|
|
@@ -490,7 +490,7 @@ export declare const Mode: {
|
|
|
490
490
|
export type Mode = (typeof Mode)[keyof typeof Mode];
|
|
491
491
|
export interface CampaignHook {
|
|
492
492
|
LambdaFunctionName?: string;
|
|
493
|
-
Mode?: Mode
|
|
493
|
+
Mode?: Mode;
|
|
494
494
|
WebUrl?: string;
|
|
495
495
|
}
|
|
496
496
|
export interface CampaignLimits {
|
|
@@ -549,7 +549,7 @@ export interface BaiduChannelResponse {
|
|
|
549
549
|
Version?: number;
|
|
550
550
|
}
|
|
551
551
|
export interface BaiduMessage {
|
|
552
|
-
Action?: Action
|
|
552
|
+
Action?: Action;
|
|
553
553
|
Body?: string;
|
|
554
554
|
Data?: Record<string, string>;
|
|
555
555
|
IconReference?: string;
|
|
@@ -595,26 +595,26 @@ export declare const FilterType: {
|
|
|
595
595
|
export type FilterType = (typeof FilterType)[keyof typeof FilterType];
|
|
596
596
|
export interface CampaignEventFilter {
|
|
597
597
|
Dimensions: EventDimensions | undefined;
|
|
598
|
-
FilterType: FilterType |
|
|
598
|
+
FilterType: FilterType | undefined;
|
|
599
599
|
}
|
|
600
600
|
export interface InAppMessageBodyConfig {
|
|
601
|
-
Alignment: Alignment |
|
|
601
|
+
Alignment: Alignment | undefined;
|
|
602
602
|
Body: string | undefined;
|
|
603
603
|
TextColor: string | undefined;
|
|
604
604
|
}
|
|
605
605
|
export interface InAppMessageHeaderConfig {
|
|
606
|
-
Alignment: Alignment |
|
|
606
|
+
Alignment: Alignment | undefined;
|
|
607
607
|
Header: string | undefined;
|
|
608
608
|
TextColor: string | undefined;
|
|
609
609
|
}
|
|
610
610
|
export interface OverrideButtonConfiguration {
|
|
611
|
-
ButtonAction: ButtonAction |
|
|
611
|
+
ButtonAction: ButtonAction | undefined;
|
|
612
612
|
Link?: string;
|
|
613
613
|
}
|
|
614
614
|
export interface DefaultButtonConfiguration {
|
|
615
615
|
BackgroundColor?: string;
|
|
616
616
|
BorderRadius?: number;
|
|
617
|
-
ButtonAction: ButtonAction |
|
|
617
|
+
ButtonAction: ButtonAction | undefined;
|
|
618
618
|
Link?: string;
|
|
619
619
|
Text: string | undefined;
|
|
620
620
|
TextColor?: string;
|
|
@@ -646,14 +646,14 @@ export interface CampaignInAppMessage {
|
|
|
646
646
|
Body?: string;
|
|
647
647
|
Content?: InAppMessageContent[];
|
|
648
648
|
CustomConfig?: Record<string, string>;
|
|
649
|
-
Layout?: Layout
|
|
649
|
+
Layout?: Layout;
|
|
650
650
|
}
|
|
651
651
|
export interface CustomDeliveryConfiguration {
|
|
652
652
|
DeliveryUri: string | undefined;
|
|
653
|
-
EndpointTypes?:
|
|
653
|
+
EndpointTypes?: __EndpointTypesElement[];
|
|
654
654
|
}
|
|
655
655
|
export interface Message {
|
|
656
|
-
Action?: Action
|
|
656
|
+
Action?: Action;
|
|
657
657
|
Body?: string;
|
|
658
658
|
ImageIconUrl?: string;
|
|
659
659
|
ImageSmallIconUrl?: string;
|
|
@@ -668,7 +668,7 @@ export interface Message {
|
|
|
668
668
|
}
|
|
669
669
|
export interface CampaignSmsMessage {
|
|
670
670
|
Body?: string;
|
|
671
|
-
MessageType?: MessageType
|
|
671
|
+
MessageType?: MessageType;
|
|
672
672
|
OriginationNumber?: string;
|
|
673
673
|
SenderId?: string;
|
|
674
674
|
EntityId?: string;
|
|
@@ -698,7 +698,7 @@ export type Frequency = (typeof Frequency)[keyof typeof Frequency];
|
|
|
698
698
|
export interface Schedule {
|
|
699
699
|
EndTime?: string;
|
|
700
700
|
EventFilter?: CampaignEventFilter;
|
|
701
|
-
Frequency?: Frequency
|
|
701
|
+
Frequency?: Frequency;
|
|
702
702
|
IsLocalTime?: boolean;
|
|
703
703
|
QuietTime?: QuietTime;
|
|
704
704
|
StartTime: string | undefined;
|
|
@@ -716,7 +716,7 @@ export declare const CampaignStatus: {
|
|
|
716
716
|
export type CampaignStatus =
|
|
717
717
|
(typeof CampaignStatus)[keyof typeof CampaignStatus];
|
|
718
718
|
export interface CampaignState {
|
|
719
|
-
CampaignStatus?: CampaignStatus
|
|
719
|
+
CampaignStatus?: CampaignStatus;
|
|
720
720
|
}
|
|
721
721
|
export interface Template {
|
|
722
722
|
Name?: string;
|
|
@@ -957,7 +957,7 @@ export interface ExportJobResponse {
|
|
|
957
957
|
FailedPieces?: number;
|
|
958
958
|
Failures?: string[];
|
|
959
959
|
Id: string | undefined;
|
|
960
|
-
JobStatus: JobStatus |
|
|
960
|
+
JobStatus: JobStatus | undefined;
|
|
961
961
|
TotalFailures?: number;
|
|
962
962
|
TotalPieces?: number;
|
|
963
963
|
TotalProcessed?: number;
|
|
@@ -974,7 +974,7 @@ export type Format = (typeof Format)[keyof typeof Format];
|
|
|
974
974
|
export interface ImportJobRequest {
|
|
975
975
|
DefineSegment?: boolean;
|
|
976
976
|
ExternalId?: string;
|
|
977
|
-
Format: Format |
|
|
977
|
+
Format: Format | undefined;
|
|
978
978
|
RegisterEndpoints?: boolean;
|
|
979
979
|
RoleArn: string | undefined;
|
|
980
980
|
S3Url: string | undefined;
|
|
@@ -988,7 +988,7 @@ export interface CreateImportJobRequest {
|
|
|
988
988
|
export interface ImportJobResource {
|
|
989
989
|
DefineSegment?: boolean;
|
|
990
990
|
ExternalId?: string;
|
|
991
|
-
Format: Format |
|
|
991
|
+
Format: Format | undefined;
|
|
992
992
|
RegisterEndpoints?: boolean;
|
|
993
993
|
RoleArn: string | undefined;
|
|
994
994
|
S3Url: string | undefined;
|
|
@@ -1004,7 +1004,7 @@ export interface ImportJobResponse {
|
|
|
1004
1004
|
FailedPieces?: number;
|
|
1005
1005
|
Failures?: string[];
|
|
1006
1006
|
Id: string | undefined;
|
|
1007
|
-
JobStatus: JobStatus |
|
|
1007
|
+
JobStatus: JobStatus | undefined;
|
|
1008
1008
|
TotalFailures?: number;
|
|
1009
1009
|
TotalPieces?: number;
|
|
1010
1010
|
TotalProcessed?: number;
|
|
@@ -1016,7 +1016,7 @@ export interface CreateImportJobResponse {
|
|
|
1016
1016
|
export interface InAppTemplateRequest {
|
|
1017
1017
|
Content?: InAppMessageContent[];
|
|
1018
1018
|
CustomConfig?: Record<string, string>;
|
|
1019
|
-
Layout?: Layout
|
|
1019
|
+
Layout?: Layout;
|
|
1020
1020
|
tags?: Record<string, string>;
|
|
1021
1021
|
TemplateDescription?: string;
|
|
1022
1022
|
}
|
|
@@ -1059,11 +1059,11 @@ export interface OpenHoursRule {
|
|
|
1059
1059
|
EndTime?: string;
|
|
1060
1060
|
}
|
|
1061
1061
|
export interface OpenHours {
|
|
1062
|
-
EMAIL?: Record<
|
|
1063
|
-
SMS?: Record<
|
|
1064
|
-
PUSH?: Record<
|
|
1065
|
-
VOICE?: Record<
|
|
1066
|
-
CUSTOM?: Record<
|
|
1062
|
+
EMAIL?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
1063
|
+
SMS?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
1064
|
+
PUSH?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
1065
|
+
VOICE?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
1066
|
+
CUSTOM?: Record<DayOfWeek, OpenHoursRule[]>;
|
|
1067
1067
|
}
|
|
1068
1068
|
export interface JourneySchedule {
|
|
1069
1069
|
EndTime?: Date;
|
|
@@ -1072,7 +1072,7 @@ export interface JourneySchedule {
|
|
|
1072
1072
|
}
|
|
1073
1073
|
export interface EventFilter {
|
|
1074
1074
|
Dimensions: EventDimensions | undefined;
|
|
1075
|
-
FilterType: FilterType |
|
|
1075
|
+
FilterType: FilterType | undefined;
|
|
1076
1076
|
}
|
|
1077
1077
|
export interface EventStartCondition {
|
|
1078
1078
|
EventFilter?: EventFilter;
|
|
@@ -1104,14 +1104,14 @@ export interface WriteJourneyRequest {
|
|
|
1104
1104
|
Schedule?: JourneySchedule;
|
|
1105
1105
|
StartActivity?: string;
|
|
1106
1106
|
StartCondition?: StartCondition;
|
|
1107
|
-
State?: State
|
|
1107
|
+
State?: State;
|
|
1108
1108
|
WaitForQuietTime?: boolean;
|
|
1109
1109
|
RefreshOnSegmentUpdate?: boolean;
|
|
1110
1110
|
JourneyChannelSettings?: JourneyChannelSettings;
|
|
1111
1111
|
SendingSchedule?: boolean;
|
|
1112
1112
|
OpenHours?: OpenHours;
|
|
1113
1113
|
ClosedDays?: ClosedDays;
|
|
1114
|
-
TimezoneEstimationMethods?:
|
|
1114
|
+
TimezoneEstimationMethods?: __TimezoneEstimationMethodsElement[];
|
|
1115
1115
|
}
|
|
1116
1116
|
export interface CreateJourneyRequest {
|
|
1117
1117
|
ApplicationId: string | undefined;
|
|
@@ -1131,7 +1131,7 @@ export interface JourneyResponse {
|
|
|
1131
1131
|
Schedule?: JourneySchedule;
|
|
1132
1132
|
StartActivity?: string;
|
|
1133
1133
|
StartCondition?: StartCondition;
|
|
1134
|
-
State?: State
|
|
1134
|
+
State?: State;
|
|
1135
1135
|
tags?: Record<string, string>;
|
|
1136
1136
|
WaitForQuietTime?: boolean;
|
|
1137
1137
|
RefreshOnSegmentUpdate?: boolean;
|
|
@@ -1139,13 +1139,13 @@ export interface JourneyResponse {
|
|
|
1139
1139
|
SendingSchedule?: boolean;
|
|
1140
1140
|
OpenHours?: OpenHours;
|
|
1141
1141
|
ClosedDays?: ClosedDays;
|
|
1142
|
-
TimezoneEstimationMethods?:
|
|
1142
|
+
TimezoneEstimationMethods?: __TimezoneEstimationMethodsElement[];
|
|
1143
1143
|
}
|
|
1144
1144
|
export interface CreateJourneyResponse {
|
|
1145
1145
|
JourneyResponse: JourneyResponse | undefined;
|
|
1146
1146
|
}
|
|
1147
1147
|
export interface DefaultPushNotificationTemplate {
|
|
1148
|
-
Action?: Action
|
|
1148
|
+
Action?: Action;
|
|
1149
1149
|
Body?: string;
|
|
1150
1150
|
Sound?: string;
|
|
1151
1151
|
Title?: string;
|
|
@@ -1223,8 +1223,8 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
1223
1223
|
export interface SegmentGroup {
|
|
1224
1224
|
Dimensions?: SegmentDimensions[];
|
|
1225
1225
|
SourceSegments?: SegmentReference[];
|
|
1226
|
-
SourceType?: SourceType
|
|
1227
|
-
Type?: Type
|
|
1226
|
+
SourceType?: SourceType;
|
|
1227
|
+
Type?: Type;
|
|
1228
1228
|
}
|
|
1229
1229
|
export declare const Include: {
|
|
1230
1230
|
readonly ALL: "ALL";
|
|
@@ -1234,7 +1234,7 @@ export declare const Include: {
|
|
|
1234
1234
|
export type Include = (typeof Include)[keyof typeof Include];
|
|
1235
1235
|
export interface SegmentGroupList {
|
|
1236
1236
|
Groups?: SegmentGroup[];
|
|
1237
|
-
Include?: Include
|
|
1237
|
+
Include?: Include;
|
|
1238
1238
|
}
|
|
1239
1239
|
export interface WriteSegmentRequest {
|
|
1240
1240
|
Dimensions?: SegmentDimensions;
|
|
@@ -1249,7 +1249,7 @@ export interface CreateSegmentRequest {
|
|
|
1249
1249
|
export interface SegmentImportResource {
|
|
1250
1250
|
ChannelCounts?: Record<string, number>;
|
|
1251
1251
|
ExternalId: string | undefined;
|
|
1252
|
-
Format: Format |
|
|
1252
|
+
Format: Format | undefined;
|
|
1253
1253
|
RoleArn: string | undefined;
|
|
1254
1254
|
S3Url: string | undefined;
|
|
1255
1255
|
Size: number | undefined;
|
|
@@ -1269,7 +1269,7 @@ export interface SegmentResponse {
|
|
|
1269
1269
|
LastModifiedDate?: string;
|
|
1270
1270
|
Name?: string;
|
|
1271
1271
|
SegmentGroups?: SegmentGroupList;
|
|
1272
|
-
SegmentType: SegmentType |
|
|
1272
|
+
SegmentType: SegmentType | undefined;
|
|
1273
1273
|
tags?: Record<string, string>;
|
|
1274
1274
|
Version?: number;
|
|
1275
1275
|
}
|
|
@@ -1310,7 +1310,7 @@ export interface DefaultMessage {
|
|
|
1310
1310
|
Substitutions?: Record<string, string[]>;
|
|
1311
1311
|
}
|
|
1312
1312
|
export interface DefaultPushNotificationMessage {
|
|
1313
|
-
Action?: Action
|
|
1313
|
+
Action?: Action;
|
|
1314
1314
|
Body?: string;
|
|
1315
1315
|
Data?: Record<string, string>;
|
|
1316
1316
|
SilentPush?: boolean;
|
|
@@ -1431,7 +1431,7 @@ export interface EndpointResponse {
|
|
|
1431
1431
|
Address?: string;
|
|
1432
1432
|
ApplicationId?: string;
|
|
1433
1433
|
Attributes?: Record<string, string[]>;
|
|
1434
|
-
ChannelType?: ChannelType
|
|
1434
|
+
ChannelType?: ChannelType;
|
|
1435
1435
|
CohortId?: string;
|
|
1436
1436
|
CreationDate?: string;
|
|
1437
1437
|
Demographic?: EndpointDemographic;
|
|
@@ -1615,7 +1615,7 @@ export interface EmailMessage {
|
|
|
1615
1615
|
Substitutions?: Record<string, string[]>;
|
|
1616
1616
|
}
|
|
1617
1617
|
export interface GCMMessage {
|
|
1618
|
-
Action?: Action
|
|
1618
|
+
Action?: Action;
|
|
1619
1619
|
Body?: string;
|
|
1620
1620
|
CollapseKey?: string;
|
|
1621
1621
|
Data?: Record<string, string>;
|
|
@@ -1638,7 +1638,7 @@ export interface SMSMessage {
|
|
|
1638
1638
|
Body?: string;
|
|
1639
1639
|
Keyword?: string;
|
|
1640
1640
|
MediaUrl?: string;
|
|
1641
|
-
MessageType?: MessageType
|
|
1641
|
+
MessageType?: MessageType;
|
|
1642
1642
|
OriginationNumber?: string;
|
|
1643
1643
|
SenderId?: string;
|
|
1644
1644
|
Substitutions?: Record<string, string[]>;
|
|
@@ -1689,14 +1689,14 @@ export interface EmailTemplateResponse {
|
|
|
1689
1689
|
tags?: Record<string, string>;
|
|
1690
1690
|
TemplateDescription?: string;
|
|
1691
1691
|
TemplateName: string | undefined;
|
|
1692
|
-
TemplateType: TemplateType |
|
|
1692
|
+
TemplateType: TemplateType | undefined;
|
|
1693
1693
|
TextPart?: string;
|
|
1694
1694
|
Version?: string;
|
|
1695
1695
|
}
|
|
1696
1696
|
export interface EndpointBatchItem {
|
|
1697
1697
|
Address?: string;
|
|
1698
1698
|
Attributes?: Record<string, string[]>;
|
|
1699
|
-
ChannelType?: ChannelType
|
|
1699
|
+
ChannelType?: ChannelType;
|
|
1700
1700
|
Demographic?: EndpointDemographic;
|
|
1701
1701
|
EffectiveDate?: string;
|
|
1702
1702
|
EndpointStatus?: string;
|
|
@@ -1716,7 +1716,7 @@ export interface EndpointItemResponse {
|
|
|
1716
1716
|
}
|
|
1717
1717
|
export interface EndpointMessageResult {
|
|
1718
1718
|
Address?: string;
|
|
1719
|
-
DeliveryStatus: DeliveryStatus |
|
|
1719
|
+
DeliveryStatus: DeliveryStatus | undefined;
|
|
1720
1720
|
MessageId?: string;
|
|
1721
1721
|
StatusCode: number | undefined;
|
|
1722
1722
|
StatusMessage?: string;
|
|
@@ -1725,7 +1725,7 @@ export interface EndpointMessageResult {
|
|
|
1725
1725
|
export interface EndpointRequest {
|
|
1726
1726
|
Address?: string;
|
|
1727
1727
|
Attributes?: Record<string, string[]>;
|
|
1728
|
-
ChannelType?: ChannelType
|
|
1728
|
+
ChannelType?: ChannelType;
|
|
1729
1729
|
Demographic?: EndpointDemographic;
|
|
1730
1730
|
EffectiveDate?: string;
|
|
1731
1731
|
EndpointStatus?: string;
|
|
@@ -1767,7 +1767,7 @@ export interface EventItemResponse {
|
|
|
1767
1767
|
export interface PublicEndpoint {
|
|
1768
1768
|
Address?: string;
|
|
1769
1769
|
Attributes?: Record<string, string[]>;
|
|
1770
|
-
ChannelType?: ChannelType
|
|
1770
|
+
ChannelType?: ChannelType;
|
|
1771
1771
|
Demographic?: EndpointDemographic;
|
|
1772
1772
|
EffectiveDate?: string;
|
|
1773
1773
|
EndpointStatus?: string;
|
|
@@ -156,7 +156,7 @@ export interface GetInAppMessagesRequest {
|
|
|
156
156
|
export interface InAppMessage {
|
|
157
157
|
Content?: InAppMessageContent[];
|
|
158
158
|
CustomConfig?: Record<string, string>;
|
|
159
|
-
Layout?: Layout
|
|
159
|
+
Layout?: Layout;
|
|
160
160
|
}
|
|
161
161
|
export interface InAppCampaignSchedule {
|
|
162
162
|
EndDate?: string;
|
|
@@ -189,11 +189,11 @@ export interface InAppTemplateResponse {
|
|
|
189
189
|
CreationDate: string | undefined;
|
|
190
190
|
CustomConfig?: Record<string, string>;
|
|
191
191
|
LastModifiedDate: string | undefined;
|
|
192
|
-
Layout?: Layout
|
|
192
|
+
Layout?: Layout;
|
|
193
193
|
tags?: Record<string, string>;
|
|
194
194
|
TemplateDescription?: string;
|
|
195
195
|
TemplateName: string | undefined;
|
|
196
|
-
TemplateType: TemplateType |
|
|
196
|
+
TemplateType: TemplateType | undefined;
|
|
197
197
|
Version?: string;
|
|
198
198
|
}
|
|
199
199
|
export interface GetInAppTemplateResponse {
|
|
@@ -321,7 +321,7 @@ export interface JourneyRunResponse {
|
|
|
321
321
|
CreationTime: string | undefined;
|
|
322
322
|
LastUpdateTime: string | undefined;
|
|
323
323
|
RunId: string | undefined;
|
|
324
|
-
Status: JourneyRunStatus |
|
|
324
|
+
Status: JourneyRunStatus | undefined;
|
|
325
325
|
}
|
|
326
326
|
export interface JourneyRunsResponse {
|
|
327
327
|
Item: JourneyRunResponse[] | undefined;
|
|
@@ -348,7 +348,7 @@ export interface PushNotificationTemplateResponse {
|
|
|
348
348
|
tags?: Record<string, string>;
|
|
349
349
|
TemplateDescription?: string;
|
|
350
350
|
TemplateName: string | undefined;
|
|
351
|
-
TemplateType: TemplateType |
|
|
351
|
+
TemplateType: TemplateType | undefined;
|
|
352
352
|
Version?: string;
|
|
353
353
|
}
|
|
354
354
|
export interface GetPushTemplateResponse {
|
|
@@ -451,7 +451,7 @@ export interface SMSTemplateResponse {
|
|
|
451
451
|
tags?: Record<string, string>;
|
|
452
452
|
TemplateDescription?: string;
|
|
453
453
|
TemplateName: string | undefined;
|
|
454
|
-
TemplateType: TemplateType |
|
|
454
|
+
TemplateType: TemplateType | undefined;
|
|
455
455
|
Version?: string;
|
|
456
456
|
}
|
|
457
457
|
export interface GetSmsTemplateResponse {
|
|
@@ -484,7 +484,7 @@ export interface VoiceTemplateResponse {
|
|
|
484
484
|
tags?: Record<string, string>;
|
|
485
485
|
TemplateDescription?: string;
|
|
486
486
|
TemplateName: string | undefined;
|
|
487
|
-
TemplateType: TemplateType |
|
|
487
|
+
TemplateType: TemplateType | undefined;
|
|
488
488
|
Version?: string;
|
|
489
489
|
VoiceId?: string;
|
|
490
490
|
}
|
|
@@ -496,7 +496,7 @@ export interface JourneysResponse {
|
|
|
496
496
|
NextToken?: string;
|
|
497
497
|
}
|
|
498
498
|
export interface JourneyStateRequest {
|
|
499
|
-
State?: State
|
|
499
|
+
State?: State;
|
|
500
500
|
}
|
|
501
501
|
export interface ListJourneysRequest {
|
|
502
502
|
ApplicationId: string | undefined;
|
|
@@ -514,7 +514,7 @@ export interface TemplateResponse {
|
|
|
514
514
|
tags?: Record<string, string>;
|
|
515
515
|
TemplateDescription?: string;
|
|
516
516
|
TemplateName: string | undefined;
|
|
517
|
-
TemplateType: TemplateType |
|
|
517
|
+
TemplateType: TemplateType | undefined;
|
|
518
518
|
Version?: string;
|
|
519
519
|
}
|
|
520
520
|
export interface TemplateVersionResponse {
|
|
@@ -564,7 +564,7 @@ export interface ListTemplateVersionsResponse {
|
|
|
564
564
|
TemplateVersionsResponse: TemplateVersionsResponse | undefined;
|
|
565
565
|
}
|
|
566
566
|
export interface MessageResult {
|
|
567
|
-
DeliveryStatus: DeliveryStatus |
|
|
567
|
+
DeliveryStatus: DeliveryStatus | undefined;
|
|
568
568
|
MessageId?: string;
|
|
569
569
|
StatusCode: number | undefined;
|
|
570
570
|
StatusMessage?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-pinpoint",
|
|
3
3
|
"description": "AWS SDK for JavaScript Pinpoint Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.429.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,39 +21,39 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
32
|
-
"@aws-sdk/types": "3.
|
|
33
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
36
|
-
"@smithy/config-resolver": "^2.0.
|
|
37
|
-
"@smithy/fetch-http-handler": "^2.2.
|
|
38
|
-
"@smithy/hash-node": "^2.0.
|
|
39
|
-
"@smithy/invalid-dependency": "^2.0.
|
|
40
|
-
"@smithy/middleware-content-length": "^2.0.
|
|
41
|
-
"@smithy/middleware-endpoint": "^2.
|
|
42
|
-
"@smithy/middleware-retry": "^2.0.
|
|
43
|
-
"@smithy/middleware-serde": "^2.0.
|
|
44
|
-
"@smithy/middleware-stack": "^2.0.
|
|
45
|
-
"@smithy/node-config-provider": "^2.
|
|
46
|
-
"@smithy/node-http-handler": "^2.1.
|
|
47
|
-
"@smithy/protocol-http": "^3.0.
|
|
48
|
-
"@smithy/smithy-client": "^2.1.
|
|
49
|
-
"@smithy/types": "^2.3.
|
|
50
|
-
"@smithy/url-parser": "^2.0.
|
|
24
|
+
"@aws-sdk/client-sts": "3.429.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.429.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.429.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.428.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.428.0",
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.428.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.428.0",
|
|
31
|
+
"@aws-sdk/region-config-resolver": "3.428.0",
|
|
32
|
+
"@aws-sdk/types": "3.428.0",
|
|
33
|
+
"@aws-sdk/util-endpoints": "3.428.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-browser": "3.428.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.428.0",
|
|
36
|
+
"@smithy/config-resolver": "^2.0.14",
|
|
37
|
+
"@smithy/fetch-http-handler": "^2.2.3",
|
|
38
|
+
"@smithy/hash-node": "^2.0.11",
|
|
39
|
+
"@smithy/invalid-dependency": "^2.0.11",
|
|
40
|
+
"@smithy/middleware-content-length": "^2.0.13",
|
|
41
|
+
"@smithy/middleware-endpoint": "^2.1.1",
|
|
42
|
+
"@smithy/middleware-retry": "^2.0.16",
|
|
43
|
+
"@smithy/middleware-serde": "^2.0.11",
|
|
44
|
+
"@smithy/middleware-stack": "^2.0.5",
|
|
45
|
+
"@smithy/node-config-provider": "^2.1.1",
|
|
46
|
+
"@smithy/node-http-handler": "^2.1.7",
|
|
47
|
+
"@smithy/protocol-http": "^3.0.7",
|
|
48
|
+
"@smithy/smithy-client": "^2.1.11",
|
|
49
|
+
"@smithy/types": "^2.3.5",
|
|
50
|
+
"@smithy/url-parser": "^2.0.11",
|
|
51
51
|
"@smithy/util-base64": "^2.0.0",
|
|
52
52
|
"@smithy/util-body-length-browser": "^2.0.0",
|
|
53
53
|
"@smithy/util-body-length-node": "^2.1.0",
|
|
54
|
-
"@smithy/util-defaults-mode-browser": "^2.0.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^2.0.
|
|
56
|
-
"@smithy/util-retry": "^2.0.
|
|
54
|
+
"@smithy/util-defaults-mode-browser": "^2.0.15",
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^2.0.19",
|
|
56
|
+
"@smithy/util-retry": "^2.0.4",
|
|
57
57
|
"@smithy/util-utf8": "^2.0.0",
|
|
58
58
|
"tslib": "^2.5.0"
|
|
59
59
|
},
|