@aws-sdk/client-customer-profiles 3.857.0 → 3.859.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/dist-cjs/index.js +149 -90
- package/dist-es/commands/PutProfileObjectTypeCommand.js +1 -1
- package/dist-es/commands/SearchProfilesCommand.js +1 -1
- package/dist-es/models/models_0.js +29 -20
- package/dist-es/models/models_1.js +23 -0
- package/dist-es/protocols/Aws_restJson1.js +18 -0
- package/dist-types/commands/BatchGetProfileCommand.d.ts +19 -0
- package/dist-types/commands/CreateProfileCommand.d.ts +19 -0
- package/dist-types/commands/CreateSegmentDefinitionCommand.d.ts +6 -0
- package/dist-types/commands/CreateSegmentEstimateCommand.d.ts +6 -0
- package/dist-types/commands/GetSegmentDefinitionCommand.d.ts +6 -0
- package/dist-types/commands/GetSegmentMembershipCommand.d.ts +19 -0
- package/dist-types/commands/MergeProfilesCommand.d.ts +2 -0
- package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/commands/SearchProfilesCommand.d.ts +20 -1
- package/dist-types/commands/StartUploadJobCommand.d.ts +1 -2
- package/dist-types/commands/UpdateProfileCommand.d.ts +19 -0
- package/dist-types/models/models_0.d.ts +143 -282
- package/dist-types/models/models_1.d.ts +293 -1
- package/dist-types/ts3.4/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartUploadJobCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +48 -62
- package/dist-types/ts3.4/models/models_1.d.ts +70 -0
- package/package.json +5 -5
|
@@ -1,4 +1,274 @@
|
|
|
1
|
-
import { AttributeDetails, Conditions, EventTriggerCondition, EventTriggerLimits, Gender, LayoutType, MatchingRequest, MatchingResponse, PartyType, Readiness, ReadinessStatus, RuleBasedMatchingRequest, RuleBasedMatchingResponse, Statistic } from "./models_0";
|
|
1
|
+
import { AdditionalSearchKey, AttributeDetails, Conditions, EngagementPreferences, EventTriggerCondition, EventTriggerLimits, Gender, LayoutType, MatchingRequest, MatchingResponse, ObjectTypeField, ObjectTypeKey, PartyType, Profile, ProfileType, Readiness, ReadinessStatus, RuleBasedMatchingRequest, RuleBasedMatchingResponse, Statistic } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface PutProfileObjectTypeRequest {
|
|
6
|
+
/**
|
|
7
|
+
* <p>The unique name of the domain.</p>
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
DomainName: string | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* <p>The name of the profile object type.</p>
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
ObjectTypeName: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* <p>Description of the profile object type.</p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
Description: string | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* <p>A unique identifier for the object template. For some attributes in the request, the
|
|
23
|
+
* service will use the default value from the object template when TemplateId is present. If
|
|
24
|
+
* these attributes are present in the request, the service may return a
|
|
25
|
+
* <code>BadRequestException</code>. These attributes include: AllowProfileCreation,
|
|
26
|
+
* SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is
|
|
27
|
+
* set to true when TemplateId is set, the service may return a
|
|
28
|
+
* <code>BadRequestException</code>.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
TemplateId?: string | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* <p>The number of days until the data in the object expires.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
ExpirationDays?: number | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
39
|
+
* profile object type.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
EncryptionKey?: string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
45
|
+
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
46
|
+
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
47
|
+
* associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
|
|
48
|
+
* is found, then the service creates a new standard profile.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
AllowProfileCreation?: boolean | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.
|
|
54
|
+
* </p>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* <p>The amount of profile object max count assigned to the object type</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
MaxProfileObjectCount?: number | undefined;
|
|
63
|
+
/**
|
|
64
|
+
* <p>A map of the name and ObjectType field.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
Tags?: Record<string, string> | undefined;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export interface PutProfileObjectTypeResponse {
|
|
83
|
+
/**
|
|
84
|
+
* <p>The name of the profile object type.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
ObjectTypeName: string | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* <p>Description of the profile object type.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
Description: string | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>A unique identifier for the object template.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
TemplateId?: string | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The number of days until the data in the object expires.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
ExpirationDays?: number | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
105
|
+
* profile object type.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
EncryptionKey?: string | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
111
|
+
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
112
|
+
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
113
|
+
* associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
|
|
114
|
+
* is found, then the service creates a new standard profile.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
AllowProfileCreation?: boolean | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in
|
|
120
|
+
* fields that were parsed using <a href="https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>. If you have <code>sourceLastUpdatedTimestamp</code> in your
|
|
121
|
+
* field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The amount of profile object max count assigned to the object type.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
MaxProfileObjectCount?: number | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>The amount of provisioned profile object max count available.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
MaxAvailableProfileObjectCount?: number | undefined;
|
|
135
|
+
/**
|
|
136
|
+
* <p>A map of the name and ObjectType field.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* <p>The timestamp of when the domain was created.</p>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
CreatedAt?: Date | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
LastUpdatedAt?: Date | undefined;
|
|
155
|
+
/**
|
|
156
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
Tags?: Record<string, string> | undefined;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* @public
|
|
163
|
+
* @enum
|
|
164
|
+
*/
|
|
165
|
+
export declare const LogicalOperator: {
|
|
166
|
+
readonly AND: "AND";
|
|
167
|
+
readonly OR: "OR";
|
|
168
|
+
};
|
|
169
|
+
/**
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
export type LogicalOperator = (typeof LogicalOperator)[keyof typeof LogicalOperator];
|
|
173
|
+
/**
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
export interface SearchProfilesRequest {
|
|
177
|
+
/**
|
|
178
|
+
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
NextToken?: string | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* <p>The maximum number of objects returned per page.</p>
|
|
184
|
+
* <p>The default is 20 if this parameter is not included in the request.</p>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
MaxResults?: number | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* <p>The unique name of the domain.</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
DomainName: string | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,
|
|
195
|
+
* _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
|
|
196
|
+
* _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId,
|
|
197
|
+
* _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
|
|
198
|
+
* _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
KeyName: string | undefined;
|
|
202
|
+
/**
|
|
203
|
+
* <p>A list of key values.</p>
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
Values: string[] | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers
|
|
209
|
+
* of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code>
|
|
210
|
+
* and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s)
|
|
211
|
+
* pair). These additional search keys will be used in conjunction with the
|
|
212
|
+
* <code>LogicalOperator</code> and the required <code>KeyName</code> and
|
|
213
|
+
* <code>Values</code> parameters to search for profiles that satisfy the search criteria.
|
|
214
|
+
* </p>
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
|
|
218
|
+
/**
|
|
219
|
+
* <p>Relationship between all specified search keys that will be used to search for profiles.
|
|
220
|
+
* This includes the required <code>KeyName</code> and <code>Values</code> parameters as well
|
|
221
|
+
* as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
|
|
222
|
+
* <p>This parameter influences which profiles will be returned in the response in the
|
|
223
|
+
* following manner:</p>
|
|
224
|
+
* <ul>
|
|
225
|
+
* <li>
|
|
226
|
+
* <p>
|
|
227
|
+
* <code>AND</code> - The response only includes profiles that match all of the
|
|
228
|
+
* search keys.</p>
|
|
229
|
+
* </li>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p>
|
|
232
|
+
* <code>OR</code> - The response includes profiles that match at least one of the
|
|
233
|
+
* search keys.</p>
|
|
234
|
+
* </li>
|
|
235
|
+
* </ul>
|
|
236
|
+
* <p>The <code>OR</code> relationship is the default behavior if this parameter is not
|
|
237
|
+
* included in the request.</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
LogicalOperator?: LogicalOperator | undefined;
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export interface SearchProfilesResponse {
|
|
246
|
+
/**
|
|
247
|
+
* <p>The list of Profiles matching the search criteria.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
Items?: Profile[] | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
NextToken?: string | undefined;
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
export interface StartUploadJobRequest {
|
|
261
|
+
/**
|
|
262
|
+
* <p>The unique name of the domain containing the upload job to start. </p>
|
|
263
|
+
* @public
|
|
264
|
+
*/
|
|
265
|
+
DomainName: string | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* <p>The unique identifier of the upload job to start. </p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
JobId: string | undefined;
|
|
271
|
+
}
|
|
2
272
|
/**
|
|
3
273
|
* @public
|
|
4
274
|
*/
|
|
@@ -675,6 +945,16 @@ export interface UpdateProfileRequest {
|
|
|
675
945
|
* @public
|
|
676
946
|
*/
|
|
677
947
|
GenderString?: string | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>Determines the type of the profile.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
ProfileType?: ProfileType | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>Object that defines users preferred methods of engagement.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
EngagementPreferences?: EngagementPreferences | undefined;
|
|
678
958
|
}
|
|
679
959
|
/**
|
|
680
960
|
* @public
|
|
@@ -686,6 +966,18 @@ export interface UpdateProfileResponse {
|
|
|
686
966
|
*/
|
|
687
967
|
ProfileId: string | undefined;
|
|
688
968
|
}
|
|
969
|
+
/**
|
|
970
|
+
* @internal
|
|
971
|
+
*/
|
|
972
|
+
export declare const PutProfileObjectTypeRequestFilterSensitiveLog: (obj: PutProfileObjectTypeRequest) => any;
|
|
973
|
+
/**
|
|
974
|
+
* @internal
|
|
975
|
+
*/
|
|
976
|
+
export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (obj: PutProfileObjectTypeResponse) => any;
|
|
977
|
+
/**
|
|
978
|
+
* @internal
|
|
979
|
+
*/
|
|
980
|
+
export declare const SearchProfilesResponseFilterSensitiveLog: (obj: SearchProfilesResponse) => any;
|
|
689
981
|
/**
|
|
690
982
|
* @internal
|
|
691
983
|
*/
|
|
@@ -8,7 +8,7 @@ import {
|
|
|
8
8
|
import {
|
|
9
9
|
SearchProfilesRequest,
|
|
10
10
|
SearchProfilesResponse,
|
|
11
|
-
} from "../models/
|
|
11
|
+
} from "../models/models_1";
|
|
12
12
|
export { __MetadataBearer };
|
|
13
13
|
export { $Command };
|
|
14
14
|
export interface SearchProfilesCommandInput extends SearchProfilesRequest {}
|
|
@@ -5,8 +5,10 @@ import {
|
|
|
5
5
|
ServiceInputTypes,
|
|
6
6
|
ServiceOutputTypes,
|
|
7
7
|
} from "../CustomerProfilesClient";
|
|
8
|
-
import {
|
|
9
|
-
|
|
8
|
+
import {
|
|
9
|
+
StartUploadJobRequest,
|
|
10
|
+
StartUploadJobResponse,
|
|
11
|
+
} from "../models/models_1";
|
|
10
12
|
export { __MetadataBearer };
|
|
11
13
|
export { $Command };
|
|
12
14
|
export interface StartUploadJobCommandInput extends StartUploadJobRequest {}
|
|
@@ -489,6 +489,26 @@ export interface BatchGetProfileError {
|
|
|
489
489
|
Message: string | undefined;
|
|
490
490
|
ProfileId: string | undefined;
|
|
491
491
|
}
|
|
492
|
+
export declare const ContactType: {
|
|
493
|
+
readonly BUSINESS_EMAIL_ADDRESS: "BusinessEmailAddress";
|
|
494
|
+
readonly BUSINESS_PHONE_NUMBER: "BusinessPhoneNumber";
|
|
495
|
+
readonly EMAIL_ADDRESS: "EmailAddress";
|
|
496
|
+
readonly HOME_PHONE_NUMBER: "HomePhoneNumber";
|
|
497
|
+
readonly MOBILE_PHONE_NUMBER: "MobilePhoneNumber";
|
|
498
|
+
readonly PERSONAL_EMAIL_ADDRESS: "PersonalEmailAddress";
|
|
499
|
+
readonly PHONE_NUMBER: "PhoneNumber";
|
|
500
|
+
};
|
|
501
|
+
export type ContactType = (typeof ContactType)[keyof typeof ContactType];
|
|
502
|
+
export interface ContactPreference {
|
|
503
|
+
KeyName?: string | undefined;
|
|
504
|
+
KeyValue?: string | undefined;
|
|
505
|
+
ProfileId?: string | undefined;
|
|
506
|
+
ContactType?: ContactType | undefined;
|
|
507
|
+
}
|
|
508
|
+
export interface EngagementPreferences {
|
|
509
|
+
Phone?: ContactPreference[] | undefined;
|
|
510
|
+
Email?: ContactPreference[] | undefined;
|
|
511
|
+
}
|
|
492
512
|
export interface FoundByKeyValue {
|
|
493
513
|
KeyName?: string | undefined;
|
|
494
514
|
Values?: string[] | undefined;
|
|
@@ -505,6 +525,11 @@ export declare const PartyType: {
|
|
|
505
525
|
readonly OTHER: "OTHER";
|
|
506
526
|
};
|
|
507
527
|
export type PartyType = (typeof PartyType)[keyof typeof PartyType];
|
|
528
|
+
export declare const ProfileType: {
|
|
529
|
+
readonly ACCOUNT_PROFILE: "ACCOUNT_PROFILE";
|
|
530
|
+
readonly PROFILE: "PROFILE";
|
|
531
|
+
};
|
|
532
|
+
export type ProfileType = (typeof ProfileType)[keyof typeof ProfileType];
|
|
508
533
|
export interface Profile {
|
|
509
534
|
ProfileId?: string | undefined;
|
|
510
535
|
AccountNumber?: string | undefined;
|
|
@@ -531,6 +556,8 @@ export interface Profile {
|
|
|
531
556
|
FoundByItems?: FoundByKeyValue[] | undefined;
|
|
532
557
|
PartyTypeString?: string | undefined;
|
|
533
558
|
GenderString?: string | undefined;
|
|
559
|
+
ProfileType?: ProfileType | undefined;
|
|
560
|
+
EngagementPreferences?: EngagementPreferences | undefined;
|
|
534
561
|
}
|
|
535
562
|
export interface BatchGetProfileResponse {
|
|
536
563
|
Errors?: BatchGetProfileError[] | undefined;
|
|
@@ -902,6 +929,8 @@ export interface CreateProfileRequest {
|
|
|
902
929
|
Attributes?: Record<string, string> | undefined;
|
|
903
930
|
PartyTypeString?: string | undefined;
|
|
904
931
|
GenderString?: string | undefined;
|
|
932
|
+
ProfileType?: ProfileType | undefined;
|
|
933
|
+
EngagementPreferences?: EngagementPreferences | undefined;
|
|
905
934
|
}
|
|
906
935
|
export interface CreateProfileResponse {
|
|
907
936
|
ProfileId: string | undefined;
|
|
@@ -923,6 +952,16 @@ export interface DateDimension {
|
|
|
923
952
|
DimensionType: DateDimensionType | undefined;
|
|
924
953
|
Values: string[] | undefined;
|
|
925
954
|
}
|
|
955
|
+
export declare const ProfileTypeDimensionType: {
|
|
956
|
+
readonly EXCLUSIVE: "EXCLUSIVE";
|
|
957
|
+
readonly INCLUSIVE: "INCLUSIVE";
|
|
958
|
+
};
|
|
959
|
+
export type ProfileTypeDimensionType =
|
|
960
|
+
(typeof ProfileTypeDimensionType)[keyof typeof ProfileTypeDimensionType];
|
|
961
|
+
export interface ProfileTypeDimension {
|
|
962
|
+
DimensionType: ProfileTypeDimensionType | undefined;
|
|
963
|
+
Values: ProfileType[] | undefined;
|
|
964
|
+
}
|
|
926
965
|
export interface ProfileAttributes {
|
|
927
966
|
AccountNumber?: ProfileDimension | undefined;
|
|
928
967
|
AdditionalInformation?: ExtraLengthValueProfileDimension | undefined;
|
|
@@ -945,6 +984,7 @@ export interface ProfileAttributes {
|
|
|
945
984
|
MailingAddress?: AddressDimension | undefined;
|
|
946
985
|
BillingAddress?: AddressDimension | undefined;
|
|
947
986
|
Attributes?: Record<string, AttributeDimension> | undefined;
|
|
987
|
+
ProfileType?: ProfileTypeDimension | undefined;
|
|
948
988
|
}
|
|
949
989
|
export type Dimension =
|
|
950
990
|
| Dimension.CalculatedAttributesMember
|
|
@@ -1907,6 +1947,8 @@ export interface FieldSourceProfileIds {
|
|
|
1907
1947
|
MailingAddress?: string | undefined;
|
|
1908
1948
|
BillingAddress?: string | undefined;
|
|
1909
1949
|
Attributes?: Record<string, string> | undefined;
|
|
1950
|
+
ProfileType?: string | undefined;
|
|
1951
|
+
EngagementPreferences?: string | undefined;
|
|
1910
1952
|
}
|
|
1911
1953
|
export interface MergeProfilesRequest {
|
|
1912
1954
|
DomainName: string | undefined;
|
|
@@ -1948,59 +1990,6 @@ export interface PutProfileObjectRequest {
|
|
|
1948
1990
|
export interface PutProfileObjectResponse {
|
|
1949
1991
|
ProfileObjectUniqueKey?: string | undefined;
|
|
1950
1992
|
}
|
|
1951
|
-
export interface PutProfileObjectTypeRequest {
|
|
1952
|
-
DomainName: string | undefined;
|
|
1953
|
-
ObjectTypeName: string | undefined;
|
|
1954
|
-
Description: string | undefined;
|
|
1955
|
-
TemplateId?: string | undefined;
|
|
1956
|
-
ExpirationDays?: number | undefined;
|
|
1957
|
-
EncryptionKey?: string | undefined;
|
|
1958
|
-
AllowProfileCreation?: boolean | undefined;
|
|
1959
|
-
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
1960
|
-
MaxProfileObjectCount?: number | undefined;
|
|
1961
|
-
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
1962
|
-
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
1963
|
-
Tags?: Record<string, string> | undefined;
|
|
1964
|
-
}
|
|
1965
|
-
export interface PutProfileObjectTypeResponse {
|
|
1966
|
-
ObjectTypeName: string | undefined;
|
|
1967
|
-
Description: string | undefined;
|
|
1968
|
-
TemplateId?: string | undefined;
|
|
1969
|
-
ExpirationDays?: number | undefined;
|
|
1970
|
-
EncryptionKey?: string | undefined;
|
|
1971
|
-
AllowProfileCreation?: boolean | undefined;
|
|
1972
|
-
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
1973
|
-
MaxProfileObjectCount?: number | undefined;
|
|
1974
|
-
MaxAvailableProfileObjectCount?: number | undefined;
|
|
1975
|
-
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
1976
|
-
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
1977
|
-
CreatedAt?: Date | undefined;
|
|
1978
|
-
LastUpdatedAt?: Date | undefined;
|
|
1979
|
-
Tags?: Record<string, string> | undefined;
|
|
1980
|
-
}
|
|
1981
|
-
export declare const LogicalOperator: {
|
|
1982
|
-
readonly AND: "AND";
|
|
1983
|
-
readonly OR: "OR";
|
|
1984
|
-
};
|
|
1985
|
-
export type LogicalOperator =
|
|
1986
|
-
(typeof LogicalOperator)[keyof typeof LogicalOperator];
|
|
1987
|
-
export interface SearchProfilesRequest {
|
|
1988
|
-
NextToken?: string | undefined;
|
|
1989
|
-
MaxResults?: number | undefined;
|
|
1990
|
-
DomainName: string | undefined;
|
|
1991
|
-
KeyName: string | undefined;
|
|
1992
|
-
Values: string[] | undefined;
|
|
1993
|
-
AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
|
|
1994
|
-
LogicalOperator?: LogicalOperator | undefined;
|
|
1995
|
-
}
|
|
1996
|
-
export interface SearchProfilesResponse {
|
|
1997
|
-
Items?: Profile[] | undefined;
|
|
1998
|
-
NextToken?: string | undefined;
|
|
1999
|
-
}
|
|
2000
|
-
export interface StartUploadJobRequest {
|
|
2001
|
-
DomainName: string | undefined;
|
|
2002
|
-
JobId: string | undefined;
|
|
2003
|
-
}
|
|
2004
1993
|
export declare const AddressFilterSensitiveLog: (obj: Address) => any;
|
|
2005
1994
|
export declare const FlowDefinitionFilterSensitiveLog: (
|
|
2006
1995
|
obj: FlowDefinition
|
|
@@ -2020,6 +2009,9 @@ export declare const BatchGetCalculatedAttributeForProfileRequestFilterSensitive
|
|
|
2020
2009
|
export declare const BatchGetCalculatedAttributeForProfileResponseFilterSensitiveLog: (
|
|
2021
2010
|
obj: BatchGetCalculatedAttributeForProfileResponse
|
|
2022
2011
|
) => any;
|
|
2012
|
+
export declare const EngagementPreferencesFilterSensitiveLog: (
|
|
2013
|
+
obj: EngagementPreferences
|
|
2014
|
+
) => any;
|
|
2023
2015
|
export declare const ProfileFilterSensitiveLog: (obj: Profile) => any;
|
|
2024
2016
|
export declare const BatchGetProfileResponseFilterSensitiveLog: (
|
|
2025
2017
|
obj: BatchGetProfileResponse
|
|
@@ -2058,6 +2050,9 @@ export declare const CreateIntegrationWorkflowRequestFilterSensitiveLog: (
|
|
|
2058
2050
|
export declare const CreateProfileRequestFilterSensitiveLog: (
|
|
2059
2051
|
obj: CreateProfileRequest
|
|
2060
2052
|
) => any;
|
|
2053
|
+
export declare const ProfileTypeDimensionFilterSensitiveLog: (
|
|
2054
|
+
obj: ProfileTypeDimension
|
|
2055
|
+
) => any;
|
|
2061
2056
|
export declare const ProfileAttributesFilterSensitiveLog: (
|
|
2062
2057
|
obj: ProfileAttributes
|
|
2063
2058
|
) => any;
|
|
@@ -2146,12 +2141,3 @@ export declare const PutIntegrationRequestFilterSensitiveLog: (
|
|
|
2146
2141
|
export declare const PutProfileObjectRequestFilterSensitiveLog: (
|
|
2147
2142
|
obj: PutProfileObjectRequest
|
|
2148
2143
|
) => any;
|
|
2149
|
-
export declare const PutProfileObjectTypeRequestFilterSensitiveLog: (
|
|
2150
|
-
obj: PutProfileObjectTypeRequest
|
|
2151
|
-
) => any;
|
|
2152
|
-
export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (
|
|
2153
|
-
obj: PutProfileObjectTypeResponse
|
|
2154
|
-
) => any;
|
|
2155
|
-
export declare const SearchProfilesResponseFilterSensitiveLog: (
|
|
2156
|
-
obj: SearchProfilesResponse
|
|
2157
|
-
) => any;
|
|
@@ -1,19 +1,78 @@
|
|
|
1
1
|
import {
|
|
2
|
+
AdditionalSearchKey,
|
|
2
3
|
AttributeDetails,
|
|
3
4
|
Conditions,
|
|
5
|
+
EngagementPreferences,
|
|
4
6
|
EventTriggerCondition,
|
|
5
7
|
EventTriggerLimits,
|
|
6
8
|
Gender,
|
|
7
9
|
LayoutType,
|
|
8
10
|
MatchingRequest,
|
|
9
11
|
MatchingResponse,
|
|
12
|
+
ObjectTypeField,
|
|
13
|
+
ObjectTypeKey,
|
|
10
14
|
PartyType,
|
|
15
|
+
Profile,
|
|
16
|
+
ProfileType,
|
|
11
17
|
Readiness,
|
|
12
18
|
ReadinessStatus,
|
|
13
19
|
RuleBasedMatchingRequest,
|
|
14
20
|
RuleBasedMatchingResponse,
|
|
15
21
|
Statistic,
|
|
16
22
|
} from "./models_0";
|
|
23
|
+
export interface PutProfileObjectTypeRequest {
|
|
24
|
+
DomainName: string | undefined;
|
|
25
|
+
ObjectTypeName: string | undefined;
|
|
26
|
+
Description: string | undefined;
|
|
27
|
+
TemplateId?: string | undefined;
|
|
28
|
+
ExpirationDays?: number | undefined;
|
|
29
|
+
EncryptionKey?: string | undefined;
|
|
30
|
+
AllowProfileCreation?: boolean | undefined;
|
|
31
|
+
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
32
|
+
MaxProfileObjectCount?: number | undefined;
|
|
33
|
+
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
34
|
+
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
35
|
+
Tags?: Record<string, string> | undefined;
|
|
36
|
+
}
|
|
37
|
+
export interface PutProfileObjectTypeResponse {
|
|
38
|
+
ObjectTypeName: string | undefined;
|
|
39
|
+
Description: string | undefined;
|
|
40
|
+
TemplateId?: string | undefined;
|
|
41
|
+
ExpirationDays?: number | undefined;
|
|
42
|
+
EncryptionKey?: string | undefined;
|
|
43
|
+
AllowProfileCreation?: boolean | undefined;
|
|
44
|
+
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
45
|
+
MaxProfileObjectCount?: number | undefined;
|
|
46
|
+
MaxAvailableProfileObjectCount?: number | undefined;
|
|
47
|
+
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
48
|
+
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
49
|
+
CreatedAt?: Date | undefined;
|
|
50
|
+
LastUpdatedAt?: Date | undefined;
|
|
51
|
+
Tags?: Record<string, string> | undefined;
|
|
52
|
+
}
|
|
53
|
+
export declare const LogicalOperator: {
|
|
54
|
+
readonly AND: "AND";
|
|
55
|
+
readonly OR: "OR";
|
|
56
|
+
};
|
|
57
|
+
export type LogicalOperator =
|
|
58
|
+
(typeof LogicalOperator)[keyof typeof LogicalOperator];
|
|
59
|
+
export interface SearchProfilesRequest {
|
|
60
|
+
NextToken?: string | undefined;
|
|
61
|
+
MaxResults?: number | undefined;
|
|
62
|
+
DomainName: string | undefined;
|
|
63
|
+
KeyName: string | undefined;
|
|
64
|
+
Values: string[] | undefined;
|
|
65
|
+
AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
|
|
66
|
+
LogicalOperator?: LogicalOperator | undefined;
|
|
67
|
+
}
|
|
68
|
+
export interface SearchProfilesResponse {
|
|
69
|
+
Items?: Profile[] | undefined;
|
|
70
|
+
NextToken?: string | undefined;
|
|
71
|
+
}
|
|
72
|
+
export interface StartUploadJobRequest {
|
|
73
|
+
DomainName: string | undefined;
|
|
74
|
+
JobId: string | undefined;
|
|
75
|
+
}
|
|
17
76
|
export interface StartUploadJobResponse {}
|
|
18
77
|
export interface StopUploadJobRequest {
|
|
19
78
|
DomainName: string | undefined;
|
|
@@ -150,10 +209,21 @@ export interface UpdateProfileRequest {
|
|
|
150
209
|
Attributes?: Record<string, string> | undefined;
|
|
151
210
|
PartyTypeString?: string | undefined;
|
|
152
211
|
GenderString?: string | undefined;
|
|
212
|
+
ProfileType?: ProfileType | undefined;
|
|
213
|
+
EngagementPreferences?: EngagementPreferences | undefined;
|
|
153
214
|
}
|
|
154
215
|
export interface UpdateProfileResponse {
|
|
155
216
|
ProfileId: string | undefined;
|
|
156
217
|
}
|
|
218
|
+
export declare const PutProfileObjectTypeRequestFilterSensitiveLog: (
|
|
219
|
+
obj: PutProfileObjectTypeRequest
|
|
220
|
+
) => any;
|
|
221
|
+
export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (
|
|
222
|
+
obj: PutProfileObjectTypeResponse
|
|
223
|
+
) => any;
|
|
224
|
+
export declare const SearchProfilesResponseFilterSensitiveLog: (
|
|
225
|
+
obj: SearchProfilesResponse
|
|
226
|
+
) => any;
|
|
157
227
|
export declare const UpdateCalculatedAttributeDefinitionRequestFilterSensitiveLog: (
|
|
158
228
|
obj: UpdateCalculatedAttributeDefinitionRequest
|
|
159
229
|
) => any;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-customer-profiles",
|
|
3
3
|
"description": "AWS SDK for JavaScript Customer Profiles Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.859.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-customer-profiles",
|
|
@@ -20,17 +20,17 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/core": "3.858.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.859.0",
|
|
25
25
|
"@aws-sdk/middleware-host-header": "3.840.0",
|
|
26
26
|
"@aws-sdk/middleware-logger": "3.840.0",
|
|
27
27
|
"@aws-sdk/middleware-recursion-detection": "3.840.0",
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.858.0",
|
|
29
29
|
"@aws-sdk/region-config-resolver": "3.840.0",
|
|
30
30
|
"@aws-sdk/types": "3.840.0",
|
|
31
31
|
"@aws-sdk/util-endpoints": "3.848.0",
|
|
32
32
|
"@aws-sdk/util-user-agent-browser": "3.840.0",
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.858.0",
|
|
34
34
|
"@smithy/config-resolver": "^4.1.4",
|
|
35
35
|
"@smithy/core": "^3.7.2",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.1.0",
|