@aws-sdk/client-customer-profiles 3.857.0 → 3.859.0

package/dist-types/models/models_0.d.ts

@@ -1454,6 +1454,66 @@ export interface BatchGetProfileError {
      */
     ProfileId: string | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ContactType: {
+    readonly BUSINESS_EMAIL_ADDRESS: "BusinessEmailAddress";
+    readonly BUSINESS_PHONE_NUMBER: "BusinessPhoneNumber";
+    readonly EMAIL_ADDRESS: "EmailAddress";
+    readonly HOME_PHONE_NUMBER: "HomePhoneNumber";
+    readonly MOBILE_PHONE_NUMBER: "MobilePhoneNumber";
+    readonly PERSONAL_EMAIL_ADDRESS: "PersonalEmailAddress";
+    readonly PHONE_NUMBER: "PhoneNumber";
+};
+/**
+ * @public
+ */
+export type ContactType = (typeof ContactType)[keyof typeof ContactType];
+/**
+ * <p>Object that defines users contact preference.</p>
+ * @public
+ */
+export interface ContactPreference {
+    /**
+     * <p>A searchable, unique identifier of a customer profile.</p>
+     * @public
+     */
+    KeyName?: string | undefined;
+    /**
+     * <p>The key value used to look up profile based off the keyName.</p>
+     * @public
+     */
+    KeyValue?: string | undefined;
+    /**
+     * <p>The unique identifier of a customer profile.</p>
+     * @public
+     */
+    ProfileId?: string | undefined;
+    /**
+     * <p>The contact type used for engagement. For example: HomePhoneNumber,
+     *          PersonalEmailAddress.</p>
+     * @public
+     */
+    ContactType?: ContactType | undefined;
+}
+/**
+ * <p>Object that defines users preferred methods of engagement.</p>
+ * @public
+ */
+export interface EngagementPreferences {
+    /**
+     * <p>A list of phone-related contact preferences</p>
+     * @public
+     */
+    Phone?: ContactPreference[] | undefined;
+    /**
+     * <p>A list of email-related contact preferences</p>
+     * @public
+     */
+    Email?: ContactPreference[] | undefined;
+}
 /**
  * <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list
  *          that were used to find a profile returned in response to a <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request.
@@ -1498,6 +1558,18 @@ export declare const PartyType: {
  * @public
  */
 export type PartyType = (typeof PartyType)[keyof typeof PartyType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ProfileType: {
+    readonly ACCOUNT_PROFILE: "ACCOUNT_PROFILE";
+    readonly PROFILE: "PROFILE";
+};
+/**
+ * @public
+ */
+export type ProfileType = (typeof ProfileType)[keyof typeof ProfileType];
 /**
  * <p>The standard profile of a customer.</p>
  * @public
@@ -1657,6 +1729,16 @@ export interface Profile {
      * @public
      */
     GenderString?: string | undefined;
+    /**
+     * <p>The type of the profile.</p>
+     * @public
+     */
+    ProfileType?: ProfileType | undefined;
+    /**
+     * <p>The customer or account’s engagement preferences.</p>
+     * @public
+     */
+    EngagementPreferences?: EngagementPreferences | undefined;
 }
 /**
  * @public
@@ -3218,6 +3300,16 @@ export interface CreateProfileRequest {
      * @public
      */
     GenderString?: string | undefined;
+    /**
+     * <p>The type of the profile.</p>
+     * @public
+     */
+    ProfileType?: ProfileType | undefined;
+    /**
+     * <p>Object that defines the preferred methods of engagement, per channel.</p>
+     * @public
+     */
+    EngagementPreferences?: EngagementPreferences | undefined;
 }
 /**
  * @public
@@ -3277,6 +3369,34 @@ export interface DateDimension {
      */
     Values: string[] | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ProfileTypeDimensionType: {
+    readonly EXCLUSIVE: "EXCLUSIVE";
+    readonly INCLUSIVE: "INCLUSIVE";
+};
+/**
+ * @public
+ */
+export type ProfileTypeDimensionType = (typeof ProfileTypeDimensionType)[keyof typeof ProfileTypeDimensionType];
+/**
+ * <p>Object to hold the dimension of a profile type field to segment on.</p>
+ * @public
+ */
+export interface ProfileTypeDimension {
+    /**
+     * <p>The action to segment on.</p>
+     * @public
+     */
+    DimensionType: ProfileTypeDimensionType | undefined;
+    /**
+     * <p>The values to apply the DimensionType on.</p>
+     * @public
+     */
+    Values: ProfileType[] | undefined;
+}
 /**
  * <p>The object used to segment on attributes within the customer profile.</p>
  * @public
@@ -3387,6 +3507,11 @@ export interface ProfileAttributes {
      * @public
      */
     Attributes?: Record<string, AttributeDimension> | undefined;
