@aws-sdk/client-customer-profiles 3.693.0 → 3.695.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.
Files changed (77) hide show
  1. package/README.md +104 -0
  2. package/dist-cjs/index.js +1265 -46
  3. package/dist-es/CustomerProfiles.js +26 -0
  4. package/dist-es/commands/BatchGetCalculatedAttributeForProfileCommand.js +23 -0
  5. package/dist-es/commands/BatchGetProfileCommand.js +23 -0
  6. package/dist-es/commands/CreateSegmentDefinitionCommand.js +23 -0
  7. package/dist-es/commands/CreateSegmentEstimateCommand.js +23 -0
  8. package/dist-es/commands/CreateSegmentSnapshotCommand.js +22 -0
  9. package/dist-es/commands/DeleteSegmentDefinitionCommand.js +22 -0
  10. package/dist-es/commands/GetSegmentDefinitionCommand.js +23 -0
  11. package/dist-es/commands/GetSegmentEstimateCommand.js +22 -0
  12. package/dist-es/commands/GetSegmentMembershipCommand.js +23 -0
  13. package/dist-es/commands/GetSegmentSnapshotCommand.js +22 -0
  14. package/dist-es/commands/ListObjectTypeAttributesCommand.js +22 -0
  15. package/dist-es/commands/ListProfileAttributeValuesCommand.js +22 -0
  16. package/dist-es/commands/ListSegmentDefinitionsCommand.js +23 -0
  17. package/dist-es/commands/index.js +13 -0
  18. package/dist-es/models/models_0.js +208 -34
  19. package/dist-es/pagination/GetSimilarProfilesPaginator.js +4 -0
  20. package/dist-es/pagination/ListObjectTypeAttributesPaginator.js +4 -0
  21. package/dist-es/pagination/ListRuleBasedMatchesPaginator.js +4 -0
  22. package/dist-es/pagination/ListSegmentDefinitionsPaginator.js +4 -0
  23. package/dist-es/pagination/index.js +4 -0
  24. package/dist-es/protocols/Aws_restJson1.js +739 -2
  25. package/dist-types/CustomerProfiles.d.ts +91 -0
  26. package/dist-types/CustomerProfilesClient.d.ts +15 -2
  27. package/dist-types/commands/BatchGetCalculatedAttributeForProfileCommand.d.ts +119 -0
  28. package/dist-types/commands/BatchGetProfileCommand.d.ts +177 -0
  29. package/dist-types/commands/CreateCalculatedAttributeDefinitionCommand.d.ts +40 -0
  30. package/dist-types/commands/CreateSegmentDefinitionCommand.d.ts +221 -0
  31. package/dist-types/commands/CreateSegmentEstimateCommand.d.ts +210 -0
  32. package/dist-types/commands/CreateSegmentSnapshotCommand.d.ts +91 -0
  33. package/dist-types/commands/DeleteSegmentDefinitionCommand.d.ts +87 -0
  34. package/dist-types/commands/DetectProfileObjectTypeCommand.d.ts +1 -1
  35. package/dist-types/commands/GetCalculatedAttributeDefinitionCommand.d.ts +20 -0
  36. package/dist-types/commands/GetProfileObjectTypeCommand.d.ts +1 -1
  37. package/dist-types/commands/GetProfileObjectTypeTemplateCommand.d.ts +1 -1
  38. package/dist-types/commands/GetSegmentDefinitionCommand.d.ts +216 -0
  39. package/dist-types/commands/GetSegmentEstimateCommand.d.ts +92 -0
  40. package/dist-types/commands/GetSegmentMembershipCommand.d.ts +183 -0
  41. package/dist-types/commands/GetSegmentSnapshotCommand.d.ts +94 -0
  42. package/dist-types/commands/ListObjectTypeAttributesCommand.d.ts +95 -0
  43. package/dist-types/commands/ListProfileAttributeValuesCommand.d.ts +94 -0
  44. package/dist-types/commands/ListSegmentDefinitionsCommand.d.ts +100 -0
  45. package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +2 -2
  46. package/dist-types/commands/index.d.ts +13 -0
  47. package/dist-types/models/models_0.d.ts +2277 -826
  48. package/dist-types/pagination/GetSimilarProfilesPaginator.d.ts +7 -0
  49. package/dist-types/pagination/ListObjectTypeAttributesPaginator.d.ts +7 -0
  50. package/dist-types/pagination/ListRuleBasedMatchesPaginator.d.ts +7 -0
  51. package/dist-types/pagination/ListSegmentDefinitionsPaginator.d.ts +7 -0
  52. package/dist-types/pagination/index.d.ts +4 -0
  53. package/dist-types/protocols/Aws_restJson1.d.ts +117 -0
  54. package/dist-types/ts3.4/CustomerProfiles.d.ts +227 -0
  55. package/dist-types/ts3.4/CustomerProfilesClient.d.ts +78 -0
  56. package/dist-types/ts3.4/commands/BatchGetCalculatedAttributeForProfileCommand.d.ts +51 -0
  57. package/dist-types/ts3.4/commands/BatchGetProfileCommand.d.ts +50 -0
  58. package/dist-types/ts3.4/commands/CreateSegmentDefinitionCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/CreateSegmentEstimateCommand.d.ts +51 -0
  60. package/dist-types/ts3.4/commands/CreateSegmentSnapshotCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/DeleteSegmentDefinitionCommand.d.ts +51 -0
  62. package/dist-types/ts3.4/commands/GetSegmentDefinitionCommand.d.ts +51 -0
  63. package/dist-types/ts3.4/commands/GetSegmentEstimateCommand.d.ts +51 -0
  64. package/dist-types/ts3.4/commands/GetSegmentMembershipCommand.d.ts +51 -0
  65. package/dist-types/ts3.4/commands/GetSegmentSnapshotCommand.d.ts +51 -0
  66. package/dist-types/ts3.4/commands/ListObjectTypeAttributesCommand.d.ts +51 -0
  67. package/dist-types/ts3.4/commands/ListProfileAttributeValuesCommand.d.ts +51 -0
  68. package/dist-types/ts3.4/commands/ListSegmentDefinitionsCommand.d.ts +51 -0
  69. package/dist-types/ts3.4/commands/index.d.ts +13 -0
  70. package/dist-types/ts3.4/models/models_0.d.ts +503 -44
  71. package/dist-types/ts3.4/pagination/GetSimilarProfilesPaginator.d.ts +11 -0
  72. package/dist-types/ts3.4/pagination/ListObjectTypeAttributesPaginator.d.ts +11 -0
  73. package/dist-types/ts3.4/pagination/ListRuleBasedMatchesPaginator.d.ts +11 -0
  74. package/dist-types/ts3.4/pagination/ListSegmentDefinitionsPaginator.d.ts +11 -0
  75. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  76. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +156 -0
  77. package/package.json +1 -1
