Skip to content

Commit b56962b

Browse files
author
awstools
committed
feat(client-entityresolution): To expand support for matching records using digital identifiers with TransUnion
1 parent d711b72 commit b56962b

File tree

7 files changed

+77
-27
lines changed

7 files changed

+77
-27
lines changed

‎clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
4343
* mappedInputFields: [ // SchemaInputAttributes // required
4444
* { // SchemaInputAttribute
4545
* fieldName: "STRING_VALUE", // required
46-
* type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
46+
* type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
4747
* groupName: "STRING_VALUE",
4848
* matchKey: "STRING_VALUE",
4949
* subType: "STRING_VALUE",
@@ -63,7 +63,7 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
6363
* // mappedInputFields: [ // SchemaInputAttributes // required
6464
* // { // SchemaInputAttribute
6565
* // fieldName: "STRING_VALUE", // required
66-
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
66+
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
6767
* // groupName: "STRING_VALUE",
6868
* // matchKey: "STRING_VALUE",
6969
* // subType: "STRING_VALUE",

‎clients/client-entityresolution/src/commands/GetMatchIdCommand.ts‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,9 @@ export interface GetMatchIdCommandInput extends GetMatchIdInput {}
2828
export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the corresponding Match ID of a customer record if the record has been
32-
* processed in a
33-
* rule-based matching workflow or ML matching workflow.</p>
34-
* <p>You can call this API as a dry run of an incremental load on the rule-based
35-
* matching
31+
* <p>Returns the corresponding Match ID of a customer record if the record has been processed
32+
* in a rule-based matching workflow or ML matching workflow.</p>
33+
* <p>You can call this API as a dry run of an incremental load on the rule-based matching
3634
* workflow.</p>
3735
* @example
3836
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-entityresolution/src/commands/GetProviderServiceCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export interface GetProviderServiceCommandOutput extends GetProviderServiceOutpu
8181
* // providerSchemaAttributes: [ // ProviderSchemaAttributes
8282
* // { // ProviderSchemaAttribute
8383
* // fieldName: "STRING_VALUE", // required
84-
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
84+
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
8585
* // subType: "STRING_VALUE",
8686
* // hashing: true || false,
8787
* // },

‎clients/client-entityresolution/src/commands/GetSchemaMappingCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface GetSchemaMappingCommandOutput extends GetSchemaMappingOutput, _
4747
* // mappedInputFields: [ // SchemaInputAttributes // required
4848
* // { // SchemaInputAttribute
4949
* // fieldName: "STRING_VALUE", // required
50-
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
50+
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
5151
* // groupName: "STRING_VALUE",
5252
* // matchKey: "STRING_VALUE",
5353
* // subType: "STRING_VALUE",

‎clients/client-entityresolution/src/commands/UpdateSchemaMappingCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface UpdateSchemaMappingCommandOutput extends UpdateSchemaMappingOut
4545
* mappedInputFields: [ // SchemaInputAttributes // required
4646
* { // SchemaInputAttribute
4747
* fieldName: "STRING_VALUE", // required
48-
* type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
48+
* type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
4949
* groupName: "STRING_VALUE",
5050
* matchKey: "STRING_VALUE",
5151
* subType: "STRING_VALUE",
@@ -62,7 +62,7 @@ export interface UpdateSchemaMappingCommandOutput extends UpdateSchemaMappingOut
6262
* // mappedInputFields: [ // SchemaInputAttributes // required
6363
* // { // SchemaInputAttribute
6464
* // fieldName: "STRING_VALUE", // required
65-
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
65+
* // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
6666
* // groupName: "STRING_VALUE",
6767
* // matchKey: "STRING_VALUE",
6868
* // subType: "STRING_VALUE",

‎clients/client-entityresolution/src/models/models_0.ts‎

Lines changed: 45 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1315,6 +1315,9 @@ export const SchemaAttributeType = {
13151315
ADDRESS_STREET3: "ADDRESS_STREET3",
13161316
DATE: "DATE",
13171317
EMAIL_ADDRESS: "EMAIL_ADDRESS",
1318+
IPV4: "IPV4",
1319+
IPV6: "IPV6",
1320+
MAID: "MAID",
13181321
NAME: "NAME",
13191322
NAME_FIRST: "NAME_FIRST",
13201323
NAME_LAST: "NAME_LAST",
@@ -1333,10 +1336,9 @@ export const SchemaAttributeType = {
13331336
export type SchemaAttributeType = (typeof SchemaAttributeType)[keyof typeof SchemaAttributeType];
13341337

13351338
/**
1336-
* <p>A
1337-
* configuration object for defining input data fields in Entity Resolution. The
1338-
* SchemaInputAttribute specifies how individual fields in your input data should be processed
1339-
* and matched.</p>
1339+
* <p>A configuration object for defining input data fields in Entity Resolution. The
1340+
* <code>SchemaInputAttribute</code> specifies how individual fields in your input data
1341+
* should be processed and matched.</p>
13401342
* @public
13411343
*/
13421344
export interface SchemaInputAttribute {
@@ -1348,6 +1350,23 @@ export interface SchemaInputAttribute {
13481350

13491351
/**
13501352
* <p>The type of the attribute, selected from a list of values.</p>
1353+
* <p>LiveRamp supports: <code>NAME</code> | <code>NAME_FIRST</code> |
1354+
* <code>NAME_MIDDLE</code> | <code>NAME_LAST</code> | <code>ADDRESS</code> |
1355+
* <code>ADDRESS_STREET1</code> | <code>ADDRESS_STREET2</code> |
1356+
* <code>ADDRESS_STREET3</code> | <code>ADDRESS_CITY</code> | <code>ADDRESS_STATE</code> |
1357+
* <code>ADDRESS_COUNTRY</code> | <code>ADDRESS_POSTALCODE</code> | <code>PHONE</code> |
1358+
* <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> | <code>UNIQUE_ID</code> |
1359+
* <code>PROVIDER_ID</code>
1360+
* </p>
1361+
* <p>TransUnion supports: <code>NAME</code> | <code>NAME_FIRST</code> |
1362+
* <code>NAME_LAST</code> | <code>ADDRESS</code> | <code>ADDRESS_CITY</code> |
1363+
* <code>ADDRESS_STATE</code> | <code>ADDRESS_COUNTRY</code> |
1364+
* <code>ADDRESS_POSTALCODE</code> | <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code>
1365+
* | <code>UNIQUE_ID</code> | <code>IPV4</code> | <code>IPV6</code> | <code>MAID</code>
1366+
* </p>
1367+
* <p>Unified ID 2.0 supports: <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> |
1368+
* <code>UNIQUE_ID</code>
1369+
* </p>
13511370
* <note>
13521371
* <p>Normalization is only supported for <code>NAME</code>, <code>ADDRESS</code>,
13531372
* <code>PHONE</code>, and <code>EMAIL_ADDRESS</code>. </p>
@@ -1372,13 +1391,10 @@ export interface SchemaInputAttribute {
13721391
/**
13731392
* <p>A string that instructs Entity Resolution to combine several columns into a unified
13741393
* column with the identical attribute type. </p>
1375-
* <p>For example, when working with columns such as
1376-
* <code>NAME_FIRST</code>,
1377-
* <code>NAME_MIDDLE</code>,
1378-
* and
1379-
* <code>NAME_LAST</code>,
1380-
* assigning them a common <code>groupName</code> will prompt Entity Resolution to concatenate
1381-
* them into a single value.</p>
1394+
* <p>For example, when working with columns such as <code>NAME_FIRST</code>,
1395+
* <code>NAME_MIDDLE</code>, and <code>NAME_LAST</code>, assigning them a common
1396+
* <code>groupName</code> will prompt Entity Resolution to concatenate them into a single
1397+
* value.</p>
13821398
* @public
13831399
*/
13841400
groupName?: string | undefined;
@@ -2268,6 +2284,24 @@ export interface ProviderSchemaAttribute {
22682284

22692285
/**
22702286
* <p>The type of the provider schema attribute.</p>
2287+
* <p>LiveRamp supports: <code>NAME</code> | <code>NAME_FIRST</code> |
2288+
* <code>NAME_MIDDLE</code> | <code>NAME_LAST</code> | <code>ADDRESS</code> |
2289+
* <code>ADDRESS_STREET1</code> | <code>ADDRESS_STREET2</code> |
2290+
* <code>ADDRESS_STREET3</code> | <code>ADDRESS_CITY</code> | <code>ADDRESS_STATE</code> |
2291+
* <code>ADDRESS_COUNTRY</code> | <code>ADDRESS_POSTALCODE</code> | <code>PHONE</code> |
2292+
* <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> | <code>UNIQUE_ID</code> |
2293+
* <code>PROVIDER_ID</code>
2294+
* </p>
2295+
* <p>TransUnion supports: <code>NAME</code> | <code>NAME_FIRST</code> |
2296+
* <code>NAME_LAST</code> | <code>ADDRESS</code> | <code>ADDRESS_CITY</code> |
2297+
* <code>ADDRESS_STATE</code> | <code>ADDRESS_COUNTRY</code> |
2298+
* <code>ADDRESS_POSTALCODE</code> | <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code>
2299+
* | <code>UNIQUE_ID</code> | <code>DATE</code> | <code>IPV4</code> | <code>IPV6</code> |
2300+
* <code>MAID</code>
2301+
* </p>
2302+
* <p>Unified ID 2.0 supports: <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> |
2303+
* <code>UNIQUE_ID</code>
2304+
* </p>
22712305
* @public
22722306
*/
22732307
type: SchemaAttributeType | undefined;

0 commit comments

Comments
 (0)