+    /**
+     * <p>A field to describe values to segment on within profile type.</p>
+     * @public
+     */
+    ProfileType?: ProfileTypeDimension | undefined;
 }
 /**
  * <p>Object that holds what profile and calculated attributes to segment on.</p>
@@ -7310,6 +7435,16 @@ export interface FieldSourceProfileIds {
      * @public
      */
     Attributes?: Record<string, string> | undefined;
+    /**
+     * <p>A unique identifier for the profile type field to be merged.</p>
+     * @public
+     */
+    ProfileType?: string | undefined;
+    /**
+     * <p>A unique identifier for the engagement preferences field to be merged.</p>
+     * @public
+     */
+    EngagementPreferences?: string | undefined;
 }
 /**
  * @public
@@ -7493,276 +7628,6 @@ export interface PutProfileObjectResponse {
      */
     ProfileObjectUniqueKey?: string | undefined;
 }
-/**
- * @public
- */
-export interface PutProfileObjectTypeRequest {
-    /**
-     * <p>The unique name of the domain.</p>
-     * @public
-     */
-    DomainName: string | undefined;
-    /**
-     * <p>The name of the profile object type.</p>
-     * @public
-     */
-    ObjectTypeName: string | undefined;
-    /**
-     * <p>Description of the profile object type.</p>
-     * @public
-     */
-    Description: string | undefined;
-    /**
-     * <p>A unique identifier for the object template. For some attributes in the request, the
-     *          service will use the default value from the object template when TemplateId is present. If
-     *          these attributes are present in the request, the service may return a
-     *             <code>BadRequestException</code>. These attributes include: AllowProfileCreation,
-     *          SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is
-     *          set to true when TemplateId is set, the service may return a
-     *             <code>BadRequestException</code>.</p>
-     * @public
-     */
-    TemplateId?: string | undefined;
-    /**
-     * <p>The number of days until the data in the object expires.</p>
-     * @public
-     */
-    ExpirationDays?: number | undefined;
-    /**
-     * <p>The customer-provided key to encrypt the profile object that will be created in this
-     *          profile object type.</p>
-     * @public
-     */
-    EncryptionKey?: string | undefined;
-    /**
-     * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
-     *          for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
-     *          flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
-     *          associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
-     *          is found, then the service creates a new standard profile.</p>
-     * @public
-     */
-    AllowProfileCreation?: boolean | undefined;
-    /**
-     * <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.
-     *       </p>
-     * @public
-     */
-    SourceLastUpdatedTimestampFormat?: string | undefined;
-    /**
-     * <p>The amount of profile object max count assigned to the object type</p>
-     * @public
-     */
-    MaxProfileObjectCount?: number | undefined;
-    /**
-     * <p>A map of the name and ObjectType field.</p>
-     * @public
-     */
-    Fields?: Record<string, ObjectTypeField> | undefined;
-    /**
-     * <p>A list of unique keys that can be used to map data to the profile.</p>
-     * @public
-     */
-    Keys?: Record<string, ObjectTypeKey[]> | undefined;
-    /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
-     * @public
-     */
-    Tags?: Record<string, string> | undefined;
-}
-/**
- * @public
- */
-export interface PutProfileObjectTypeResponse {
-    /**
-     * <p>The name of the profile object type.</p>
-     * @public
-     */
-    ObjectTypeName: string | undefined;
-    /**
-     * <p>Description of the profile object type.</p>
-     * @public
-     */
-    Description: string | undefined;
-    /**
-     * <p>A unique identifier for the object template.</p>
-     * @public
-     */
-    TemplateId?: string | undefined;
-    /**
-     * <p>The number of days until the data in the object expires.</p>
-     * @public
-     */
-    ExpirationDays?: number | undefined;
-    /**
-     * <p>The customer-provided key to encrypt the profile object that will be created in this
-     *          profile object type.</p>
-     * @public
-     */
-    EncryptionKey?: string | undefined;
-    /**
-     * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
-     *          for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
-     *          flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
-     *          associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
-     *          is found, then the service creates a new standard profile.</p>
-     * @public
-     */
-    AllowProfileCreation?: boolean | undefined;
-    /**
-     * <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in
-     *          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
-     *          field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.</p>
-     * @public
-     */
-    SourceLastUpdatedTimestampFormat?: string | undefined;
-    /**
-     * <p>The amount of profile object max count assigned to the object type.</p>
-     * @public
-     */
-    MaxProfileObjectCount?: number | undefined;
-    /**
-     * <p>The amount of provisioned profile object max count available.</p>
-     * @public
-     */
-    MaxAvailableProfileObjectCount?: number | undefined;
-    /**
-     * <p>A map of the name and ObjectType field.</p>
-     * @public
-     */
-    Fields?: Record<string, ObjectTypeField> | undefined;
-    /**
-     * <p>A list of unique keys that can be used to map data to the profile.</p>
-     * @public
-     */
-    Keys?: Record<string, ObjectTypeKey[]> | undefined;
-    /**
-     * <p>The timestamp of when the domain was created.</p>
-     * @public
-     */
-    CreatedAt?: Date | undefined;
-    /**
-     * <p>The timestamp of when the domain was most recently edited.</p>
-     * @public
-     */
-    LastUpdatedAt?: Date | undefined;
-    /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
-     * @public
-     */
-    Tags?: Record<string, string> | undefined;
-}
-/**
- * @public
- * @enum
- */
-export declare const LogicalOperator: {
-    readonly AND: "AND";
-    readonly OR: "OR";
-};
-/**
- * @public
- */
-export type LogicalOperator = (typeof LogicalOperator)[keyof typeof LogicalOperator];
-/**
- * @public
- */
-export interface SearchProfilesRequest {
-    /**
-     * <p>The pagination token from the previous SearchProfiles API call.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-    /**
-     * <p>The maximum number of objects returned per page.</p>
-     *          <p>The default is 20 if this parameter is not included in the request.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <p>The unique name of the domain.</p>
-     * @public
-     */
-    DomainName: string | undefined;
-    /**
-     * <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,
-     *          _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
-     *          _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId,
-     *          _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
-     *          _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
-     * @public
-     */
-    KeyName: string | undefined;
-    /**
-     * <p>A list of key values.</p>
-     * @public
-     */
-    Values: string[] | undefined;
-    /**
-     * <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers
-     *          of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code>
-     *          and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s)
-     *          pair). These additional search keys will be used in conjunction with the
-     *             <code>LogicalOperator</code> and the required <code>KeyName</code> and
-     *             <code>Values</code> parameters to search for profiles that satisfy the search criteria.
-     *       </p>
-     * @public
-     */
-    AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
-    /**
-     * <p>Relationship between all specified search keys that will be used to search for profiles.
-     *          This includes the required <code>KeyName</code> and <code>Values</code> parameters as well
-     *          as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
-     *          <p>This parameter influences which profiles will be returned in the response in the
-     *          following manner:</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>AND</code> - The response only includes profiles that match all of the
-     *                search keys.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>OR</code> - The response includes profiles that match at least one of the
-     *                search keys.</p>
-     *             </li>
-     *          </ul>
-     *          <p>The <code>OR</code> relationship is the default behavior if this parameter is not
-     *          included in the request.</p>
-     * @public
-     */
-    LogicalOperator?: LogicalOperator | undefined;
-}
-/**
- * @public
- */
-export interface SearchProfilesResponse {
-    /**
-     * <p>The list of Profiles matching the search criteria.</p>
-     * @public
-     */
-    Items?: Profile[] | undefined;
-    /**
-     * <p>The pagination token from the previous SearchProfiles API call.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface StartUploadJobRequest {
-    /**
-     * <p>The unique name of the domain containing the upload job to start. </p>
-     * @public
-     */
-    DomainName: string | undefined;
-    /**
-     * <p>The unique identifier of the upload job to start. </p>
-     * @public
-     */
-    JobId: string | undefined;
-}
 /**
  * @internal
  */
