Skip to content

Commit 04e0957

Browse files
author
awstools
committed
feat(client-customer-profiles): The release updates standard profile with 2 new fields that supports account-level engagement. Updated APIs include CreateProfile, UpdateProfile, MergeProfiles, SearchProfiles, BatchGetProfile, GetSegmentMembership, CreateSegmentDefinition, CreateSegmentEstimate.
1 parent 3cf6f20 commit 04e0957

15 files changed

+942
-341
lines changed

‎clients/client-customer-profiles/src/commands/BatchGetProfileCommand.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,25 @@ export interface BatchGetProfileCommandOutput extends BatchGetProfileResponse, _
135135
* // ],
136136
* // PartyTypeString: "STRING_VALUE",
137137
* // GenderString: "STRING_VALUE",
138+
* // ProfileType: "ACCOUNT_PROFILE" || "PROFILE",
139+
* // EngagementPreferences: { // EngagementPreferences
140+
* // Phone: [ // PhonePreferenceList
141+
* // { // ContactPreference
142+
* // KeyName: "STRING_VALUE",
143+
* // KeyValue: "STRING_VALUE",
144+
* // ProfileId: "STRING_VALUE",
145+
* // ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
146+
* // },
147+
* // ],
148+
* // Email: [ // EmailPreferenceList
149+
* // {
150+
* // KeyName: "STRING_VALUE",
151+
* // KeyValue: "STRING_VALUE",
152+
* // ProfileId: "STRING_VALUE",
153+
* // ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
154+
* // },
155+
* // ],
156+
* // },
138157
* // },
139158
* // ],
140159
* // };

‎clients/client-customer-profiles/src/commands/CreateProfileCommand.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,25 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
112112
* },
113113
* PartyTypeString: "STRING_VALUE",
114114
* GenderString: "STRING_VALUE",
115+
* ProfileType: "ACCOUNT_PROFILE" || "PROFILE",
116+
* EngagementPreferences: { // EngagementPreferences
117+
* Phone: [ // PhonePreferenceList
118+
* { // ContactPreference
119+
* KeyName: "STRING_VALUE",
120+
* KeyValue: "STRING_VALUE",
121+
* ProfileId: "STRING_VALUE",
122+
* ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
123+
* },
124+
* ],
125+
* Email: [ // EmailPreferenceList
126+
* {
127+
* KeyName: "STRING_VALUE",
128+
* KeyValue: "STRING_VALUE",
129+
* ProfileId: "STRING_VALUE",
130+
* ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
131+
* },
132+
* ],
133+
* },
115134
* };
116135
* const command = new CreateProfileCommand(input);
117136
* const response = await client.send(command);

‎clients/client-customer-profiles/src/commands/CreateSegmentDefinitionCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,12 @@ export interface CreateSegmentDefinitionCommandOutput extends CreateSegmentDefin
140140
* Values: "<Values>", // required
141141
* },
142142
* },
143+
* ProfileType: { // ProfileTypeDimension
144+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE", // required
145+
* Values: [ // ProfileTypeValues // required
146+
* "ACCOUNT_PROFILE" || "PROFILE",
147+
* ],
148+
* },
143149
* },
144150
* CalculatedAttributes: { // CalculatedCustomAttributes
145151
* "<keys>": { // CalculatedAttributeDimension

‎clients/client-customer-profiles/src/commands/CreateSegmentEstimateCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,12 @@ export interface CreateSegmentEstimateCommandOutput extends CreateSegmentEstimat
136136
* Values: "<Values>", // required
137137
* },
138138
* },
139+
* ProfileType: { // ProfileTypeDimension
140+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE", // required
141+
* Values: [ // ProfileTypeValues // required
142+
* "ACCOUNT_PROFILE" || "PROFILE",
143+
* ],
144+
* },
139145
* },
140146
* CalculatedAttributes: { // CalculatedCustomAttributes
141147
* "<keys>": { // CalculatedAttributeDimension

‎clients/client-customer-profiles/src/commands/GetSegmentDefinitionCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,12 @@ export interface GetSegmentDefinitionCommandOutput extends GetSegmentDefinitionR
144144
* // Values: "<Values>", // required
145145
* // },
146146
* // },
147+
* // ProfileType: { // ProfileTypeDimension
148+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE", // required
149+
* // Values: [ // ProfileTypeValues // required
150+
* // "ACCOUNT_PROFILE" || "PROFILE",
151+
* // ],
152+
* // },
147153
* // },
148154
* // CalculatedAttributes: { // CalculatedCustomAttributes
149155
* // "<keys>": { // CalculatedAttributeDimension

‎clients/client-customer-profiles/src/commands/GetSegmentMembershipCommand.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,25 @@ export interface GetSegmentMembershipCommandOutput extends GetSegmentMembershipR
133133
* // ],
134134
* // PartyTypeString: "STRING_VALUE",
135135
* // GenderString: "STRING_VALUE",
136+
* // ProfileType: "ACCOUNT_PROFILE" || "PROFILE",
137+
* // EngagementPreferences: { // EngagementPreferences
138+
* // Phone: [ // PhonePreferenceList
139+
* // { // ContactPreference
140+
* // KeyName: "STRING_VALUE",
141+
* // KeyValue: "STRING_VALUE",
142+
* // ProfileId: "STRING_VALUE",
143+
* // ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
144+
* // },
145+
* // ],
146+
* // Email: [ // EmailPreferenceList
147+
* // {
148+
* // KeyName: "STRING_VALUE",
149+
* // KeyValue: "STRING_VALUE",
150+
* // ProfileId: "STRING_VALUE",
151+
* // ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
152+
* // },
153+
* // ],
154+
* // },
136155
* // },
137156
* // },
138157
* // ],

‎clients/client-customer-profiles/src/commands/MergeProfilesCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ export interface MergeProfilesCommandOutput extends MergeProfilesResponse, __Met
107107
* Attributes: { // AttributeSourceIdMap
108108
* "<keys>": "STRING_VALUE",
109109
* },
110+
* ProfileType: "STRING_VALUE",
111+
* EngagementPreferences: "STRING_VALUE",
110112
* },
111113
* };
112114
* const command = new MergeProfilesCommand(input);