@@ -66,6 +66,27 @@ export interface Address {
66
66
  Country?: string | undefined;
67
67
  PostalCode?: string | undefined;
68
68
  }
69
+ export declare const StringDimensionType: {
70
+ readonly BEGINS_WITH: "BEGINS_WITH";
71
+ readonly CONTAINS: "CONTAINS";
72
+ readonly ENDS_WITH: "ENDS_WITH";
73
+ readonly EXCLUSIVE: "EXCLUSIVE";
74
+ readonly INCLUSIVE: "INCLUSIVE";
75
+ };
76
+ export type StringDimensionType =
77
+ (typeof StringDimensionType)[keyof typeof StringDimensionType];
78
+ export interface ProfileDimension {
79
+ DimensionType: StringDimensionType | undefined;
80
+ Values: string[] | undefined;
81
+ }
82
+ export interface AddressDimension {
83
+ City?: ProfileDimension | undefined;
84
+ Country?: ProfileDimension | undefined;
85
+ County?: ProfileDimension | undefined;
86
+ PostalCode?: ProfileDimension | undefined;
87
+ Province?: ProfileDimension | undefined;
88
+ State?: ProfileDimension | undefined;
89
+ }
69
90
  export interface Batch {
70
91
  StartTime: Date | undefined;
71
92
  EndTime: Date | undefined;
@@ -343,6 +364,52 @@ export interface AttributeDetails {
343
364
  Attributes: AttributeItem[] | undefined;
344
365
  Expression: string | undefined;
345
366
  }
367
+ export declare const AttributeDimensionType: {
368
+ readonly AFTER: "AFTER";
369
+ readonly BEFORE: "BEFORE";
370
+ readonly BEGINS_WITH: "BEGINS_WITH";
371
+ readonly BETWEEN: "BETWEEN";
372
+ readonly CONTAINS: "CONTAINS";
373
+ readonly ENDS_WITH: "ENDS_WITH";
374
+ readonly EQUAL: "EQUAL";
375
+ readonly EXCLUSIVE: "EXCLUSIVE";
376
+ readonly GREATER_THAN: "GREATER_THAN";
377
+ readonly GREATER_THAN_OR_EQUAL: "GREATER_THAN_OR_EQUAL";
378
+ readonly INCLUSIVE: "INCLUSIVE";
379
+ readonly LESS_THAN: "LESS_THAN";
380
+ readonly LESS_THAN_OR_EQUAL: "LESS_THAN_OR_EQUAL";
381
+ readonly NOT_BETWEEN: "NOT_BETWEEN";
382
+ readonly ON: "ON";
383
+ };
384
+ export type AttributeDimensionType =
385
+ (typeof AttributeDimensionType)[keyof typeof AttributeDimensionType];
386
+ export interface AttributeDimension {
387
+ DimensionType: AttributeDimensionType | undefined;
388
+ Values: string[] | undefined;
389
+ }
390
+ export declare const FilterDimensionType: {
391
+ readonly AFTER: "AFTER";
392
+ readonly BEFORE: "BEFORE";
393
+ readonly BEGINS_WITH: "BEGINS_WITH";
394
+ readonly BETWEEN: "BETWEEN";
395
+ readonly CONTAINS: "CONTAINS";
396
+ readonly ENDS_WITH: "ENDS_WITH";
397
+ readonly EQUAL: "EQUAL";
398
+ readonly EXCLUSIVE: "EXCLUSIVE";
399
+ readonly GREATER_THAN: "GREATER_THAN";
400
+ readonly GREATER_THAN_OR_EQUAL: "GREATER_THAN_OR_EQUAL";
401
+ readonly INCLUSIVE: "INCLUSIVE";
402
+ readonly LESS_THAN: "LESS_THAN";
403
+ readonly LESS_THAN_OR_EQUAL: "LESS_THAN_OR_EQUAL";
404
+ readonly NOT_BETWEEN: "NOT_BETWEEN";
405
+ readonly ON: "ON";
406
+ };
407
+ export type FilterDimensionType =
408
+ (typeof FilterDimensionType)[keyof typeof FilterDimensionType];
409
+ export interface FilterAttributeDimension {
410
+ DimensionType: FilterDimensionType | undefined;
411
+ Values: string[] | undefined;
412
+ }
346
413
  export declare const AttributeMatchingModel: {
347
414
  readonly MANY_TO_MANY: "MANY_TO_MANY";
348
415
  readonly ONE_TO_ONE: "ONE_TO_ONE";
@@ -355,6 +422,9 @@ export interface AttributeTypesSelector {
355
422
  PhoneNumber?: string[] | undefined;
356
423
  EmailAddress?: string[] | undefined;
357
424
  }
425
+ export interface AttributeValueItem {
426
+ Value?: string | undefined;
427
+ }
358
428
  export declare const ConflictResolvingModel: {
359
429
  readonly RECENCY: "RECENCY";
360
430
  readonly SOURCE: "SOURCE";
@@ -374,6 +444,97 @@ export interface AutoMerging {
374
444
  ConflictResolution?: ConflictResolution | undefined;
375
445
  MinAllowedConfidenceScoreForMerging?: number | undefined;
376
446
  }
447
+ export declare const RangeUnit: {
448
+ readonly DAYS: "DAYS";
449
+ };
450
+ export type RangeUnit = (typeof RangeUnit)[keyof typeof RangeUnit];
451
+ export interface RangeOverride {
452
+ Start: number | undefined;
453
+ End?: number | undefined;
454
+ Unit: RangeUnit | undefined;
455
+ }
456
+ export interface ConditionOverrides {
457
+ Range?: RangeOverride | undefined;
458
+ }
459
+ export interface BatchGetCalculatedAttributeForProfileRequest {
460
+ CalculatedAttributeName: string | undefined;
461
+ DomainName: string | undefined;
462
+ ProfileIds: string[] | undefined;
463
+ ConditionOverrides?: ConditionOverrides | undefined;
464
+ }
465
+ export interface CalculatedAttributeValue {
466
+ CalculatedAttributeName?: string | undefined;
467
+ DisplayName?: string | undefined;
468
+ IsDataPartial?: string | undefined;
469
+ ProfileId?: string | undefined;
470
+ Value?: string | undefined;
471
+ }
472
+ export interface BatchGetCalculatedAttributeForProfileError {
473
+ Code: string | undefined;
474
+ Message: string | undefined;
475
+ ProfileId: string | undefined;
476
+ }
477
+ export interface BatchGetCalculatedAttributeForProfileResponse {
478
+ Errors?: BatchGetCalculatedAttributeForProfileError[] | undefined;
479
+ CalculatedAttributeValues?: CalculatedAttributeValue[] | undefined;
480
+ ConditionOverrides?: ConditionOverrides | undefined;
481
+ }
482
+ export interface BatchGetProfileRequest {
483
+ DomainName: string | undefined;
484
+ ProfileIds: string[] | undefined;
485
+ }
486
+ export interface BatchGetProfileError {
487
+ Code: string | undefined;
488
+ Message: string | undefined;
489
+ ProfileId: string | undefined;
490
+ }
491
+ export interface FoundByKeyValue {
492
+ KeyName?: string | undefined;
493
+ Values?: string[] | undefined;
494
+ }
495
+ export declare const Gender: {
496
+ readonly FEMALE: "FEMALE";
497
+ readonly MALE: "MALE";
498
+ readonly UNSPECIFIED: "UNSPECIFIED";
499
+ };
500
+ export type Gender = (typeof Gender)[keyof typeof Gender];
501
+ export declare const PartyType: {
502
+ readonly BUSINESS: "BUSINESS";
503
+ readonly INDIVIDUAL: "INDIVIDUAL";
504
+ readonly OTHER: "OTHER";
505
+ };
506
+ export type PartyType = (typeof PartyType)[keyof typeof PartyType];
507
+ export interface Profile {
508
+ ProfileId?: string | undefined;
509
+ AccountNumber?: string | undefined;
510
+ AdditionalInformation?: string | undefined;
511
+ PartyType?: PartyType | undefined;
512
+ BusinessName?: string | undefined;
513
+ FirstName?: string | undefined;
514
+ MiddleName?: string | undefined;
515
+ LastName?: string | undefined;
516
+ BirthDate?: string | undefined;
517
+ Gender?: Gender | undefined;
518
+ PhoneNumber?: string | undefined;
519
+ MobilePhoneNumber?: string | undefined;
520
+ HomePhoneNumber?: string | undefined;
521
+ BusinessPhoneNumber?: string | undefined;
522
+ EmailAddress?: string | undefined;
523
+ PersonalEmailAddress?: string | undefined;
524
+ BusinessEmailAddress?: string | undefined;
525
+ Address?: Address | undefined;
526
+ ShippingAddress?: Address | undefined;
527
+ MailingAddress?: Address | undefined;
528
+ BillingAddress?: Address | undefined;
529
+ Attributes?: Record<string, string> | undefined;
530
+ FoundByItems?: FoundByKeyValue[] | undefined;
531
+ PartyTypeString?: string | undefined;
532
+ GenderString?: string | undefined;
533
+ }
534
+ export interface BatchGetProfileResponse {
535
+ Errors?: BatchGetProfileError[] | undefined;
536
+ Profiles?: Profile[] | undefined;
537
+ }
377
538
  export interface ListCalculatedAttributeDefinitionItem {
378
539
  CalculatedAttributeName?: string | undefined;
379
540
  DisplayName?: string | undefined;
@@ -382,6 +543,11 @@ export interface ListCalculatedAttributeDefinitionItem {
382
543
  LastUpdatedAt?: Date | undefined;
383
544
  Tags?: Record<string, string> | undefined;
384
545
  }
546
+ export interface CalculatedAttributeDimension {
547
+ DimensionType: AttributeDimensionType | undefined;
548
+ Values: string[] | undefined;
549
+ ConditionOverrides?: ConditionOverrides | undefined;
550
+ }
385
551
  export interface ListCalculatedAttributeForProfileItem {
386
552
  CalculatedAttributeName?: string | undefined;
387
553
  DisplayName?: string | undefined;
@@ -412,6 +578,29 @@ export interface Conditions {
412
578
  ObjectCount?: number | undefined;
413
579
  Threshold?: Threshold | undefined;
414
580
  }
581
+ export interface FilterDimension {
582
+ Attributes: Record<string, FilterAttributeDimension> | undefined;
583
+ }
584
+ export declare const Type: {
585
+ readonly ALL: "ALL";
586
+ readonly ANY: "ANY";
587
+ readonly NONE: "NONE";
588
+ };
589
+ export type Type = (typeof Type)[keyof typeof Type];
590
+ export interface FilterGroup {
591
+ Type: Type | undefined;
592
+ Dimensions: FilterDimension[] | undefined;
593
+ }
594
+ export declare const Include: {
595
+ readonly ALL: "ALL";
596
+ readonly ANY: "ANY";
597
+ readonly NONE: "NONE";
598
+ };
599
+ export type Include = (typeof Include)[keyof typeof Include];
600
+ export interface Filter {
601
+ Include: Include | undefined;
602
+ Groups: FilterGroup[] | undefined;
603
+ }
415
604
  export declare const Statistic: {
416
605
  readonly AVERAGE: "AVERAGE";
417
606
  readonly COUNT: "COUNT";
@@ -430,6 +619,7 @@ export interface CreateCalculatedAttributeDefinitionRequest {
430
619
  Description?: string | undefined;
431
620
  AttributeDetails: AttributeDetails | undefined;
432
621
  Conditions?: Conditions | undefined;
622
+ Filter?: Filter | undefined;
433
623
  Statistic: Statistic | undefined;
434
624
  Tags?: Record<string, string> | undefined;
435
625
  }
@@ -439,6 +629,7 @@ export interface CreateCalculatedAttributeDefinitionResponse {
439
629
  Description?: string | undefined;
440
630
  AttributeDetails?: AttributeDetails | undefined;
441
631
  Conditions?: Conditions | undefined;
632
+ Filter?: Filter | undefined;
442
633
  Statistic?: Statistic | undefined;
443
634
  CreatedAt?: Date | undefined;
444
635
  LastUpdatedAt?: Date | undefined;
@@ -556,18 +747,6 @@ export interface CreateIntegrationWorkflowResponse {
556
747
  WorkflowId: string | undefined;
557
748
  Message: string | undefined;
558
749
  }
559
- export declare const Gender: {
560
- readonly FEMALE: "FEMALE";
561
- readonly MALE: "MALE";
562
- readonly UNSPECIFIED: "UNSPECIFIED";
563
- };
564
- export type Gender = (typeof Gender)[keyof typeof Gender];
565
- export declare const PartyType: {
566
- readonly BUSINESS: "BUSINESS";
567
- readonly INDIVIDUAL: "INDIVIDUAL";
568
- readonly OTHER: "OTHER";
569
- };
570
- export type PartyType = (typeof PartyType)[keyof typeof PartyType];
571
750
  export interface CreateProfileRequest {
572
751
  DomainName: string | undefined;
573
752
  AccountNumber?: string | undefined;
@@ -597,6 +776,141 @@ export interface CreateProfileRequest {
597
776
  export interface CreateProfileResponse {
598
777
  ProfileId: string | undefined;
599
778
  }
779
+ export interface ExtraLengthValueProfileDimension {
780
+ DimensionType: StringDimensionType | undefined;
781
+ Values: string[] | undefined;
782
+ }
783
+ export declare const DateDimensionType: {
784
+ readonly AFTER: "AFTER";
785
+ readonly BEFORE: "BEFORE";
786
+ readonly BETWEEN: "BETWEEN";
787
+ readonly NOT_BETWEEN: "NOT_BETWEEN";
788
+ readonly ON: "ON";
789
+ };
790
+ export type DateDimensionType =
791
+ (typeof DateDimensionType)[keyof typeof DateDimensionType];
792
+ export interface DateDimension {
793
+ DimensionType: DateDimensionType | undefined;
794
+ Values: string[] | undefined;
795
+ }
796
+ export interface ProfileAttributes {
797
+ AccountNumber?: ProfileDimension | undefined;
798
+ AdditionalInformation?: ExtraLengthValueProfileDimension | undefined;
799
+ FirstName?: ProfileDimension | undefined;
800
+ LastName?: ProfileDimension | undefined;
801
+ MiddleName?: ProfileDimension | undefined;
802
+ GenderString?: ProfileDimension | undefined;
803
+ PartyTypeString?: ProfileDimension | undefined;
804
+ BirthDate?: DateDimension | undefined;
805
+ PhoneNumber?: ProfileDimension | undefined;
806
+ BusinessName?: ProfileDimension | undefined;
807
+ BusinessPhoneNumber?: ProfileDimension | undefined;
808
+ HomePhoneNumber?: ProfileDimension | undefined;
809
+ MobilePhoneNumber?: ProfileDimension | undefined;
810
+ EmailAddress?: ProfileDimension | undefined;
811
+ PersonalEmailAddress?: ProfileDimension | undefined;
812
+ BusinessEmailAddress?: ProfileDimension | undefined;
813
+ Address?: AddressDimension | undefined;
814
+ ShippingAddress?: AddressDimension | undefined;
815
+ MailingAddress?: AddressDimension | undefined;
816
+ BillingAddress?: AddressDimension | undefined;
817
+ Attributes?: Record<string, AttributeDimension> | undefined;
818
+ }
819
+ export type Dimension =
820
+ | Dimension.CalculatedAttributesMember
821
+ | Dimension.ProfileAttributesMember
822
+ | Dimension.$UnknownMember;
823
+ export declare namespace Dimension {
824
+ interface ProfileAttributesMember {
825
+ ProfileAttributes: ProfileAttributes;
826
+ CalculatedAttributes?: never;
827
+ $unknown?: never;
828
+ }
829
+ interface CalculatedAttributesMember {
830
+ ProfileAttributes?: never;
831
+ CalculatedAttributes: Record<string, CalculatedAttributeDimension>;
832
+ $unknown?: never;
833
+ }
834
+ interface $UnknownMember {
835
+ ProfileAttributes?: never;
836
+ CalculatedAttributes?: never;
837
+ $unknown: [string, any];
838
+ }
839
+ interface Visitor<T> {
840
+ ProfileAttributes: (value: ProfileAttributes) => T;
841
+ CalculatedAttributes: (
842
+ value: Record<string, CalculatedAttributeDimension>
843
+ ) => T;
844
+ _: (name: string, value: any) => T;
845
+ }
846
+ const visit: <T>(value: Dimension, visitor: Visitor<T>) => T;
847
+ }
848
+ export interface SourceSegment {
849
+ SegmentDefinitionName?: string | undefined;
850
+ }
851
+ export declare const IncludeOptions: {
852
+ readonly ALL: "ALL";
853
+ readonly ANY: "ANY";
854
+ readonly NONE: "NONE";
855
+ };
856
+ export type IncludeOptions =
857
+ (typeof IncludeOptions)[keyof typeof IncludeOptions];
858
+ export interface Group {
859
+ Dimensions?: Dimension[] | undefined;
860
+ SourceSegments?: SourceSegment[] | undefined;
861
+ SourceType?: IncludeOptions | undefined;
862
+ Type?: IncludeOptions | undefined;
863
+ }
864
+ export interface SegmentGroup {
865
+ Groups?: Group[] | undefined;
866
+ Include?: IncludeOptions | undefined;
867
+ }
868
+ export interface CreateSegmentDefinitionRequest {
869
+ DomainName: string | undefined;
870
+ SegmentDefinitionName: string | undefined;
871
+ DisplayName: string | undefined;
872
+ Description?: string | undefined;
873
+ SegmentGroups: SegmentGroup | undefined;
874
+ Tags?: Record<string, string> | undefined;
875
+ }
876
+ export interface CreateSegmentDefinitionResponse {
877
+ SegmentDefinitionName: string | undefined;
878
+ DisplayName?: string | undefined;
879
+ Description?: string | undefined;
880
+ CreatedAt?: Date | undefined;
881
+ SegmentDefinitionArn?: string | undefined;
882
+ Tags?: Record<string, string> | undefined;
883
+ }
884
+ export interface SegmentGroupStructure {
885
+ Groups?: Group[] | undefined;
886
+ Include?: IncludeOptions | undefined;
887
+ }
888
+ export interface CreateSegmentEstimateRequest {
889
+ DomainName: string | undefined;
890
+ SegmentQuery: SegmentGroupStructure | undefined;
891
+ }
892
+ export interface CreateSegmentEstimateResponse {
893
+ DomainName?: string | undefined;
894
+ EstimateId?: string | undefined;
895
+ StatusCode?: number | undefined;
896
+ }
897
+ export declare const DataFormat: {
898
+ readonly CSV: "CSV";
899
+ readonly JSONL: "JSONL";
900
+ readonly ORC: "ORC";
901
+ };
902
+ export type DataFormat = (typeof DataFormat)[keyof typeof DataFormat];
903
+ export interface CreateSegmentSnapshotRequest {
904
+ DomainName: string | undefined;
905
+ SegmentDefinitionName: string | undefined;
906
+ DataFormat: DataFormat | undefined;
907
+ EncryptionKey?: string | undefined;
908
+ RoleArn?: string | undefined;
909
+ DestinationUri?: string | undefined;
910
+ }
911
+ export interface CreateSegmentSnapshotResponse {
912
+ SnapshotId: string | undefined;
913
+ }
600
914
  export interface DeleteCalculatedAttributeDefinitionRequest {
601
915
  DomainName: string | undefined;
602
916
  CalculatedAttributeName: string | undefined;
@@ -652,6 +966,13 @@ export interface DeleteProfileObjectTypeRequest {
652
966
  export interface DeleteProfileObjectTypeResponse {
653
967
  Message: string | undefined;
654
968
  }
969
+ export interface DeleteSegmentDefinitionRequest {
970
+ DomainName: string | undefined;
971
+ SegmentDefinitionName: string | undefined;
972
+ }
973
+ export interface DeleteSegmentDefinitionResponse {
974
+ Message?: string | undefined;
975
+ }
655
976
  export interface DeleteWorkflowRequest {
656
977
  DomainName: string | undefined;
657
978
  WorkflowId: string | undefined;
@@ -678,6 +999,7 @@ export interface ObjectTypeField {
678
999
  export declare const StandardIdentifier: {
679
1000
  readonly ASSET: "ASSET";
680
1001
  readonly CASE: "CASE";
1002
+ readonly COMMUNICATION_RECORD: "COMMUNICATION_RECORD";
681
1003
  readonly LOOKUP_ONLY: "LOOKUP_ONLY";
682
1004
  readonly NEW_ONLY: "NEW_ONLY";
683
1005
  readonly ORDER: "ORDER";
@@ -722,6 +1044,7 @@ export interface GetCalculatedAttributeDefinitionResponse {
722
1044
  CreatedAt?: Date | undefined;
723
1045
  LastUpdatedAt?: Date | undefined;
724
1046
  Statistic?: Statistic | undefined;
1047
+ Filter?: Filter | undefined;
725
1048
  Conditions?: Conditions | undefined;
726
1049
  AttributeDetails?: AttributeDetails | undefined;
727
1050
  Tags?: Record<string, string> | undefined;
@@ -893,6 +1216,84 @@ export interface GetProfileObjectTypeTemplateResponse {
893
1216
  Fields?: Record<string, ObjectTypeField> | undefined;
894
1217
  Keys?: Record<string, ObjectTypeKey[]> | undefined;
895
1218
  }
1219
+ export interface GetSegmentDefinitionRequest {
1220
+ DomainName: string | undefined;
1221
+ SegmentDefinitionName: string | undefined;
1222
+ }
1223
+ export interface GetSegmentDefinitionResponse {
1224
+ SegmentDefinitionName?: string | undefined;
1225
+ DisplayName?: string | undefined;
1226
+ Description?: string | undefined;
1227
+ SegmentGroups?: SegmentGroup | undefined;
1228
+ SegmentDefinitionArn: string | undefined;
1229
+ CreatedAt?: Date | undefined;
1230
+ Tags?: Record<string, string> | undefined;
1231
+ }
1232
+ export interface GetSegmentEstimateRequest {
1233
+ DomainName: string | undefined;
1234
+ EstimateId: string | undefined;
1235
+ }
1236
+ export declare const EstimateStatus: {
1237
+ readonly FAILED: "FAILED";
1238
+ readonly RUNNING: "RUNNING";
1239
+ readonly SUCCEEDED: "SUCCEEDED";
1240
+ };
1241
+ export type EstimateStatus =
1242
+ (typeof EstimateStatus)[keyof typeof EstimateStatus];
1243
+ export interface GetSegmentEstimateResponse {
1244
+ DomainName?: string | undefined;
1245
+ EstimateId?: string | undefined;
1246
+ Status?: EstimateStatus | undefined;
1247
+ Estimate?: string | undefined;
1248
+ Message?: string | undefined;
1249
+ StatusCode?: number | undefined;
1250
+ }
1251
+ export interface GetSegmentMembershipRequest {
1252
+ DomainName: string | undefined;
1253
+ SegmentDefinitionName: string | undefined;
1254
+ ProfileIds: string[] | undefined;
1255
+ }
1256
+ export interface ProfileQueryFailures {
1257
+ ProfileId: string | undefined;
1258
+ Message: string | undefined;
1259
+ Status?: number | undefined;
1260
+ }
1261
+ export declare const QueryResult: {
1262
+ readonly ABSENT: "ABSENT";
1263
+ readonly PRESENT: "PRESENT";
1264
+ };
1265
+ export type QueryResult = (typeof QueryResult)[keyof typeof QueryResult];
1266
+ export interface ProfileQueryResult {
1267
+ ProfileId: string | undefined;
1268
+ QueryResult: QueryResult | undefined;
1269
+ Profile?: Profile | undefined;
1270
+ }
1271
+ export interface GetSegmentMembershipResponse {
1272
+ SegmentDefinitionName?: string | undefined;
1273
+ Profiles?: ProfileQueryResult[] | undefined;
1274
+ Failures?: ProfileQueryFailures[] | undefined;
1275
+ }
1276
+ export interface GetSegmentSnapshotRequest {
1277
+ DomainName: string | undefined;
1278
+ SegmentDefinitionName: string | undefined;
1279
+ SnapshotId: string | undefined;
1280
+ }
1281
+ export declare const SegmentSnapshotStatus: {
1282
+ readonly COMPLETED: "COMPLETED";
1283
+ readonly FAILED: "FAILED";
1284
+ readonly IN_PROGRESS: "IN_PROGRESS";
1285
+ };
1286
+ export type SegmentSnapshotStatus =
1287
+ (typeof SegmentSnapshotStatus)[keyof typeof SegmentSnapshotStatus];
1288
+ export interface GetSegmentSnapshotResponse {
1289
+ SnapshotId: string | undefined;
1290
+ Status: SegmentSnapshotStatus | undefined;
1291
+ StatusMessage?: string | undefined;
1292
+ DataFormat: DataFormat | undefined;
1293
+ EncryptionKey?: string | undefined;
1294
+ RoleArn?: string | undefined;
1295
+ DestinationUri?: string | undefined;
1296
+ }
896
1297
  export declare const MatchType: {
897
1298
  readonly ML_BASED_MATCHING: "ML_BASED_MATCHING";
898
1299
  readonly RULE_BASED_MATCHING: "RULE_BASED_MATCHING";
@@ -1056,6 +1457,30 @@ export interface ListIntegrationsResponse {
1056
1457
  Items?: ListIntegrationItem[] | undefined;
1057
1458
  NextToken?: string | undefined;
1058
1459
  }
1460
+ export interface ListObjectTypeAttributesRequest {
1461
+ NextToken?: string | undefined;
1462
+ MaxResults?: number | undefined;
1463
+ DomainName: string | undefined;
1464
+ ObjectTypeName: string | undefined;
1465
+ }
1466
+ export interface ListObjectTypeAttributeItem {
1467
+ AttributeName: string | undefined;
1468
+ LastUpdatedAt: Date | undefined;
1469
+ }
1470
+ export interface ListObjectTypeAttributesResponse {
1471
+ Items?: ListObjectTypeAttributeItem[] | undefined;
1472
+ NextToken?: string | undefined;
1473
+ }
1474
+ export interface ProfileAttributeValuesRequest {
1475
+ DomainName: string | undefined;
1476
+ AttributeName: string | undefined;
1477
+ }
1478
+ export interface ProfileAttributeValuesResponse {
1479
+ DomainName?: string | undefined;
1480
+ AttributeName?: string | undefined;
1481
+ Items?: AttributeValueItem[] | undefined;
1482
+ StatusCode?: number | undefined;
1483
+ }
1059
1484
  export interface ObjectFilter {
1060
1485
  KeyName: string | undefined;
1061
1486
  Values: string[] | undefined;
@@ -1117,6 +1542,23 @@ export interface ListRuleBasedMatchesResponse {
1117
1542
  MatchIds?: string[] | undefined;
1118
1543
  NextToken?: string | undefined;
1119
1544
  }
1545
+ export interface ListSegmentDefinitionsRequest {
1546
+ DomainName: string | undefined;
1547
+ MaxResults?: number | undefined;
1548
+ NextToken?: string | undefined;
1549
+ }
1550
+ export interface SegmentDefinitionItem {
1551
+ SegmentDefinitionName?: string | undefined;
1552
+ DisplayName?: string | undefined;
1553
+ Description?: string | undefined;
1554
+ SegmentDefinitionArn?: string | undefined;
1555
+ CreatedAt?: Date | undefined;
1556
+ Tags?: Record<string, string> | undefined;
1557
+ }
1558
+ export interface ListSegmentDefinitionsResponse {
1559
+ NextToken?: string | undefined;
1560
+ Items?: SegmentDefinitionItem[] | undefined;
1561
+ }
1120
1562
  export interface ListTagsForResourceRequest {
1121
1563
  resourceArn: string | undefined;
1122
1564
  }
@@ -1250,37 +1692,6 @@ export interface SearchProfilesRequest {
1250
1692
  AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
1251
1693
  LogicalOperator?: LogicalOperator | undefined;
1252
1694
  }
1253
- export interface FoundByKeyValue {
1254
- KeyName?: string | undefined;
1255
- Values?: string[] | undefined;
1256
- }
1257
- export interface Profile {
1258
- ProfileId?: string | undefined;
1259
- AccountNumber?: string | undefined;
1260
- AdditionalInformation?: string | undefined;
1261
- PartyType?: PartyType | undefined;
1262
- BusinessName?: string | undefined;
1263
- FirstName?: string | undefined;
1264
- MiddleName?: string | undefined;
1265
- LastName?: string | undefined;
1266
- BirthDate?: string | undefined;
1267
- Gender?: Gender | undefined;
1268
- PhoneNumber?: string | undefined;
1269
- MobilePhoneNumber?: string | undefined;
1270
- HomePhoneNumber?: string | undefined;
1271
- BusinessPhoneNumber?: string | undefined;
1272
- EmailAddress?: string | undefined;
1273
- PersonalEmailAddress?: string | undefined;
1274
- BusinessEmailAddress?: string | undefined;
1275
- Address?: Address | undefined;
1276
- ShippingAddress?: Address | undefined;
1277
- MailingAddress?: Address | undefined;
1278
- BillingAddress?: Address | undefined;
1279
- Attributes?: Record<string, string> | undefined;
1280
- FoundByItems?: FoundByKeyValue[] | undefined;
1281
- PartyTypeString?: string | undefined;
1282
- GenderString?: string | undefined;
1283
- }
1284
1695
  export interface SearchProfilesResponse {
1285
1696
  Items?: Profile[] | undefined;
1286
1697
  NextToken?: string | undefined;
@@ -1385,9 +1796,25 @@ export declare const AppflowIntegrationFilterSensitiveLog: (
1385
1796
  export declare const AttributeDetailsFilterSensitiveLog: (
1386
1797
  obj: AttributeDetails
1387
1798
  ) => any;
1799
+ export declare const ConditionOverridesFilterSensitiveLog: (
1800
+ obj: ConditionOverrides
1801
+ ) => any;
1802
+ export declare const BatchGetCalculatedAttributeForProfileRequestFilterSensitiveLog: (
1803
+ obj: BatchGetCalculatedAttributeForProfileRequest
1804
+ ) => any;
1805
+ export declare const BatchGetCalculatedAttributeForProfileResponseFilterSensitiveLog: (
1806
+ obj: BatchGetCalculatedAttributeForProfileResponse
1807
+ ) => any;
1808
+ export declare const ProfileFilterSensitiveLog: (obj: Profile) => any;
1809
+ export declare const BatchGetProfileResponseFilterSensitiveLog: (
1810
+ obj: BatchGetProfileResponse
1811
+ ) => any;
1388
1812
  export declare const ListCalculatedAttributeDefinitionItemFilterSensitiveLog: (
1389
1813
  obj: ListCalculatedAttributeDefinitionItem
1390
1814
  ) => any;
1815
+ export declare const CalculatedAttributeDimensionFilterSensitiveLog: (
1816
+ obj: CalculatedAttributeDimension
1817
+ ) => any;
1391
1818
  export declare const ConditionsFilterSensitiveLog: (obj: Conditions) => any;
1392
1819
  export declare const CreateCalculatedAttributeDefinitionRequestFilterSensitiveLog: (
1393
1820
  obj: CreateCalculatedAttributeDefinitionRequest
@@ -1404,6 +1831,24 @@ export declare const CreateIntegrationWorkflowRequestFilterSensitiveLog: (
1404
1831
  export declare const CreateProfileRequestFilterSensitiveLog: (
1405
1832
  obj: CreateProfileRequest
1406
1833
  ) => any;
1834
+ export declare const ProfileAttributesFilterSensitiveLog: (
1835
+ obj: ProfileAttributes
1836
+ ) => any;
1837
+ export declare const DimensionFilterSensitiveLog: (obj: Dimension) => any;
1838
+ export declare const GroupFilterSensitiveLog: (obj: Group) => any;
1839
+ export declare const SegmentGroupFilterSensitiveLog: (obj: SegmentGroup) => any;
1840
+ export declare const CreateSegmentDefinitionRequestFilterSensitiveLog: (
1841
+ obj: CreateSegmentDefinitionRequest
1842
+ ) => any;
1843
+ export declare const CreateSegmentDefinitionResponseFilterSensitiveLog: (
1844
+ obj: CreateSegmentDefinitionResponse
1845
+ ) => any;
1846
+ export declare const SegmentGroupStructureFilterSensitiveLog: (
1847
+ obj: SegmentGroupStructure
1848
+ ) => any;
1849
+ export declare const CreateSegmentEstimateRequestFilterSensitiveLog: (
1850
+ obj: CreateSegmentEstimateRequest
1851
+ ) => any;
1407
1852
  export declare const DetectProfileObjectTypeRequestFilterSensitiveLog: (
1408
1853
  obj: DetectProfileObjectTypeRequest
1409
1854
  ) => any;
@@ -1422,6 +1867,15 @@ export declare const GetProfileObjectTypeResponseFilterSensitiveLog: (
1422
1867
  export declare const GetProfileObjectTypeTemplateResponseFilterSensitiveLog: (
1423
1868
  obj: GetProfileObjectTypeTemplateResponse
1424
1869
  ) => any;
1870
+ export declare const GetSegmentDefinitionResponseFilterSensitiveLog: (
1871
+ obj: GetSegmentDefinitionResponse
1872
+ ) => any;
1873
+ export declare const ProfileQueryResultFilterSensitiveLog: (
1874
+ obj: ProfileQueryResult
1875
+ ) => any;
1876
+ export declare const GetSegmentMembershipResponseFilterSensitiveLog: (
1877
+ obj: GetSegmentMembershipResponse
1878
+ ) => any;
1425
1879
  export declare const ListCalculatedAttributeDefinitionsResponseFilterSensitiveLog: (
1426
1880
  obj: ListCalculatedAttributeDefinitionsResponse
1427
1881
  ) => any;
@@ -1434,6 +1888,12 @@ export declare const ListProfileObjectsResponseFilterSensitiveLog: (
1434
1888
  export declare const ListProfileObjectTypesResponseFilterSensitiveLog: (
1435
1889
  obj: ListProfileObjectTypesResponse
1436
1890
  ) => any;
1891
+ export declare const SegmentDefinitionItemFilterSensitiveLog: (
1892
+ obj: SegmentDefinitionItem
1893
+ ) => any;
1894
+ export declare const ListSegmentDefinitionsResponseFilterSensitiveLog: (
1895
+ obj: ListSegmentDefinitionsResponse
1896
+ ) => any;
1437
1897
  export declare const PutIntegrationRequestFilterSensitiveLog: (
1438
1898
  obj: PutIntegrationRequest
1439
1899
  ) => any;
@@ -1446,7 +1906,6 @@ export declare const PutProfileObjectTypeRequestFilterSensitiveLog: (
1446
1906
  export declare const PutProfileObjectTypeResponseFilterSensitiveLog: (
1447
1907
  obj: PutProfileObjectTypeResponse
1448
1908
  ) => any;
1449
- export declare const ProfileFilterSensitiveLog: (obj: Profile) => any;
1450
1909
  export declare const SearchProfilesResponseFilterSensitiveLog: (
1451
1910
  obj: SearchProfilesResponse
1452
1911
  ) => any;
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ GetSimilarProfilesCommandInput,
4
+ GetSimilarProfilesCommandOutput,
5
+ } from "../commands/GetSimilarProfilesCommand";
6
+ import { CustomerProfilesPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateGetSimilarProfiles: (
8
+ config: CustomerProfilesPaginationConfiguration,
9
+ input: GetSimilarProfilesCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<GetSimilarProfilesCommandOutput>;