@@ -7791,6 +7656,10 @@ export declare const BatchGetCalculatedAttributeForProfileRequestFilterSensitive
  * @internal
  */
 export declare const BatchGetCalculatedAttributeForProfileResponseFilterSensitiveLog: (obj: BatchGetCalculatedAttributeForProfileResponse) => any;
+/**
+ * @internal
+ */
+export declare const EngagementPreferencesFilterSensitiveLog: (obj: EngagementPreferences) => any;
 /**
  * @internal
  */
@@ -7847,6 +7716,10 @@ export declare const CreateIntegrationWorkflowRequestFilterSensitiveLog: (obj: C
  * @internal
  */
 export declare const CreateProfileRequestFilterSensitiveLog: (obj: CreateProfileRequest) => any;
+/**
+ * @internal
+ */
+export declare const ProfileTypeDimensionFilterSensitiveLog: (obj: ProfileTypeDimension) => any;
 /**
  * @internal
  */
@@ -7975,15 +7848,3 @@ export declare const PutIntegrationRequestFilterSensitiveLog: (obj: PutIntegrati
  * @internal
  */
 export declare const PutProfileObjectRequestFilterSensitiveLog: (obj: PutProfileObjectRequest) => any;
-/**
- * @internal
- */
-export declare const PutProfileObjectTypeRequestFilterSensitiveLog: (obj: PutProfileObjectTypeRequest) => any;
-/**
- * @internal
- */
-export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (obj: PutProfileObjectTypeResponse) => any;
-/**
- * @internal
- */
-export declare const SearchProfilesResponseFilterSensitiveLog: (obj: SearchProfilesResponse) => any;