@aws-sdk/client-customer-profiles 3.209.0 → 3.211.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/README.md +2 -6
- package/dist-cjs/models/models_0.js +17 -3
- package/dist-cjs/protocols/Aws_restJson1.js +35 -0
- package/dist-es/models/models_0.js +11 -0
- package/dist-es/protocols/Aws_restJson1.js +35 -0
- package/dist-types/CustomerProfiles.d.ts +7 -8
- package/dist-types/CustomerProfilesClient.d.ts +2 -6
- package/dist-types/commands/SearchProfilesCommand.d.ts +5 -2
- package/dist-types/models/models_0.d.ts +97 -1
- package/dist-types/ts3.4/models/models_0.d.ts +21 -0
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -11,15 +11,11 @@ AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Na
|
|
|
11
11
|
|
|
12
12
|
<fullname>Amazon Connect Customer Profiles</fullname>
|
|
13
13
|
|
|
14
|
-
<p>Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information
|
|
15
|
-
about the Amazon Connect Customer Profiles API, including supported operations, data types,
|
|
16
|
-
parameters, and schemas.</p>
|
|
17
14
|
<p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
|
|
18
15
|
pre-built connectors powered by AppFlow that make it easy to combine customer information
|
|
19
16
|
from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
|
|
20
|
-
enterprise resource planning (ERP), with contact history from your Amazon Connect contact
|
|
21
|
-
|
|
22
|
-
<p>If you're new to Amazon Connect , you might find it helpful to also review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/what-is-amazon-connect.html">Amazon Connect Administrator Guide</a>.</p>
|
|
17
|
+
enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
|
|
18
|
+
If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
|
|
23
19
|
|
|
24
20
|
## Installing
|
|
25
21
|
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.
|
|
5
|
-
exports.
|
|
3
|
+
exports.ConsolidationFilterSensitiveLog = exports.ConflictResolutionFilterSensitiveLog = exports.AppflowIntegrationWorkflowStepFilterSensitiveLog = exports.AppflowIntegrationWorkflowMetricsFilterSensitiveLog = exports.AppflowIntegrationWorkflowAttributesFilterSensitiveLog = exports.AppflowIntegrationFilterSensitiveLog = exports.FlowDefinitionFilterSensitiveLog = exports.TriggerConfigFilterSensitiveLog = exports.TriggerPropertiesFilterSensitiveLog = exports.ScheduledTriggerPropertiesFilterSensitiveLog = exports.TaskFilterSensitiveLog = exports.ConnectorOperatorFilterSensitiveLog = exports.SourceFlowConfigFilterSensitiveLog = exports.SourceConnectorPropertiesFilterSensitiveLog = exports.ZendeskSourcePropertiesFilterSensitiveLog = exports.ServiceNowSourcePropertiesFilterSensitiveLog = exports.SalesforceSourcePropertiesFilterSensitiveLog = exports.S3SourcePropertiesFilterSensitiveLog = exports.MarketoSourcePropertiesFilterSensitiveLog = exports.IncrementalPullConfigFilterSensitiveLog = exports.BatchFilterSensitiveLog = exports.AddressFilterSensitiveLog = exports.AddProfileKeyResponseFilterSensitiveLog = exports.AddProfileKeyRequestFilterSensitiveLog = exports.AdditionalSearchKeyFilterSensitiveLog = exports.LogicalOperator = exports.StandardIdentifier = exports.FieldContentType = exports.IdentityResolutionJobStatus = exports.PartyType = exports.Gender = exports.WorkflowType = exports.JobScheduleDayOfTheWeek = exports.ConflictResolvingModel = exports.Status = exports.TriggerType = exports.DataPullMode = exports.TaskType = exports.OperatorPropertiesKeys = exports.ZendeskConnectorOperator = exports.ServiceNowConnectorOperator = exports.SalesforceConnectorOperator = exports.S3ConnectorOperator = exports.MarketoConnectorOperator = exports.SourceConnectorType = exports.ThrottlingException = exports.ResourceNotFoundException = exports.InternalServerException = exports.BadRequestException = exports.AccessDeniedException = void 0;
|
|
4
|
+
exports.WorkflowAttributesFilterSensitiveLog = exports.GetWorkflowRequestFilterSensitiveLog = exports.GetProfileObjectTypeTemplateResponseFilterSensitiveLog = exports.GetProfileObjectTypeTemplateRequestFilterSensitiveLog = exports.GetProfileObjectTypeResponseFilterSensitiveLog = exports.ObjectTypeKeyFilterSensitiveLog = exports.ObjectTypeFieldFilterSensitiveLog = exports.GetProfileObjectTypeRequestFilterSensitiveLog = exports.GetMatchesResponseFilterSensitiveLog = exports.MatchItemFilterSensitiveLog = exports.GetMatchesRequestFilterSensitiveLog = exports.GetIntegrationResponseFilterSensitiveLog = exports.GetIntegrationRequestFilterSensitiveLog = exports.GetIdentityResolutionJobResponseFilterSensitiveLog = exports.JobStatsFilterSensitiveLog = exports.ExportingLocationFilterSensitiveLog = exports.S3ExportingLocationFilterSensitiveLog = exports.GetIdentityResolutionJobRequestFilterSensitiveLog = exports.GetDomainResponseFilterSensitiveLog = exports.DomainStatsFilterSensitiveLog = exports.GetDomainRequestFilterSensitiveLog = exports.GetAutoMergingPreviewResponseFilterSensitiveLog = exports.GetAutoMergingPreviewRequestFilterSensitiveLog = exports.DeleteWorkflowResponseFilterSensitiveLog = exports.DeleteWorkflowRequestFilterSensitiveLog = exports.DeleteProfileObjectTypeResponseFilterSensitiveLog = exports.DeleteProfileObjectTypeRequestFilterSensitiveLog = exports.DeleteProfileObjectResponseFilterSensitiveLog = exports.DeleteProfileObjectRequestFilterSensitiveLog = exports.DeleteProfileKeyResponseFilterSensitiveLog = exports.DeleteProfileKeyRequestFilterSensitiveLog = exports.DeleteProfileResponseFilterSensitiveLog = exports.DeleteProfileRequestFilterSensitiveLog = exports.DeleteIntegrationResponseFilterSensitiveLog = exports.DeleteIntegrationRequestFilterSensitiveLog = exports.DeleteDomainResponseFilterSensitiveLog = exports.DeleteDomainRequestFilterSensitiveLog = exports.CreateProfileResponseFilterSensitiveLog = exports.CreateProfileRequestFilterSensitiveLog = exports.CreateIntegrationWorkflowResponseFilterSensitiveLog = exports.CreateIntegrationWorkflowRequestFilterSensitiveLog = exports.IntegrationConfigFilterSensitiveLog = exports.CreateDomainResponseFilterSensitiveLog = exports.MatchingResponseFilterSensitiveLog = exports.CreateDomainRequestFilterSensitiveLog = exports.MatchingRequestFilterSensitiveLog = exports.JobScheduleFilterSensitiveLog = exports.ExportingConfigFilterSensitiveLog = exports.S3ExportingConfigFilterSensitiveLog = exports.AutoMergingFilterSensitiveLog = void 0;
|
|
5
|
+
exports.UpdateDomainResponseFilterSensitiveLog = exports.UpdateDomainRequestFilterSensitiveLog = exports.UntagResourceResponseFilterSensitiveLog = exports.UntagResourceRequestFilterSensitiveLog = exports.TagResourceResponseFilterSensitiveLog = exports.TagResourceRequestFilterSensitiveLog = exports.SearchProfilesResponseFilterSensitiveLog = exports.ProfileFilterSensitiveLog = exports.FoundByKeyValueFilterSensitiveLog = exports.SearchProfilesRequestFilterSensitiveLog = exports.PutProfileObjectTypeResponseFilterSensitiveLog = exports.PutProfileObjectTypeRequestFilterSensitiveLog = exports.PutProfileObjectResponseFilterSensitiveLog = exports.PutProfileObjectRequestFilterSensitiveLog = exports.PutIntegrationResponseFilterSensitiveLog = exports.PutIntegrationRequestFilterSensitiveLog = exports.MergeProfilesResponseFilterSensitiveLog = exports.MergeProfilesRequestFilterSensitiveLog = exports.FieldSourceProfileIdsFilterSensitiveLog = exports.ListWorkflowsResponseFilterSensitiveLog = exports.ListWorkflowsItemFilterSensitiveLog = exports.ListWorkflowsRequestFilterSensitiveLog = exports.ListTagsForResourceResponseFilterSensitiveLog = exports.ListTagsForResourceRequestFilterSensitiveLog = exports.ListProfileObjectTypeTemplatesResponseFilterSensitiveLog = exports.ListProfileObjectTypeTemplateItemFilterSensitiveLog = exports.ListProfileObjectTypeTemplatesRequestFilterSensitiveLog = exports.ListProfileObjectTypesResponseFilterSensitiveLog = exports.ListProfileObjectTypeItemFilterSensitiveLog = exports.ListProfileObjectTypesRequestFilterSensitiveLog = exports.ListProfileObjectsResponseFilterSensitiveLog = exports.ListProfileObjectsItemFilterSensitiveLog = exports.ListProfileObjectsRequestFilterSensitiveLog = exports.ObjectFilterFilterSensitiveLog = exports.ListIntegrationsResponseFilterSensitiveLog = exports.ListIntegrationsRequestFilterSensitiveLog = exports.ListIdentityResolutionJobsResponseFilterSensitiveLog = exports.IdentityResolutionJobFilterSensitiveLog = exports.ListIdentityResolutionJobsRequestFilterSensitiveLog = exports.ListDomainsResponseFilterSensitiveLog = exports.ListDomainItemFilterSensitiveLog = exports.ListDomainsRequestFilterSensitiveLog = exports.ListAccountIntegrationsResponseFilterSensitiveLog = exports.ListIntegrationItemFilterSensitiveLog = exports.ListAccountIntegrationsRequestFilterSensitiveLog = exports.GetWorkflowStepsResponseFilterSensitiveLog = exports.WorkflowStepItemFilterSensitiveLog = exports.GetWorkflowStepsRequestFilterSensitiveLog = exports.GetWorkflowResponseFilterSensitiveLog = exports.WorkflowMetricsFilterSensitiveLog = void 0;
|
|
6
|
+
exports.UpdateProfileResponseFilterSensitiveLog = exports.UpdateProfileRequestFilterSensitiveLog = exports.UpdateAddressFilterSensitiveLog = void 0;
|
|
6
7
|
const CustomerProfilesServiceException_1 = require("./CustomerProfilesServiceException");
|
|
7
8
|
class AccessDeniedException extends CustomerProfilesServiceException_1.CustomerProfilesServiceException {
|
|
8
9
|
constructor(opts) {
|
|
@@ -297,6 +298,15 @@ var StandardIdentifier;
|
|
|
297
298
|
StandardIdentifier["SECONDARY"] = "SECONDARY";
|
|
298
299
|
StandardIdentifier["UNIQUE"] = "UNIQUE";
|
|
299
300
|
})(StandardIdentifier = exports.StandardIdentifier || (exports.StandardIdentifier = {}));
|
|
301
|
+
var LogicalOperator;
|
|
302
|
+
(function (LogicalOperator) {
|
|
303
|
+
LogicalOperator["AND"] = "AND";
|
|
304
|
+
LogicalOperator["OR"] = "OR";
|
|
305
|
+
})(LogicalOperator = exports.LogicalOperator || (exports.LogicalOperator = {}));
|
|
306
|
+
const AdditionalSearchKeyFilterSensitiveLog = (obj) => ({
|
|
307
|
+
...obj,
|
|
308
|
+
});
|
|
309
|
+
exports.AdditionalSearchKeyFilterSensitiveLog = AdditionalSearchKeyFilterSensitiveLog;
|
|
300
310
|
const AddProfileKeyRequestFilterSensitiveLog = (obj) => ({
|
|
301
311
|
...obj,
|
|
302
312
|
});
|
|
@@ -757,6 +767,10 @@ const SearchProfilesRequestFilterSensitiveLog = (obj) => ({
|
|
|
757
767
|
...obj,
|
|
758
768
|
});
|
|
759
769
|
exports.SearchProfilesRequestFilterSensitiveLog = SearchProfilesRequestFilterSensitiveLog;
|
|
770
|
+
const FoundByKeyValueFilterSensitiveLog = (obj) => ({
|
|
771
|
+
...obj,
|
|
772
|
+
});
|
|
773
|
+
exports.FoundByKeyValueFilterSensitiveLog = FoundByKeyValueFilterSensitiveLog;
|
|
760
774
|
const ProfileFilterSensitiveLog = (obj) => ({
|
|
761
775
|
...obj,
|
|
762
776
|
});
|
|
@@ -816,7 +816,11 @@ const serializeAws_restJson1SearchProfilesCommand = async (input, context) => {
|
|
|
816
816
|
});
|
|
817
817
|
let body;
|
|
818
818
|
body = JSON.stringify({
|
|
819
|
+
...(input.AdditionalSearchKeys != null && {
|
|
820
|
+
AdditionalSearchKeys: serializeAws_restJson1additionalSearchKeysList(input.AdditionalSearchKeys, context),
|
|
821
|
+
}),
|
|
819
822
|
...(input.KeyName != null && { KeyName: input.KeyName }),
|
|
823
|
+
...(input.LogicalOperator != null && { LogicalOperator: input.LogicalOperator }),
|
|
820
824
|
...(input.Values != null && { Values: serializeAws_restJson1requestValueList(input.Values, context) }),
|
|
821
825
|
});
|
|
822
826
|
return new protocol_http_1.HttpRequest({
|
|
@@ -3037,6 +3041,19 @@ const deserializeAws_restJson1ThrottlingExceptionResponse = async (parsedOutput,
|
|
|
3037
3041
|
});
|
|
3038
3042
|
return (0, smithy_client_1.decorateServiceException)(exception, parsedOutput.body);
|
|
3039
3043
|
};
|
|
3044
|
+
const serializeAws_restJson1AdditionalSearchKey = (input, context) => {
|
|
3045
|
+
return {
|
|
3046
|
+
...(input.KeyName != null && { KeyName: input.KeyName }),
|
|
3047
|
+
...(input.Values != null && { Values: serializeAws_restJson1requestValueList(input.Values, context) }),
|
|
3048
|
+
};
|
|
3049
|
+
};
|
|
3050
|
+
const serializeAws_restJson1additionalSearchKeysList = (input, context) => {
|
|
3051
|
+
return input
|
|
3052
|
+
.filter((e) => e != null)
|
|
3053
|
+
.map((entry) => {
|
|
3054
|
+
return serializeAws_restJson1AdditionalSearchKey(entry, context);
|
|
3055
|
+
});
|
|
3056
|
+
};
|
|
3040
3057
|
const serializeAws_restJson1Address = (input, context) => {
|
|
3041
3058
|
return {
|
|
3042
3059
|
...(input.Address1 != null && { Address1: input.Address1 }),
|
|
@@ -3599,6 +3616,23 @@ const deserializeAws_restJson1FieldNameList = (output, context) => {
|
|
|
3599
3616
|
});
|
|
3600
3617
|
return retVal;
|
|
3601
3618
|
};
|
|
3619
|
+
const deserializeAws_restJson1FoundByKeyValue = (output, context) => {
|
|
3620
|
+
return {
|
|
3621
|
+
KeyName: (0, smithy_client_1.expectString)(output.KeyName),
|
|
3622
|
+
Values: output.Values != null ? deserializeAws_restJson1requestValueList(output.Values, context) : undefined,
|
|
3623
|
+
};
|
|
3624
|
+
};
|
|
3625
|
+
const deserializeAws_restJson1foundByList = (output, context) => {
|
|
3626
|
+
const retVal = (output || [])
|
|
3627
|
+
.filter((e) => e != null)
|
|
3628
|
+
.map((entry) => {
|
|
3629
|
+
if (entry === null) {
|
|
3630
|
+
return null;
|
|
3631
|
+
}
|
|
3632
|
+
return deserializeAws_restJson1FoundByKeyValue(entry, context);
|
|
3633
|
+
});
|
|
3634
|
+
return retVal;
|
|
3635
|
+
};
|
|
3602
3636
|
const deserializeAws_restJson1IdentityResolutionJob = (output, context) => {
|
|
3603
3637
|
return {
|
|
3604
3638
|
DomainName: (0, smithy_client_1.expectString)(output.DomainName),
|
|
@@ -3825,6 +3859,7 @@ const deserializeAws_restJson1Profile = (output, context) => {
|
|
|
3825
3859
|
BusinessPhoneNumber: (0, smithy_client_1.expectString)(output.BusinessPhoneNumber),
|
|
3826
3860
|
EmailAddress: (0, smithy_client_1.expectString)(output.EmailAddress),
|
|
3827
3861
|
FirstName: (0, smithy_client_1.expectString)(output.FirstName),
|
|
3862
|
+
FoundByItems: output.FoundByItems != null ? deserializeAws_restJson1foundByList(output.FoundByItems, context) : undefined,
|
|
3828
3863
|
Gender: (0, smithy_client_1.expectString)(output.Gender),
|
|
3829
3864
|
HomePhoneNumber: (0, smithy_client_1.expectString)(output.HomePhoneNumber),
|
|
3830
3865
|
LastName: (0, smithy_client_1.expectString)(output.LastName),
|
|
@@ -287,6 +287,14 @@ export var StandardIdentifier;
|
|
|
287
287
|
StandardIdentifier["SECONDARY"] = "SECONDARY";
|
|
288
288
|
StandardIdentifier["UNIQUE"] = "UNIQUE";
|
|
289
289
|
})(StandardIdentifier || (StandardIdentifier = {}));
|
|
290
|
+
export var LogicalOperator;
|
|
291
|
+
(function (LogicalOperator) {
|
|
292
|
+
LogicalOperator["AND"] = "AND";
|
|
293
|
+
LogicalOperator["OR"] = "OR";
|
|
294
|
+
})(LogicalOperator || (LogicalOperator = {}));
|
|
295
|
+
export const AdditionalSearchKeyFilterSensitiveLog = (obj) => ({
|
|
296
|
+
...obj,
|
|
297
|
+
});
|
|
290
298
|
export const AddProfileKeyRequestFilterSensitiveLog = (obj) => ({
|
|
291
299
|
...obj,
|
|
292
300
|
});
|
|
@@ -632,6 +640,9 @@ export const PutProfileObjectTypeResponseFilterSensitiveLog = (obj) => ({
|
|
|
632
640
|
export const SearchProfilesRequestFilterSensitiveLog = (obj) => ({
|
|
633
641
|
...obj,
|
|
634
642
|
});
|
|
643
|
+
export const FoundByKeyValueFilterSensitiveLog = (obj) => ({
|
|
644
|
+
...obj,
|
|
645
|
+
});
|
|
635
646
|
export const ProfileFilterSensitiveLog = (obj) => ({
|
|
636
647
|
...obj,
|
|
637
648
|
});
|
|
@@ -779,7 +779,11 @@ export const serializeAws_restJson1SearchProfilesCommand = async (input, context
|
|
|
779
779
|
});
|
|
780
780
|
let body;
|
|
781
781
|
body = JSON.stringify({
|
|
782
|
+
...(input.AdditionalSearchKeys != null && {
|
|
783
|
+
AdditionalSearchKeys: serializeAws_restJson1additionalSearchKeysList(input.AdditionalSearchKeys, context),
|
|
784
|
+
}),
|
|
782
785
|
...(input.KeyName != null && { KeyName: input.KeyName }),
|
|
786
|
+
...(input.LogicalOperator != null && { LogicalOperator: input.LogicalOperator }),
|
|
783
787
|
...(input.Values != null && { Values: serializeAws_restJson1requestValueList(input.Values, context) }),
|
|
784
788
|
});
|
|
785
789
|
return new __HttpRequest({
|
|
@@ -2957,6 +2961,19 @@ const deserializeAws_restJson1ThrottlingExceptionResponse = async (parsedOutput,
|
|
|
2957
2961
|
});
|
|
2958
2962
|
return __decorateServiceException(exception, parsedOutput.body);
|
|
2959
2963
|
};
|
|
2964
|
+
const serializeAws_restJson1AdditionalSearchKey = (input, context) => {
|
|
2965
|
+
return {
|
|
2966
|
+
...(input.KeyName != null && { KeyName: input.KeyName }),
|
|
2967
|
+
...(input.Values != null && { Values: serializeAws_restJson1requestValueList(input.Values, context) }),
|
|
2968
|
+
};
|
|
2969
|
+
};
|
|
2970
|
+
const serializeAws_restJson1additionalSearchKeysList = (input, context) => {
|
|
2971
|
+
return input
|
|
2972
|
+
.filter((e) => e != null)
|
|
2973
|
+
.map((entry) => {
|
|
2974
|
+
return serializeAws_restJson1AdditionalSearchKey(entry, context);
|
|
2975
|
+
});
|
|
2976
|
+
};
|
|
2960
2977
|
const serializeAws_restJson1Address = (input, context) => {
|
|
2961
2978
|
return {
|
|
2962
2979
|
...(input.Address1 != null && { Address1: input.Address1 }),
|
|
@@ -3519,6 +3536,23 @@ const deserializeAws_restJson1FieldNameList = (output, context) => {
|
|
|
3519
3536
|
});
|
|
3520
3537
|
return retVal;
|
|
3521
3538
|
};
|
|
3539
|
+
const deserializeAws_restJson1FoundByKeyValue = (output, context) => {
|
|
3540
|
+
return {
|
|
3541
|
+
KeyName: __expectString(output.KeyName),
|
|
3542
|
+
Values: output.Values != null ? deserializeAws_restJson1requestValueList(output.Values, context) : undefined,
|
|
3543
|
+
};
|
|
3544
|
+
};
|
|
3545
|
+
const deserializeAws_restJson1foundByList = (output, context) => {
|
|
3546
|
+
const retVal = (output || [])
|
|
3547
|
+
.filter((e) => e != null)
|
|
3548
|
+
.map((entry) => {
|
|
3549
|
+
if (entry === null) {
|
|
3550
|
+
return null;
|
|
3551
|
+
}
|
|
3552
|
+
return deserializeAws_restJson1FoundByKeyValue(entry, context);
|
|
3553
|
+
});
|
|
3554
|
+
return retVal;
|
|
3555
|
+
};
|
|
3522
3556
|
const deserializeAws_restJson1IdentityResolutionJob = (output, context) => {
|
|
3523
3557
|
return {
|
|
3524
3558
|
DomainName: __expectString(output.DomainName),
|
|
@@ -3745,6 +3779,7 @@ const deserializeAws_restJson1Profile = (output, context) => {
|
|
|
3745
3779
|
BusinessPhoneNumber: __expectString(output.BusinessPhoneNumber),
|
|
3746
3780
|
EmailAddress: __expectString(output.EmailAddress),
|
|
3747
3781
|
FirstName: __expectString(output.FirstName),
|
|
3782
|
+
FoundByItems: output.FoundByItems != null ? deserializeAws_restJson1foundByList(output.FoundByItems, context) : undefined,
|
|
3748
3783
|
Gender: __expectString(output.Gender),
|
|
3749
3784
|
HomePhoneNumber: __expectString(output.HomePhoneNumber),
|
|
3750
3785
|
LastName: __expectString(output.LastName),
|
|
@@ -40,15 +40,11 @@ import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./command
|
|
|
40
40
|
import { CustomerProfilesClient } from "./CustomerProfilesClient";
|
|
41
41
|
/**
|
|
42
42
|
* <fullname>Amazon Connect Customer Profiles</fullname>
|
|
43
|
-
* <p>Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information
|
|
44
|
-
* about the Amazon Connect Customer Profiles API, including supported operations, data types,
|
|
45
|
-
* parameters, and schemas.</p>
|
|
46
43
|
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
|
|
47
44
|
* pre-built connectors powered by AppFlow that make it easy to combine customer information
|
|
48
45
|
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
|
|
49
|
-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact
|
|
50
|
-
*
|
|
51
|
-
* <p>If you're new to Amazon Connect , you might find it helpful to also review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/what-is-amazon-connect.html">Amazon Connect Administrator Guide</a>.</p>
|
|
46
|
+
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
|
|
47
|
+
* If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
|
|
52
48
|
*/
|
|
53
49
|
export declare class CustomerProfiles extends CustomerProfilesClient {
|
|
54
50
|
/**
|
|
@@ -395,8 +391,11 @@ export declare class CustomerProfiles extends CustomerProfilesClient {
|
|
|
395
391
|
putProfileObjectType(args: PutProfileObjectTypeCommandInput, cb: (err: any, data?: PutProfileObjectTypeCommandOutput) => void): void;
|
|
396
392
|
putProfileObjectType(args: PutProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProfileObjectTypeCommandOutput) => void): void;
|
|
397
393
|
/**
|
|
398
|
-
* <p>Searches for profiles within a specific domain
|
|
399
|
-
*
|
|
394
|
+
* <p>Searches for profiles within a specific domain using one or more predefined search keys
|
|
395
|
+
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key
|
|
396
|
+
* is a data type pair that consists of a <code>KeyName</code> and <code>Values</code> list.</p>
|
|
397
|
+
* <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to
|
|
398
|
+
* 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
|
|
400
399
|
*/
|
|
401
400
|
searchProfiles(args: SearchProfilesCommandInput, options?: __HttpHandlerOptions): Promise<SearchProfilesCommandOutput>;
|
|
402
401
|
searchProfiles(args: SearchProfilesCommandInput, cb: (err: any, data?: SearchProfilesCommandOutput) => void): void;
|
|
@@ -162,15 +162,11 @@ export interface CustomerProfilesClientResolvedConfig extends CustomerProfilesCl
|
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
164
|
* <fullname>Amazon Connect Customer Profiles</fullname>
|
|
165
|
-
* <p>Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information
|
|
166
|
-
* about the Amazon Connect Customer Profiles API, including supported operations, data types,
|
|
167
|
-
* parameters, and schemas.</p>
|
|
168
165
|
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
|
|
169
166
|
* pre-built connectors powered by AppFlow that make it easy to combine customer information
|
|
170
167
|
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
|
|
171
|
-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact
|
|
172
|
-
*
|
|
173
|
-
* <p>If you're new to Amazon Connect , you might find it helpful to also review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/what-is-amazon-connect.html">Amazon Connect Administrator Guide</a>.</p>
|
|
168
|
+
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
|
|
169
|
+
* If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
|
|
174
170
|
*/
|
|
175
171
|
export declare class CustomerProfilesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CustomerProfilesClientResolvedConfig> {
|
|
176
172
|
/**
|
|
@@ -8,8 +8,11 @@ export interface SearchProfilesCommandInput extends SearchProfilesRequest {
|
|
|
8
8
|
export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Searches for profiles within a specific domain
|
|
12
|
-
*
|
|
11
|
+
* <p>Searches for profiles within a specific domain using one or more predefined search keys
|
|
12
|
+
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key
|
|
13
|
+
* is a data type pair that consists of a <code>KeyName</code> and <code>Values</code> list.</p>
|
|
14
|
+
* <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to
|
|
15
|
+
* 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
|
|
13
16
|
* @example
|
|
14
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
18
|
* ```javascript
|
|
@@ -12,6 +12,24 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list that is
|
|
17
|
+
* used in conjunction with the
|
|
18
|
+
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName">KeyName</a>
|
|
19
|
+
* and
|
|
20
|
+
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values">Values</a>
|
|
21
|
+
* parameters to search for profiles using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> API.</p>
|
|
22
|
+
*/
|
|
23
|
+
export interface AdditionalSearchKey {
|
|
24
|
+
/**
|
|
25
|
+
* <p>A searchable identifier of a customer profile.</p>
|
|
26
|
+
*/
|
|
27
|
+
KeyName: string | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* <p>A list of key values.</p>
|
|
30
|
+
*/
|
|
31
|
+
Values: string[] | undefined;
|
|
32
|
+
}
|
|
15
33
|
export interface AddProfileKeyRequest {
|
|
16
34
|
/**
|
|
17
35
|
* <p>The unique identifier of a customer profile.</p>
|
|
@@ -2608,6 +2626,10 @@ export interface PutProfileObjectTypeResponse {
|
|
|
2608
2626
|
*/
|
|
2609
2627
|
Tags?: Record<string, string>;
|
|
2610
2628
|
}
|
|
2629
|
+
export declare enum LogicalOperator {
|
|
2630
|
+
AND = "AND",
|
|
2631
|
+
OR = "OR"
|
|
2632
|
+
}
|
|
2611
2633
|
export interface SearchProfilesRequest {
|
|
2612
2634
|
/**
|
|
2613
2635
|
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
@@ -2615,6 +2637,7 @@ export interface SearchProfilesRequest {
|
|
|
2615
2637
|
NextToken?: string;
|
|
2616
2638
|
/**
|
|
2617
2639
|
* <p>The maximum number of objects returned per page.</p>
|
|
2640
|
+
* <p>The default is 20 if this parameter is not included in the request.</p>
|
|
2618
2641
|
*/
|
|
2619
2642
|
MaxResults?: number;
|
|
2620
2643
|
/**
|
|
@@ -2634,6 +2657,47 @@ export interface SearchProfilesRequest {
|
|
|
2634
2657
|
* <p>A list of key values.</p>
|
|
2635
2658
|
*/
|
|
2636
2659
|
Values: string[] | undefined;
|
|
2660
|
+
/**
|
|
2661
|
+
* <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers of a
|
|
2662
|
+
* profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code> and a
|
|
2663
|
+
* list of <code>Values</code> associated with that specific key (i.e., a key-value(s) pair).
|
|
2664
|
+
* These additional search keys will be used in conjunction with the <code>LogicalOperator</code> and the
|
|
2665
|
+
* required <code>KeyName</code> and <code>Values</code> parameters to search for profiles
|
|
2666
|
+
* that satisfy the search criteria. </p>
|
|
2667
|
+
*/
|
|
2668
|
+
AdditionalSearchKeys?: AdditionalSearchKey[];
|
|
2669
|
+
/**
|
|
2670
|
+
* <p>Relationship between all specified search keys that will be used to search for
|
|
2671
|
+
* profiles. This includes the required <code>KeyName</code> and <code>Values</code> parameters
|
|
2672
|
+
* as well as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
|
|
2673
|
+
* <p>This parameter influences which profiles will be returned in the response in the following manner:</p>
|
|
2674
|
+
* <ul>
|
|
2675
|
+
* <li>
|
|
2676
|
+
* <p>
|
|
2677
|
+
* <code>AND</code> - The response only includes profiles that match all of the search keys.</p>
|
|
2678
|
+
* </li>
|
|
2679
|
+
* <li>
|
|
2680
|
+
* <p>
|
|
2681
|
+
* <code>OR</code> - The response includes profiles that match at least one of the search keys.</p>
|
|
2682
|
+
* </li>
|
|
2683
|
+
* </ul>
|
|
2684
|
+
* <p>The <code>OR</code> relationship is the default behavior if this parameter is not included in the request.</p>
|
|
2685
|
+
*/
|
|
2686
|
+
LogicalOperator?: LogicalOperator | string;
|
|
2687
|
+
}
|
|
2688
|
+
/**
|
|
2689
|
+
* <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list that were used
|
|
2690
|
+
* 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. </p>
|
|
2691
|
+
*/
|
|
2692
|
+
export interface FoundByKeyValue {
|
|
2693
|
+
/**
|
|
2694
|
+
* <p>A searchable identifier of a customer profile.</p>
|
|
2695
|
+
*/
|
|
2696
|
+
KeyName?: string;
|
|
2697
|
+
/**
|
|
2698
|
+
* <p>A list of key values.</p>
|
|
2699
|
+
*/
|
|
2700
|
+
Values?: string[];
|
|
2637
2701
|
}
|
|
2638
2702
|
/**
|
|
2639
2703
|
* <p>The standard profile of a customer.</p>
|
|
@@ -2730,10 +2794,34 @@ export interface Profile {
|
|
|
2730
2794
|
* <p>A key value pair of attributes of a customer profile.</p>
|
|
2731
2795
|
*/
|
|
2732
2796
|
Attributes?: Record<string, string>;
|
|
2797
|
+
/**
|
|
2798
|
+
* <p>A list of items used to find a profile returned in a <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> response.
|
|
2799
|
+
* An item is a key-value(s) pair that matches an attribute in the profile.</p>
|
|
2800
|
+
* <p>If the optional <code>AdditionalSearchKeys</code> parameter was included in the
|
|
2801
|
+
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request, the <code>FoundByItems</code> list should be
|
|
2802
|
+
* interpreted based on the <code>LogicalOperator</code> used in the request:</p>
|
|
2803
|
+
* <ul>
|
|
2804
|
+
* <li>
|
|
2805
|
+
* <p>
|
|
2806
|
+
* <code>AND</code> - The profile included in the response matched all of the search keys
|
|
2807
|
+
* specified in the request. The <code>FoundByItems</code> will include all of the key-value(s)
|
|
2808
|
+
* pairs that were specified in the request (as this is a requirement of <code>AND</code> search logic).</p>
|
|
2809
|
+
* </li>
|
|
2810
|
+
* <li>
|
|
2811
|
+
* <p>
|
|
2812
|
+
* <code>OR</code> - The profile included in the response matched at least one of the
|
|
2813
|
+
* search keys specified in the request. The <code>FoundByItems</code> will
|
|
2814
|
+
* include each of the key-value(s) pairs that the profile was found by.</p>
|
|
2815
|
+
* </li>
|
|
2816
|
+
* </ul>
|
|
2817
|
+
* <p>The <code>OR</code> relationship is the default behavior if the <code>LogicalOperator</code> parameter is
|
|
2818
|
+
* not included in the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request.</p>
|
|
2819
|
+
*/
|
|
2820
|
+
FoundByItems?: FoundByKeyValue[];
|
|
2733
2821
|
}
|
|
2734
2822
|
export interface SearchProfilesResponse {
|
|
2735
2823
|
/**
|
|
2736
|
-
* <p>The list of
|
|
2824
|
+
* <p>The list of Profiles matching the search criteria.</p>
|
|
2737
2825
|
*/
|
|
2738
2826
|
Items?: Profile[];
|
|
2739
2827
|
/**
|
|
@@ -2995,6 +3083,10 @@ export interface UpdateProfileResponse {
|
|
|
2995
3083
|
*/
|
|
2996
3084
|
ProfileId: string | undefined;
|
|
2997
3085
|
}
|
|
3086
|
+
/**
|
|
3087
|
+
* @internal
|
|
3088
|
+
*/
|
|
3089
|
+
export declare const AdditionalSearchKeyFilterSensitiveLog: (obj: AdditionalSearchKey) => any;
|
|
2998
3090
|
/**
|
|
2999
3091
|
* @internal
|
|
3000
3092
|
*/
|
|
@@ -3455,6 +3547,10 @@ export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (obj: PutPr
|
|
|
3455
3547
|
* @internal
|
|
3456
3548
|
*/
|
|
3457
3549
|
export declare const SearchProfilesRequestFilterSensitiveLog: (obj: SearchProfilesRequest) => any;
|
|
3550
|
+
/**
|
|
3551
|
+
* @internal
|
|
3552
|
+
*/
|
|
3553
|
+
export declare const FoundByKeyValueFilterSensitiveLog: (obj: FoundByKeyValue) => any;
|
|
3458
3554
|
/**
|
|
3459
3555
|
* @internal
|
|
3460
3556
|
*/
|
|
@@ -8,6 +8,10 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
8
8
|
opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
|
|
9
9
|
);
|
|
10
10
|
}
|
|
11
|
+
export interface AdditionalSearchKey {
|
|
12
|
+
KeyName: string | undefined;
|
|
13
|
+
Values: string[] | undefined;
|
|
14
|
+
}
|
|
11
15
|
export interface AddProfileKeyRequest {
|
|
12
16
|
ProfileId: string | undefined;
|
|
13
17
|
KeyName: string | undefined;
|
|
@@ -905,12 +909,22 @@ export interface PutProfileObjectTypeResponse {
|
|
|
905
909
|
LastUpdatedAt?: Date;
|
|
906
910
|
Tags?: Record<string, string>;
|
|
907
911
|
}
|
|
912
|
+
export declare enum LogicalOperator {
|
|
913
|
+
AND = "AND",
|
|
914
|
+
OR = "OR",
|
|
915
|
+
}
|
|
908
916
|
export interface SearchProfilesRequest {
|
|
909
917
|
NextToken?: string;
|
|
910
918
|
MaxResults?: number;
|
|
911
919
|
DomainName: string | undefined;
|
|
912
920
|
KeyName: string | undefined;
|
|
913
921
|
Values: string[] | undefined;
|
|
922
|
+
AdditionalSearchKeys?: AdditionalSearchKey[];
|
|
923
|
+
LogicalOperator?: LogicalOperator | string;
|
|
924
|
+
}
|
|
925
|
+
export interface FoundByKeyValue {
|
|
926
|
+
KeyName?: string;
|
|
927
|
+
Values?: string[];
|
|
914
928
|
}
|
|
915
929
|
export interface Profile {
|
|
916
930
|
ProfileId?: string;
|
|
@@ -935,6 +949,7 @@ export interface Profile {
|
|
|
935
949
|
MailingAddress?: Address;
|
|
936
950
|
BillingAddress?: Address;
|
|
937
951
|
Attributes?: Record<string, string>;
|
|
952
|
+
FoundByItems?: FoundByKeyValue[];
|
|
938
953
|
}
|
|
939
954
|
export interface SearchProfilesResponse {
|
|
940
955
|
Items?: Profile[];
|
|
@@ -1008,6 +1023,9 @@ export interface UpdateProfileRequest {
|
|
|
1008
1023
|
export interface UpdateProfileResponse {
|
|
1009
1024
|
ProfileId: string | undefined;
|
|
1010
1025
|
}
|
|
1026
|
+
export declare const AdditionalSearchKeyFilterSensitiveLog: (
|
|
1027
|
+
obj: AdditionalSearchKey
|
|
1028
|
+
) => any;
|
|
1011
1029
|
export declare const AddProfileKeyRequestFilterSensitiveLog: (
|
|
1012
1030
|
obj: AddProfileKeyRequest
|
|
1013
1031
|
) => any;
|
|
@@ -1335,6 +1353,9 @@ export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (
|
|
|
1335
1353
|
export declare const SearchProfilesRequestFilterSensitiveLog: (
|
|
1336
1354
|
obj: SearchProfilesRequest
|
|
1337
1355
|
) => any;
|
|
1356
|
+
export declare const FoundByKeyValueFilterSensitiveLog: (
|
|
1357
|
+
obj: FoundByKeyValue
|
|
1358
|
+
) => any;
|
|
1338
1359
|
export declare const ProfileFilterSensitiveLog: (obj: Profile) => any;
|
|
1339
1360
|
export declare const SearchProfilesResponseFilterSensitiveLog: (
|
|
1340
1361
|
obj: SearchProfilesResponse
|
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.211.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
21
21
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
22
|
-
"@aws-sdk/client-sts": "3.
|
|
22
|
+
"@aws-sdk/client-sts": "3.211.0",
|
|
23
23
|
"@aws-sdk/config-resolver": "3.209.0",
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.211.0",
|
|
25
25
|
"@aws-sdk/fetch-http-handler": "3.208.0",
|
|
26
26
|
"@aws-sdk/hash-node": "3.208.0",
|
|
27
27
|
"@aws-sdk/invalid-dependency": "3.208.0",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
47
47
|
"@aws-sdk/util-defaults-mode-browser": "3.209.0",
|
|
48
48
|
"@aws-sdk/util-defaults-mode-node": "3.209.0",
|
|
49
|
-
"@aws-sdk/util-endpoints": "3.
|
|
49
|
+
"@aws-sdk/util-endpoints": "3.211.0",
|
|
50
50
|
"@aws-sdk/util-user-agent-browser": "3.208.0",
|
|
51
51
|
"@aws-sdk/util-user-agent-node": "3.209.0",
|
|
52
52
|
"@aws-sdk/util-utf8-browser": "3.188.0",
|