‎clients/client-customer-profiles/src/commands/PutProfileObjectTypeCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {
1111
PutProfileObjectTypeRequestFilterSensitiveLog,
1212
PutProfileObjectTypeResponse,
1313
PutProfileObjectTypeResponseFilterSensitiveLog,
14-
} from "../models/models_0";
14+
} from "../models/models_1";
1515
import { de_PutProfileObjectTypeCommand, se_PutProfileObjectTypeCommand } from "../protocols/Aws_restJson1";
1616

1717
/**

‎clients/client-customer-profiles/src/commands/SearchProfilesCommand.ts

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
SearchProfilesRequest,
1111
SearchProfilesResponse,
1212
SearchProfilesResponseFilterSensitiveLog,
13-
} from "../models/models_0";
13+
} from "../models/models_1";
1414
import { de_SearchProfilesCommand, se_SearchProfilesCommand } from "../protocols/Aws_restJson1";
1515

1616
/**
@@ -145,6 +145,25 @@ export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __M
145145
* // ],
146146
* // PartyTypeString: "STRING_VALUE",
147147
* // GenderString: "STRING_VALUE",
148+
* // ProfileType: "ACCOUNT_PROFILE" || "PROFILE",
149+
* // EngagementPreferences: { // EngagementPreferences
150+
* // Phone: [ // PhonePreferenceList
151+
* // { // ContactPreference
152+
* // KeyName: "STRING_VALUE",
153+
* // KeyValue: "STRING_VALUE",
154+
* // ProfileId: "STRING_VALUE",
155+
* // ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
156+
* // },
157+
* // ],
158+
* // Email: [ // EmailPreferenceList
159+
* // {
160+
* // KeyName: "STRING_VALUE",
161+
* // KeyValue: "STRING_VALUE",
162+
* // ProfileId: "STRING_VALUE",
163+
* // ContactType: "PhoneNumber" || "MobilePhoneNumber" || "HomePhoneNumber" || "BusinessPhoneNumber" || "EmailAddress" || "PersonalEmailAddress" || "BusinessEmailAddress",
164+
* // },
165+
* // ],
166+
* // },
148167
* // },
149168
* // ],
150169
* // NextToken: "STRING_VALUE",

‎clients/client-customer-profiles/src/commands/StartUploadJobCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { StartUploadJobRequest } from "../models/models_0";
10-
import { StartUploadJobResponse } from "../models/models_1";
9+
import { StartUploadJobRequest, StartUploadJobResponse } from "../models/models_1";
1110
import { de_StartUploadJobCommand, se_StartUploadJobCommand } from "../protocols/Aws_restJson1";
1211

1312
/**

0 commit comments

Comments
 (0)