@aws-sdk/client-pinpoint 3.99.0 → 3.109.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.
- package/CHANGELOG.md +27 -0
- package/dist-cjs/PinpointClient.js +2 -0
- package/dist-es/PinpointClient.js +2 -0
- package/dist-types/models/models_0.d.ts +59 -177
- package/dist-types/models/models_1.d.ts +19 -59
- package/dist-types/ts3.4/models/models_0.d.ts +59 -177
- package/dist-types/ts3.4/models/models_1.d.ts +19 -59
- package/package.json +29 -28
|
@@ -253,9 +253,7 @@ export interface InAppMessage {
|
|
|
253
253
|
/**
|
|
254
254
|
* <p>Custom config to be sent to SDK.</p>
|
|
255
255
|
*/
|
|
256
|
-
CustomConfig?:
|
|
257
|
-
[key: string]: string;
|
|
258
|
-
};
|
|
256
|
+
CustomConfig?: Record<string, string>;
|
|
259
257
|
/**
|
|
260
258
|
* <p>The layout of the message.</p>
|
|
261
259
|
*/
|
|
@@ -395,9 +393,7 @@ export interface InAppTemplateResponse {
|
|
|
395
393
|
/**
|
|
396
394
|
* <p>Custom config to be sent to client.</p>
|
|
397
395
|
*/
|
|
398
|
-
CustomConfig?:
|
|
399
|
-
[key: string]: string;
|
|
400
|
-
};
|
|
396
|
+
CustomConfig?: Record<string, string>;
|
|
401
397
|
/**
|
|
402
398
|
* <p>The last modified date of the template.</p>
|
|
403
399
|
*/
|
|
@@ -409,9 +405,7 @@ export interface InAppTemplateResponse {
|
|
|
409
405
|
/**
|
|
410
406
|
* <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>
|
|
411
407
|
*/
|
|
412
|
-
tags?:
|
|
413
|
-
[key: string]: string;
|
|
414
|
-
};
|
|
408
|
+
tags?: Record<string, string>;
|
|
415
409
|
/**
|
|
416
410
|
* <p>The description of the template.</p>
|
|
417
411
|
*/
|
|
@@ -617,9 +611,7 @@ export interface JourneyExecutionActivityMetricsResponse {
|
|
|
617
611
|
/**
|
|
618
612
|
* <p>A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
|
|
619
613
|
*/
|
|
620
|
-
Metrics:
|
|
621
|
-
[key: string]: string;
|
|
622
|
-
} | undefined;
|
|
614
|
+
Metrics: Record<string, string> | undefined;
|
|
623
615
|
}
|
|
624
616
|
export declare namespace JourneyExecutionActivityMetricsResponse {
|
|
625
617
|
/**
|
|
@@ -682,9 +674,7 @@ export interface JourneyExecutionMetricsResponse {
|
|
|
682
674
|
/**
|
|
683
675
|
* <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
|
|
684
676
|
*/
|
|
685
|
-
Metrics:
|
|
686
|
-
[key: string]: string;
|
|
687
|
-
} | undefined;
|
|
677
|
+
Metrics: Record<string, string> | undefined;
|
|
688
678
|
}
|
|
689
679
|
export declare namespace JourneyExecutionMetricsResponse {
|
|
690
680
|
/**
|
|
@@ -767,9 +757,7 @@ export interface PushNotificationTemplateResponse {
|
|
|
767
757
|
/**
|
|
768
758
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
769
759
|
*/
|
|
770
|
-
tags?:
|
|
771
|
-
[key: string]: string;
|
|
772
|
-
};
|
|
760
|
+
tags?: Record<string, string>;
|
|
773
761
|
/**
|
|
774
762
|
* <p>The custom description of the message template.</p>
|
|
775
763
|
*/
|
|
@@ -1166,9 +1154,7 @@ export interface SMSTemplateResponse {
|
|
|
1166
1154
|
/**
|
|
1167
1155
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
1168
1156
|
*/
|
|
1169
|
-
tags?:
|
|
1170
|
-
[key: string]: string;
|
|
1171
|
-
};
|
|
1157
|
+
tags?: Record<string, string>;
|
|
1172
1158
|
/**
|
|
1173
1159
|
* <p>The custom description of the message template.</p>
|
|
1174
1160
|
*/
|
|
@@ -1303,9 +1289,7 @@ export interface VoiceTemplateResponse {
|
|
|
1303
1289
|
/**
|
|
1304
1290
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
1305
1291
|
*/
|
|
1306
|
-
tags?:
|
|
1307
|
-
[key: string]: string;
|
|
1308
|
-
};
|
|
1292
|
+
tags?: Record<string, string>;
|
|
1309
1293
|
/**
|
|
1310
1294
|
* <p>The custom description of the message template.</p>
|
|
1311
1295
|
*/
|
|
@@ -1434,9 +1418,7 @@ export interface TemplateResponse {
|
|
|
1434
1418
|
/**
|
|
1435
1419
|
* <p>A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>
|
|
1436
1420
|
*/
|
|
1437
|
-
tags?:
|
|
1438
|
-
[key: string]: string;
|
|
1439
|
-
};
|
|
1421
|
+
tags?: Record<string, string>;
|
|
1440
1422
|
/**
|
|
1441
1423
|
* <p>The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.</p>
|
|
1442
1424
|
*/
|
|
@@ -1518,9 +1500,7 @@ export interface TagsModel {
|
|
|
1518
1500
|
/**
|
|
1519
1501
|
* <p>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.</p> <p>Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
|
|
1520
1502
|
*/
|
|
1521
|
-
tags:
|
|
1522
|
-
[key: string]: string;
|
|
1523
|
-
} | undefined;
|
|
1503
|
+
tags: Record<string, string> | undefined;
|
|
1524
1504
|
}
|
|
1525
1505
|
export declare namespace TagsModel {
|
|
1526
1506
|
/**
|
|
@@ -1696,21 +1676,15 @@ export interface MessageRequest {
|
|
|
1696
1676
|
/**
|
|
1697
1677
|
* <p>A map of key-value pairs, where each key is an address and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object. An address can be a push notification token, a phone number, or an email address. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object to tailor the message for an address by specifying settings such as content overrides and message variables.</p>
|
|
1698
1678
|
*/
|
|
1699
|
-
Addresses?:
|
|
1700
|
-
[key: string]: AddressConfiguration;
|
|
1701
|
-
};
|
|
1679
|
+
Addresses?: Record<string, AddressConfiguration>;
|
|
1702
1680
|
/**
|
|
1703
1681
|
* <p>A map of custom attributes to attach to the message. 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>
|
|
1704
1682
|
*/
|
|
1705
|
-
Context?:
|
|
1706
|
-
[key: string]: string;
|
|
1707
|
-
};
|
|
1683
|
+
Context?: Record<string, string>;
|
|
1708
1684
|
/**
|
|
1709
1685
|
* <p>A map of key-value pairs, where each key is an endpoint ID and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.</p>
|
|
1710
1686
|
*/
|
|
1711
|
-
Endpoints?:
|
|
1712
|
-
[key: string]: EndpointSendConfiguration;
|
|
1713
|
-
};
|
|
1687
|
+
Endpoints?: Record<string, EndpointSendConfiguration>;
|
|
1714
1688
|
/**
|
|
1715
1689
|
* <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
|
|
1716
1690
|
*/
|
|
@@ -1741,9 +1715,7 @@ export interface MessageResponse {
|
|
|
1741
1715
|
/**
|
|
1742
1716
|
* <p>A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.</p>
|
|
1743
1717
|
*/
|
|
1744
|
-
EndpointResult?:
|
|
1745
|
-
[key: string]: EndpointMessageResult;
|
|
1746
|
-
};
|
|
1718
|
+
EndpointResult?: Record<string, EndpointMessageResult>;
|
|
1747
1719
|
/**
|
|
1748
1720
|
* <p>The identifier for the original request that the message was delivered for.</p>
|
|
1749
1721
|
*/
|
|
@@ -1751,9 +1723,7 @@ export interface MessageResponse {
|
|
|
1751
1723
|
/**
|
|
1752
1724
|
* <p>A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.</p>
|
|
1753
1725
|
*/
|
|
1754
|
-
Result?:
|
|
1755
|
-
[key: string]: MessageResult;
|
|
1756
|
-
};
|
|
1726
|
+
Result?: Record<string, MessageResult>;
|
|
1757
1727
|
}
|
|
1758
1728
|
export declare namespace MessageResponse {
|
|
1759
1729
|
/**
|
|
@@ -2114,9 +2084,7 @@ export interface SendUsersMessageRequest {
|
|
|
2114
2084
|
/**
|
|
2115
2085
|
* <p>A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.</p>
|
|
2116
2086
|
*/
|
|
2117
|
-
Context?:
|
|
2118
|
-
[key: string]: string;
|
|
2119
|
-
};
|
|
2087
|
+
Context?: Record<string, string>;
|
|
2120
2088
|
/**
|
|
2121
2089
|
* <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
|
|
2122
2090
|
*/
|
|
@@ -2132,9 +2100,7 @@ export interface SendUsersMessageRequest {
|
|
|
2132
2100
|
/**
|
|
2133
2101
|
* <p>A map that associates user IDs with <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> objects. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for a user by specifying settings such as content overrides and message variables.</p>
|
|
2134
2102
|
*/
|
|
2135
|
-
Users:
|
|
2136
|
-
[key: string]: EndpointSendConfiguration;
|
|
2137
|
-
} | undefined;
|
|
2103
|
+
Users: Record<string, EndpointSendConfiguration> | undefined;
|
|
2138
2104
|
}
|
|
2139
2105
|
export declare namespace SendUsersMessageRequest {
|
|
2140
2106
|
/**
|
|
@@ -2173,11 +2139,7 @@ export interface SendUsersMessageResponse {
|
|
|
2173
2139
|
/**
|
|
2174
2140
|
* <p>An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.</p>
|
|
2175
2141
|
*/
|
|
2176
|
-
Result?:
|
|
2177
|
-
[key: string]: {
|
|
2178
|
-
[key: string]: EndpointMessageResult;
|
|
2179
|
-
};
|
|
2180
|
-
};
|
|
2142
|
+
Result?: Record<string, Record<string, EndpointMessageResult>>;
|
|
2181
2143
|
}
|
|
2182
2144
|
export declare namespace SendUsersMessageResponse {
|
|
2183
2145
|
/**
|
|
@@ -2780,9 +2742,7 @@ export interface UpdateRecommenderConfigurationShape {
|
|
|
2780
2742
|
/**
|
|
2781
2743
|
* <p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</p>
|
|
2782
2744
|
*/
|
|
2783
|
-
Attributes?:
|
|
2784
|
-
[key: string]: string;
|
|
2785
|
-
};
|
|
2745
|
+
Attributes?: Record<string, string>;
|
|
2786
2746
|
/**
|
|
2787
2747
|
* <p>A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.</p>
|
|
2788
2748
|
*/
|