@aws-sdk/client-customer-profiles 3.1005.0 → 3.1007.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 +28 -0
- package/dist-cjs/index.js +69 -0
- package/dist-cjs/schemas/schemas_0.js +144 -14
- package/dist-es/CustomerProfiles.js +10 -0
- package/dist-es/commands/CreateRecommenderFilterCommand.js +16 -0
- package/dist-es/commands/DeleteRecommenderFilterCommand.js +16 -0
- package/dist-es/commands/GetRecommenderFilterCommand.js +16 -0
- package/dist-es/commands/ListRecommenderFiltersCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +8 -0
- package/dist-es/pagination/ListRecommenderFiltersPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +136 -6
- package/dist-types/CustomerProfiles.d.ts +35 -0
- package/dist-types/CustomerProfilesClient.d.ts +6 -2
- package/dist-types/commands/CreateRecommenderCommand.d.ts +5 -1
- package/dist-types/commands/CreateRecommenderFilterCommand.d.ts +98 -0
- package/dist-types/commands/DeleteRecommenderFilterCommand.d.ts +90 -0
- package/dist-types/commands/GetProfileRecommendationsCommand.d.ts +26 -0
- package/dist-types/commands/GetRecommenderCommand.d.ts +9 -1
- package/dist-types/commands/GetRecommenderFilterCommand.d.ts +98 -0
- package/dist-types/commands/ListRecommenderFiltersCommand.d.ts +104 -0
- package/dist-types/commands/ListRecommenderRecipesCommand.d.ts +1 -1
- package/dist-types/commands/ListRecommendersCommand.d.ts +9 -1
- package/dist-types/commands/PutIntegrationCommand.d.ts +1 -1
- package/dist-types/commands/PutProfileObjectCommand.d.ts +1 -1
- package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/commands/SearchProfilesCommand.d.ts +1 -1
- package/dist-types/commands/StartRecommenderCommand.d.ts +1 -1
- package/dist-types/commands/StartUploadJobCommand.d.ts +1 -1
- package/dist-types/commands/StopRecommenderCommand.d.ts +1 -2
- package/dist-types/commands/UpdateRecommenderCommand.d.ts +4 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +16 -0
- package/dist-types/models/models_0.d.ts +297 -465
- package/dist-types/models/models_1.d.ts +465 -2
- package/dist-types/pagination/ListRecommenderFiltersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +17 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +75 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateRecommenderFilterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRecommenderFilterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommenderFilterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommenderFiltersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutIntegrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutProfileObjectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutProfileObjectTypeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartRecommenderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartUploadJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopRecommenderCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +73 -94
- package/dist-types/ts3.4/models/models_1.d.ts +99 -0
- package/dist-types/ts3.4/pagination/ListRecommenderFiltersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +17 -0
- package/package.json +1 -1
|
@@ -1,5 +1,468 @@
|
|
|
1
|
-
import { Gender, LayoutType, PartyType, ProfileType, ReadinessStatus, Statistic } from "./enums";
|
|
2
|
-
import { type AttributeDetails, type Conditions, type DataStoreRequest, type DataStoreResponse, type EngagementPreferences, type EventTriggerLimits, type MatchingRequest, type MatchingResponse, type Readiness, type RecommenderConfig, type RuleBasedMatchingRequest, type RuleBasedMatchingResponse, EventTriggerCondition } from "./models_0";
|
|
1
|
+
import { Gender, LayoutType, LogicalOperator, PartyType, ProfileType, ReadinessStatus, Scope, Statistic } from "./enums";
|
|
2
|
+
import { type AttributeDetails, type Conditions, type DataStoreRequest, type DataStoreResponse, type EngagementPreferences, type EventTriggerLimits, type FlowDefinition, type MatchingRequest, type MatchingResponse, type Readiness, type RecommenderConfig, type RuleBasedMatchingRequest, type RuleBasedMatchingResponse, AdditionalSearchKey, EventTriggerCondition, ObjectTypeField, ObjectTypeKey, Profile } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface PutIntegrationRequest {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The unique name of the domain.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
DomainName: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
Uri?: string | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* <p>The name of the profile object type.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
ObjectTypeName?: string | undefined;
|
|
22
|
+
/**
|
|
23
|
+
* <p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.
|
|
24
|
+
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
25
|
+
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
ObjectTypeNames?: Record<string, string> | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
Tags?: Record<string, string> | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* <p>The configuration that controls how Customer Profiles retrieves data from the
|
|
36
|
+
* source.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
FlowDefinition?: FlowDefinition | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make
|
|
42
|
+
* Customer Profiles requests on your behalf.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
RoleArn?: string | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <p>A list of unique names for active event triggers associated with the integration.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
EventTriggerNames?: string[] | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
Scope?: Scope | undefined;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
export interface PutIntegrationResponse {
|
|
61
|
+
/**
|
|
62
|
+
* <p>The unique name of the domain.</p>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
DomainName: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
Uri: string | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>The name of the profile object type.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
ObjectTypeName?: string | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The timestamp of when the domain was created.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
CreatedAt: Date | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
LastUpdatedAt: Date | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
Tags?: Record<string, string> | undefined;
|
|
91
|
+
/**
|
|
92
|
+
* <p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.
|
|
93
|
+
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
94
|
+
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
ObjectTypeNames?: Record<string, string> | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>Unique identifier for the workflow.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
WorkflowId?: string | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
105
|
+
* Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
106
|
+
* flowDefinition.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
IsUnstructured?: boolean | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make
|
|
112
|
+
* Customer Profiles requests on your behalf.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
RoleArn?: string | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>A list of unique names for active event triggers associated with the integration. This
|
|
118
|
+
* list would be empty if no Event Trigger is associated with the integration.</p>
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
EventTriggerNames?: string[] | undefined;
|
|
122
|
+
/**
|
|
123
|
+
* <p>Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.</p>
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
Scope?: Scope | undefined;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
131
|
+
export interface PutProfileObjectRequest {
|
|
132
|
+
/**
|
|
133
|
+
* <p>The name of the profile object type.</p>
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
ObjectTypeName: string | undefined;
|
|
137
|
+
/**
|
|
138
|
+
* <p>A string that is serialized from a JSON object.</p>
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
Object: string | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* <p>The unique name of the domain.</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
DomainName: string | undefined;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
export interface PutProfileObjectResponse {
|
|
152
|
+
/**
|
|
153
|
+
* <p>The unique identifier of the profile object generated by the service.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
ProfileObjectUniqueKey?: string | undefined;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export interface PutProfileObjectTypeRequest {
|
|
162
|
+
/**
|
|
163
|
+
* <p>The unique name of the domain.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
DomainName: string | undefined;
|
|
167
|
+
/**
|
|
168
|
+
* <p>The name of the profile object type.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
ObjectTypeName: string | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* <p>Description of the profile object type.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
Description: string | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>A unique identifier for the object template. For some attributes in the request, the
|
|
179
|
+
* service will use the default value from the object template when TemplateId is present. If
|
|
180
|
+
* these attributes are present in the request, the service may return a
|
|
181
|
+
* <code>BadRequestException</code>. These attributes include: AllowProfileCreation,
|
|
182
|
+
* SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is
|
|
183
|
+
* set to true when TemplateId is set, the service may return a
|
|
184
|
+
* <code>BadRequestException</code>.</p>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
TemplateId?: string | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* <p>The number of days until the data in the object expires.</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
ExpirationDays?: number | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
195
|
+
* profile object type.</p>
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
EncryptionKey?: string | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
201
|
+
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
202
|
+
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
203
|
+
* associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
|
|
204
|
+
* is found, then the service creates a new standard profile.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
AllowProfileCreation?: boolean | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.
|
|
210
|
+
* </p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The amount of profile object max count assigned to the object type</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
MaxProfileObjectCount?: number | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
SourcePriority?: number | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>A map of the name and ObjectType field.</p>
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
Tags?: Record<string, string> | undefined;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
export interface PutProfileObjectTypeResponse {
|
|
244
|
+
/**
|
|
245
|
+
* <p>The name of the profile object type.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
ObjectTypeName: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>Description of the profile object type.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
Description: string | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <p>A unique identifier for the object template.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
TemplateId?: string | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The number of days until the data in the object expires.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
ExpirationDays?: number | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The customer-provided key to encrypt the profile object that will be created in this
|
|
266
|
+
* profile object type.</p>
|
|
267
|
+
* @public
|
|
268
|
+
*/
|
|
269
|
+
EncryptionKey?: string | undefined;
|
|
270
|
+
/**
|
|
271
|
+
* <p>Indicates whether a profile should be created when data is received if one doesn’t exist
|
|
272
|
+
* for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
|
|
273
|
+
* flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
|
|
274
|
+
* associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
|
|
275
|
+
* is found, then the service creates a new standard profile.</p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
AllowProfileCreation?: boolean | undefined;
|
|
279
|
+
/**
|
|
280
|
+
* <p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in
|
|
281
|
+
* 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
|
|
282
|
+
* field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
SourceLastUpdatedTimestampFormat?: string | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The amount of profile object max count assigned to the object type.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
MaxProfileObjectCount?: number | undefined;
|
|
291
|
+
/**
|
|
292
|
+
* <p>The amount of provisioned profile object max count available.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
MaxAvailableProfileObjectCount?: number | undefined;
|
|
296
|
+
/**
|
|
297
|
+
* <p>An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
SourcePriority?: number | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>A map of the name and ObjectType field.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
Fields?: Record<string, ObjectTypeField> | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p>A list of unique keys that can be used to map data to the profile.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* <p>The timestamp of when the domain was created.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
CreatedAt?: Date | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
LastUpdatedAt?: Date | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
Tags?: Record<string, string> | undefined;
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
export interface SearchProfilesRequest {
|
|
331
|
+
/**
|
|
332
|
+
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
NextToken?: string | undefined;
|
|
336
|
+
/**
|
|
337
|
+
* <p>The maximum number of objects returned per page.</p>
|
|
338
|
+
* <p>The default is 20 if this parameter is not included in the request.</p>
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
MaxResults?: number | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The unique name of the domain.</p>
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
DomainName: string | undefined;
|
|
347
|
+
/**
|
|
348
|
+
* <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,
|
|
349
|
+
* _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
|
|
350
|
+
* _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId,
|
|
351
|
+
* _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
|
|
352
|
+
* _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
KeyName: string | undefined;
|
|
356
|
+
/**
|
|
357
|
+
* <p>A list of key values.</p>
|
|
358
|
+
* @public
|
|
359
|
+
*/
|
|
360
|
+
Values: string[] | undefined;
|
|
361
|
+
/**
|
|
362
|
+
* <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers
|
|
363
|
+
* of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code>
|
|
364
|
+
* and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s)
|
|
365
|
+
* pair). These additional search keys will be used in conjunction with the
|
|
366
|
+
* <code>LogicalOperator</code> and the required <code>KeyName</code> and
|
|
367
|
+
* <code>Values</code> parameters to search for profiles that satisfy the search criteria.
|
|
368
|
+
* </p>
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
AdditionalSearchKeys?: AdditionalSearchKey[] | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* <p>Relationship between all specified search keys that will be used to search for profiles.
|
|
374
|
+
* This includes the required <code>KeyName</code> and <code>Values</code> parameters as well
|
|
375
|
+
* as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
|
|
376
|
+
* <p>This parameter influences which profiles will be returned in the response in the
|
|
377
|
+
* following manner:</p>
|
|
378
|
+
* <ul>
|
|
379
|
+
* <li>
|
|
380
|
+
* <p>
|
|
381
|
+
* <code>AND</code> - The response only includes profiles that match all of the
|
|
382
|
+
* search keys.</p>
|
|
383
|
+
* </li>
|
|
384
|
+
* <li>
|
|
385
|
+
* <p>
|
|
386
|
+
* <code>OR</code> - The response includes profiles that match at least one of the
|
|
387
|
+
* search keys.</p>
|
|
388
|
+
* </li>
|
|
389
|
+
* </ul>
|
|
390
|
+
* <p>The <code>OR</code> relationship is the default behavior if this parameter is not
|
|
391
|
+
* included in the request.</p>
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
LogicalOperator?: LogicalOperator | undefined;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* @public
|
|
398
|
+
*/
|
|
399
|
+
export interface SearchProfilesResponse {
|
|
400
|
+
/**
|
|
401
|
+
* <p>The list of Profiles matching the search criteria.</p>
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
Items?: Profile[] | undefined;
|
|
405
|
+
/**
|
|
406
|
+
* <p>The pagination token from the previous SearchProfiles API call.</p>
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
NextToken?: string | undefined;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
export interface StartRecommenderRequest {
|
|
415
|
+
/**
|
|
416
|
+
* <p>The unique name of the domain.</p>
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
DomainName: string | undefined;
|
|
420
|
+
/**
|
|
421
|
+
* <p>The name of the recommender to start.</p>
|
|
422
|
+
* @public
|
|
423
|
+
*/
|
|
424
|
+
RecommenderName: string | undefined;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
export interface StartRecommenderResponse {
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* @public
|
|
433
|
+
*/
|
|
434
|
+
export interface StartUploadJobRequest {
|
|
435
|
+
/**
|
|
436
|
+
* <p>The unique name of the domain containing the upload job to start. </p>
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
DomainName: string | undefined;
|
|
440
|
+
/**
|
|
441
|
+
* <p>The unique identifier of the upload job to start. </p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
JobId: string | undefined;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
export interface StartUploadJobResponse {
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
export interface StopRecommenderRequest {
|
|
455
|
+
/**
|
|
456
|
+
* <p>The unique name of the domain.</p>
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
DomainName: string | undefined;
|
|
460
|
+
/**
|
|
461
|
+
* <p>The name of the recommender to stop.</p>
|
|
462
|
+
* @public
|
|
463
|
+
*/
|
|
464
|
+
RecommenderName: string | undefined;
|
|
465
|
+
}
|
|
3
466
|
/**
|
|
4
467
|
* @public
|
|
5
468
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListRecommenderFiltersCommandInput, ListRecommenderFiltersCommandOutput } from "../commands/ListRecommenderFiltersCommand";
|
|
3
|
+
import { CustomerProfilesPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListRecommenderFilters: (config: CustomerProfilesPaginationConfiguration, input: ListRecommenderFiltersCommandInput, ...rest: any[]) => Paginator<ListRecommenderFiltersCommandOutput>;
|
|
@@ -5,6 +5,7 @@ export * from "./ListDomainObjectTypesPaginator";
|
|
|
5
5
|
export * from "./ListEventStreamsPaginator";
|
|
6
6
|
export * from "./ListEventTriggersPaginator";
|
|
7
7
|
export * from "./ListObjectTypeAttributesPaginator";
|
|
8
|
+
export * from "./ListRecommenderFiltersPaginator";
|
|
8
9
|
export * from "./ListRecommenderRecipesPaginator";
|
|
9
10
|
export * from "./ListRecommendersPaginator";
|
|
10
11
|
export * from "./ListRuleBasedMatchesPaginator";
|
|
@@ -57,6 +57,8 @@ export declare var CreateIntegrationWorkflowRequest$: StaticStructureSchema;
|
|
|
57
57
|
export declare var CreateIntegrationWorkflowResponse$: StaticStructureSchema;
|
|
58
58
|
export declare var CreateProfileRequest$: StaticStructureSchema;
|
|
59
59
|
export declare var CreateProfileResponse$: StaticStructureSchema;
|
|
60
|
+
export declare var CreateRecommenderFilterRequest$: StaticStructureSchema;
|
|
61
|
+
export declare var CreateRecommenderFilterResponse$: StaticStructureSchema;
|
|
60
62
|
export declare var CreateRecommenderRequest$: StaticStructureSchema;
|
|
61
63
|
export declare var CreateRecommenderResponse$: StaticStructureSchema;
|
|
62
64
|
export declare var CreateSegmentDefinitionRequest$: StaticStructureSchema;
|
|
@@ -92,6 +94,8 @@ export declare var DeleteProfileObjectTypeRequest$: StaticStructureSchema;
|
|
|
92
94
|
export declare var DeleteProfileObjectTypeResponse$: StaticStructureSchema;
|
|
93
95
|
export declare var DeleteProfileRequest$: StaticStructureSchema;
|
|
94
96
|
export declare var DeleteProfileResponse$: StaticStructureSchema;
|
|
97
|
+
export declare var DeleteRecommenderFilterRequest$: StaticStructureSchema;
|
|
98
|
+
export declare var DeleteRecommenderFilterResponse$: StaticStructureSchema;
|
|
95
99
|
export declare var DeleteRecommenderRequest$: StaticStructureSchema;
|
|
96
100
|
export declare var DeleteRecommenderResponse$: StaticStructureSchema;
|
|
97
101
|
export declare var DeleteSegmentDefinitionRequest$: StaticStructureSchema;
|
|
@@ -158,6 +162,8 @@ export declare var GetProfileObjectTypeTemplateRequest$: StaticStructureSchema;
|
|
|
158
162
|
export declare var GetProfileObjectTypeTemplateResponse$: StaticStructureSchema;
|
|
159
163
|
export declare var GetProfileRecommendationsRequest$: StaticStructureSchema;
|
|
160
164
|
export declare var GetProfileRecommendationsResponse$: StaticStructureSchema;
|
|
165
|
+
export declare var GetRecommenderFilterRequest$: StaticStructureSchema;
|
|
166
|
+
export declare var GetRecommenderFilterResponse$: StaticStructureSchema;
|
|
161
167
|
export declare var GetRecommenderRequest$: StaticStructureSchema;
|
|
162
168
|
export declare var GetRecommenderResponse$: StaticStructureSchema;
|
|
163
169
|
export declare var GetSegmentDefinitionRequest$: StaticStructureSchema;
|
|
@@ -181,6 +187,7 @@ export declare var GetWorkflowStepsResponse$: StaticStructureSchema;
|
|
|
181
187
|
export declare var Group$: StaticStructureSchema;
|
|
182
188
|
export declare var IdentityResolutionJob$: StaticStructureSchema;
|
|
183
189
|
export declare var IncrementalPullConfig$: StaticStructureSchema;
|
|
190
|
+
export declare var InferenceConfig$: StaticStructureSchema;
|
|
184
191
|
export declare var IntegrationConfig$: StaticStructureSchema;
|
|
185
192
|
export declare var JobSchedule$: StaticStructureSchema;
|
|
186
193
|
export declare var JobStats$: StaticStructureSchema;
|
|
@@ -226,6 +233,8 @@ export declare var ListProfileObjectTypesResponse$: StaticStructureSchema;
|
|
|
226
233
|
export declare var ListProfileObjectTypeTemplateItem$: StaticStructureSchema;
|
|
227
234
|
export declare var ListProfileObjectTypeTemplatesRequest$: StaticStructureSchema;
|
|
228
235
|
export declare var ListProfileObjectTypeTemplatesResponse$: StaticStructureSchema;
|
|
236
|
+
export declare var ListRecommenderFiltersRequest$: StaticStructureSchema;
|
|
237
|
+
export declare var ListRecommenderFiltersResponse$: StaticStructureSchema;
|
|
229
238
|
export declare var ListRecommenderRecipesRequest$: StaticStructureSchema;
|
|
230
239
|
export declare var ListRecommenderRecipesResponse$: StaticStructureSchema;
|
|
231
240
|
export declare var ListRecommendersRequest$: StaticStructureSchema;
|
|
@@ -248,6 +257,7 @@ export declare var MatchingRule$: StaticStructureSchema;
|
|
|
248
257
|
export declare var MatchItem$: StaticStructureSchema;
|
|
249
258
|
export declare var MergeProfilesRequest$: StaticStructureSchema;
|
|
250
259
|
export declare var MergeProfilesResponse$: StaticStructureSchema;
|
|
260
|
+
export declare var MetadataConfig$: StaticStructureSchema;
|
|
251
261
|
export declare var ObjectAttribute$: StaticStructureSchema;
|
|
252
262
|
export declare var ObjectFilter$: StaticStructureSchema;
|
|
253
263
|
export declare var ObjectTypeField$: StaticStructureSchema;
|
|
@@ -275,6 +285,9 @@ export declare var RangeOverride$: StaticStructureSchema;
|
|
|
275
285
|
export declare var Readiness$: StaticStructureSchema;
|
|
276
286
|
export declare var Recommendation$: StaticStructureSchema;
|
|
277
287
|
export declare var RecommenderConfig$: StaticStructureSchema;
|
|
288
|
+
export declare var RecommenderFilter$: StaticStructureSchema;
|
|
289
|
+
export declare var RecommenderFilterSummary$: StaticStructureSchema;
|
|
290
|
+
export declare var RecommenderPromotionalFilter$: StaticStructureSchema;
|
|
278
291
|
export declare var RecommenderRecipe$: StaticStructureSchema;
|
|
279
292
|
export declare var RecommenderSummary$: StaticStructureSchema;
|
|
280
293
|
export declare var RecommenderUpdate$: StaticStructureSchema;
|
|
@@ -343,6 +356,7 @@ export declare var CreateEventTrigger$: StaticOperationSchema;
|
|
|
343
356
|
export declare var CreateIntegrationWorkflow$: StaticOperationSchema;
|
|
344
357
|
export declare var CreateProfile$: StaticOperationSchema;
|
|
345
358
|
export declare var CreateRecommender$: StaticOperationSchema;
|
|
359
|
+
export declare var CreateRecommenderFilter$: StaticOperationSchema;
|
|
346
360
|
export declare var CreateSegmentDefinition$: StaticOperationSchema;
|
|
347
361
|
export declare var CreateSegmentEstimate$: StaticOperationSchema;
|
|
348
362
|
export declare var CreateSegmentSnapshot$: StaticOperationSchema;
|
|
@@ -359,6 +373,7 @@ export declare var DeleteProfileKey$: StaticOperationSchema;
|
|
|
359
373
|
export declare var DeleteProfileObject$: StaticOperationSchema;
|
|
360
374
|
export declare var DeleteProfileObjectType$: StaticOperationSchema;
|
|
361
375
|
export declare var DeleteRecommender$: StaticOperationSchema;
|
|
376
|
+
export declare var DeleteRecommenderFilter$: StaticOperationSchema;
|
|
362
377
|
export declare var DeleteSegmentDefinition$: StaticOperationSchema;
|
|
363
378
|
export declare var DeleteWorkflow$: StaticOperationSchema;
|
|
364
379
|
export declare var DetectProfileObjectType$: StaticOperationSchema;
|
|
@@ -379,6 +394,7 @@ export declare var GetProfileObjectType$: StaticOperationSchema;
|
|
|
379
394
|
export declare var GetProfileObjectTypeTemplate$: StaticOperationSchema;
|
|
380
395
|
export declare var GetProfileRecommendations$: StaticOperationSchema;
|
|
381
396
|
export declare var GetRecommender$: StaticOperationSchema;
|
|
397
|
+
export declare var GetRecommenderFilter$: StaticOperationSchema;
|
|
382
398
|
export declare var GetSegmentDefinition$: StaticOperationSchema;
|
|
383
399
|
export declare var GetSegmentEstimate$: StaticOperationSchema;
|
|
384
400
|
export declare var GetSegmentMembership$: StaticOperationSchema;
|
|
@@ -405,6 +421,7 @@ export declare var ListProfileHistoryRecords$: StaticOperationSchema;
|
|
|
405
421
|
export declare var ListProfileObjects$: StaticOperationSchema;
|
|
406
422
|
export declare var ListProfileObjectTypes$: StaticOperationSchema;
|
|
407
423
|
export declare var ListProfileObjectTypeTemplates$: StaticOperationSchema;
|
|
424
|
+
export declare var ListRecommenderFilters$: StaticOperationSchema;
|
|
408
425
|
export declare var ListRecommenderRecipes$: StaticOperationSchema;
|
|
409
426
|
export declare var ListRecommenders$: StaticOperationSchema;
|
|
410
427
|
export declare var ListRuleBasedMatches$: StaticOperationSchema;
|