@salesforce/lds-adapters-cdp-personalization-service 0.1.0-dev1
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/LICENSE.txt +82 -0
- package/dist/es/es2018/cdp-personalization-service.js +6475 -0
- package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/adapters/createPersonalizationExperiencesConfig.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/adapters/createPersonalizationPoint.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/createPersonalizationSchema.d.ts +23 -0
- package/dist/es/es2018/types/src/generated/adapters/deletePersonalizationExperienceConfig.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/adapters/deletePersonalizationPoint.d.ts +14 -0
- package/dist/es/es2018/types/src/generated/adapters/deletePersonalizationSchema.d.ts +14 -0
- package/dist/es/es2018/types/src/generated/adapters/getPersonalizationEsModelMapping.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/adapters/getPersonalizationExperienceConfig.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/getPersonalizationExperiencesConfigs.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/getPersonalizationPoint.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getPersonalizationSchema.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getTrainingHistory.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/postPersonalizationRecommenderSimulateAction.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/adapters/updatePersonalizationExperienceConfig.d.ts +26 -0
- package/dist/es/es2018/types/src/generated/adapters/updatePersonalizationPoint.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/resources/deletePersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrNameAndNameParam.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/deletePersonalizationPersonalizationPointsByIdOrName.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/deletePersonalizationPersonalizationSchemasByIdOrName.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/getPersonalizationDataMlModels.d.ts +20 -0
- package/dist/es/es2018/types/src/generated/resources/getPersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrName.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/resources/getPersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrNameAndNameParam.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/resources/getPersonalizationPersonalizationPointsByIdOrName.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getPersonalizationPersonalizationRecommendersJobsByIdOrName.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/resources/getPersonalizationPersonalizationSchemasByIdOrName.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postPersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrName.d.ts +24 -0
- package/dist/es/es2018/types/src/generated/resources/postPersonalizationPersonalizationPoints.d.ts +26 -0
- package/dist/es/es2018/types/src/generated/resources/postPersonalizationPersonalizationRecommendersActionsSimulateByIdOrName.d.ts +24 -0
- package/dist/es/es2018/types/src/generated/resources/postPersonalizationPersonalizationSchemas.d.ts +20 -0
- package/dist/es/es2018/types/src/generated/resources/putPersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrNameAndNameParam.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/resources/putPersonalizationPersonalizationPointsByIdOrName.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ABnExperimentCohortInputRepresentation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/ABnExperimentInputRepresentation.d.ts +55 -0
- package/dist/es/es2018/types/src/generated/types/ABnExperimentRepresentation.d.ts +82 -0
- package/dist/es/es2018/types/src/generated/types/AbstractFieldPredicateInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/AbstractFieldRuleInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/AnchorReferenceRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/BasePredicateInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/BaseRuleInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CalculatedInsightPredicateInputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/CalculatedInsightRuleInputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/CriteriaRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/DateOnlyPredicateInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/FieldPredicateInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/FieldRuleInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/FilterRepresentation.d.ts +72 -0
- package/dist/es/es2018/types/src/generated/types/FiltersWrapRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/NumberPredicateInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationAttributeInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationAttributeRepresentation.d.ts +52 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationAttributeValueInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationAttributeValueRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationDataMlModelCollectionRepresentation.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationDataMlModelInputFeatureRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationDataMlModelRepresentation.d.ts +50 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationDecisionInputRepresentation.d.ts +47 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationDecisionRepresentation.d.ts +75 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationExperienceConfigCollectionInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationExperienceConfigCollectionRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationExperienceConfigInputRepresentation.d.ts +56 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationExperienceConfigRepresentation.d.ts +77 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationPaginatedResponseBaseRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationPointInputRepresentation.d.ts +68 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationPointRepresentation.d.ts +108 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationRecommenderJobCollectionRepresentation.d.ts +36 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationRecommenderJobRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationRecommenderSimulateActionInputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationRecommenderSimulateActionRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationSchemaInputRepresentation.d.ts +50 -0
- package/dist/es/es2018/types/src/generated/types/PersonalizationSchemaRepresentation.d.ts +78 -0
- package/dist/es/es2018/types/src/generated/types/RelatedFieldPredicateInputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/RelatedFieldRuleInputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/RuleGroupInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/RuleGroupInputRepresentation2.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SegmentMembershipPredicateInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/SortCriteriaInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/SubjectRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/TextPredicateInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
- package/dist/es/es2018/types/src/raml-artifacts/resources/deletePersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrNameAndNameParam/createResourceRequest.d.ts +3 -0
- package/dist/es/es2018/types/src/raml-artifacts/resources/getPersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrNameAndNameParam/createResourceRequest.d.ts +3 -0
- package/dist/es/es2018/types/src/raml-artifacts/resources/putPersonalizationExternalAppsPersonalizationExperienceConfigsByIdOrAppSourceIdOrNameAndNameParam/createResourceRequest.d.ts +3 -0
- package/package.json +79 -0
- package/sfdc/index.d.ts +1 -0
- package/sfdc/index.js +6699 -0
- package/src/raml/api.raml +1610 -0
- package/src/raml/luvio.raml +118 -0
|
@@ -0,0 +1,1610 @@
|
|
|
1
|
+
#%RAML 1.0
|
|
2
|
+
securedBy:
|
|
3
|
+
- OAuth2
|
|
4
|
+
title: Salesforce Connect API
|
|
5
|
+
version: '64.0'
|
|
6
|
+
mediaType: application/json
|
|
7
|
+
protocols:
|
|
8
|
+
- https
|
|
9
|
+
baseUri: /services/data/v66.0
|
|
10
|
+
securitySchemes:
|
|
11
|
+
OAuth2:
|
|
12
|
+
type: OAuth 2.0
|
|
13
|
+
settings:
|
|
14
|
+
authorizationUri: https://example.com/oauth/authorize
|
|
15
|
+
accessTokenUri: ''
|
|
16
|
+
authorizationGrants:
|
|
17
|
+
- implicit
|
|
18
|
+
annotationTypes:
|
|
19
|
+
oas-readOnly:
|
|
20
|
+
type: boolean
|
|
21
|
+
allowedTargets: TypeDeclaration
|
|
22
|
+
oas-collectionFormat:
|
|
23
|
+
type: string
|
|
24
|
+
oas-body-name:
|
|
25
|
+
type: string
|
|
26
|
+
allowedTargets: TypeDeclaration
|
|
27
|
+
types:
|
|
28
|
+
ABnExperimentCohortInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
29
|
+
description: ABn Experiment Cohort Input Representation
|
|
30
|
+
type: object
|
|
31
|
+
properties:
|
|
32
|
+
description:
|
|
33
|
+
description: Personalization Base description
|
|
34
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
35
|
+
label:
|
|
36
|
+
description: Personalization Base label
|
|
37
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
38
|
+
name:
|
|
39
|
+
description: Personalization Point API name
|
|
40
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
41
|
+
allocationWeight:
|
|
42
|
+
description: Number between 0 and 10000 (basis points) for traffic percent
|
|
43
|
+
allocation
|
|
44
|
+
type: integer
|
|
45
|
+
attributeValues:
|
|
46
|
+
description: Personalization Attribute Values associated with a Cohort
|
|
47
|
+
type: array
|
|
48
|
+
items:
|
|
49
|
+
type: object
|
|
50
|
+
isControl:
|
|
51
|
+
description: Whether or not this is the control Cohort
|
|
52
|
+
type: boolean
|
|
53
|
+
personalizerName:
|
|
54
|
+
description: The API name of the Personalizer associated with a Cohort
|
|
55
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
56
|
+
ABnExperimentInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
57
|
+
description: ABn Experiment Input Representation
|
|
58
|
+
type: object
|
|
59
|
+
properties:
|
|
60
|
+
description:
|
|
61
|
+
description: Personalization Base description
|
|
62
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
63
|
+
label:
|
|
64
|
+
description: Personalization Base label
|
|
65
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
66
|
+
name:
|
|
67
|
+
description: Personalization Point API name
|
|
68
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
69
|
+
cohorts:
|
|
70
|
+
description: List of Cohorts associated with the Experiment
|
|
71
|
+
type: array
|
|
72
|
+
items:
|
|
73
|
+
type: array
|
|
74
|
+
items:
|
|
75
|
+
type: object
|
|
76
|
+
dataSpaceName:
|
|
77
|
+
description: The API name of the Data Space associated with the Experiment
|
|
78
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
79
|
+
profileDataGraphName:
|
|
80
|
+
description: The API name of the Profile Data Graph associated with the Experiment
|
|
81
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
82
|
+
schemaEnum:
|
|
83
|
+
description: A schema enum associated with the Experiment if it has a standard
|
|
84
|
+
schema
|
|
85
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
86
|
+
enum:
|
|
87
|
+
- ExperienceVariation
|
|
88
|
+
- FlowPath
|
|
89
|
+
schemaName:
|
|
90
|
+
description: An API name of a Schema associated with the Experiment if it
|
|
91
|
+
has a custom schema
|
|
92
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
93
|
+
source:
|
|
94
|
+
description: Experiment source
|
|
95
|
+
type: string
|
|
96
|
+
enum:
|
|
97
|
+
- BlockBuilder
|
|
98
|
+
- ExperienceBuilder
|
|
99
|
+
- FlowBuilder
|
|
100
|
+
- PersonalizationApp
|
|
101
|
+
sourceRecordId:
|
|
102
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
103
|
+
description: A record which created this Personalization Point and which is responsible for maintaining it. What type of object this is depends on the Source.
|
|
104
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
105
|
+
ABnExperimentRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
106
|
+
description: ABn Experiment Output Representation
|
|
107
|
+
type: object
|
|
108
|
+
properties:
|
|
109
|
+
createdById:
|
|
110
|
+
description: Created by id
|
|
111
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
112
|
+
createdDate:
|
|
113
|
+
description: Created date
|
|
114
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
115
|
+
id:
|
|
116
|
+
description: The 18 character ID of the record
|
|
117
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
118
|
+
label:
|
|
119
|
+
description: Personalization base output label
|
|
120
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
121
|
+
lastModifiedById:
|
|
122
|
+
description: Last modified by id
|
|
123
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
124
|
+
lastModifiedDate:
|
|
125
|
+
description: Last modified date
|
|
126
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
127
|
+
name:
|
|
128
|
+
description: Personalization base output API name
|
|
129
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
130
|
+
url:
|
|
131
|
+
description: Url
|
|
132
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
133
|
+
dataSpaceName:
|
|
134
|
+
description: The API name of the Data Space associated with the Experiment
|
|
135
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
136
|
+
description:
|
|
137
|
+
description: Experiment description
|
|
138
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
139
|
+
profileDataGraphName:
|
|
140
|
+
description: The API name of the Profile Data Graph associated with the Experiment
|
|
141
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
142
|
+
schemaEnum:
|
|
143
|
+
description: A schema enum associated with the Experiment if it has a standard
|
|
144
|
+
schema
|
|
145
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
146
|
+
enum:
|
|
147
|
+
- ExperienceVariation
|
|
148
|
+
- FlowPath
|
|
149
|
+
schemaName:
|
|
150
|
+
description: An API name of a Schema associated with the Experiment if it
|
|
151
|
+
has a custom schema
|
|
152
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
153
|
+
source:
|
|
154
|
+
description: Where this experiment was created
|
|
155
|
+
type: string
|
|
156
|
+
enum:
|
|
157
|
+
- BlockBuilder
|
|
158
|
+
- ExperienceBuilder
|
|
159
|
+
- FlowBuilder
|
|
160
|
+
- PersonalizationApp
|
|
161
|
+
startedDate:
|
|
162
|
+
description: Started date
|
|
163
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
164
|
+
state:
|
|
165
|
+
description: Experiment state
|
|
166
|
+
type: string
|
|
167
|
+
enum:
|
|
168
|
+
- Archived
|
|
169
|
+
- Created
|
|
170
|
+
- Started
|
|
171
|
+
- Stopped
|
|
172
|
+
status:
|
|
173
|
+
description: Experiment off-core sync status
|
|
174
|
+
type: string
|
|
175
|
+
enum:
|
|
176
|
+
- Active
|
|
177
|
+
- CreateError
|
|
178
|
+
- DeleteError
|
|
179
|
+
- Deleting
|
|
180
|
+
- EditError
|
|
181
|
+
- Processing
|
|
182
|
+
stoppedDate:
|
|
183
|
+
description: Stopped date
|
|
184
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
185
|
+
sourceRecordId:
|
|
186
|
+
description: A record which created this Personalization Point and which is responsible for maintaining it. What type of object this is depends on the Source.
|
|
187
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
188
|
+
AbstractFieldPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
189
|
+
description: Abstract Field Predicate Representation
|
|
190
|
+
type: object
|
|
191
|
+
properties:
|
|
192
|
+
dataGraphType:
|
|
193
|
+
description: DataGraphTypeEnum
|
|
194
|
+
type: string
|
|
195
|
+
enum:
|
|
196
|
+
- Catalog
|
|
197
|
+
- Profile
|
|
198
|
+
fieldName:
|
|
199
|
+
description: The api name of the direct attribute field.
|
|
200
|
+
type: string
|
|
201
|
+
operator:
|
|
202
|
+
description: FieldOperatorEnum
|
|
203
|
+
type: string
|
|
204
|
+
enum:
|
|
205
|
+
- DoesNotMatch
|
|
206
|
+
- GreaterThan
|
|
207
|
+
- GreaterThanOrEqual
|
|
208
|
+
- IsEqualTo
|
|
209
|
+
- IsNotEqualTo
|
|
210
|
+
- LessThan
|
|
211
|
+
- LessThanOrEqual
|
|
212
|
+
- Matches
|
|
213
|
+
AbstractFieldRuleInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
214
|
+
description: Abstract Field Rule Input Representation
|
|
215
|
+
type: object
|
|
216
|
+
properties:
|
|
217
|
+
fieldName:
|
|
218
|
+
description: Direct Attribute’s field api name.
|
|
219
|
+
type: string
|
|
220
|
+
predicate:
|
|
221
|
+
description: RHS of filter condition with Direct Attribute on LHS.
|
|
222
|
+
type: object
|
|
223
|
+
AnchorReferenceRepresentation:
|
|
224
|
+
description: Anchor Reference Representation
|
|
225
|
+
type: object
|
|
226
|
+
properties:
|
|
227
|
+
dmoName:
|
|
228
|
+
description: The DMO name of the anchor
|
|
229
|
+
type: string
|
|
230
|
+
id:
|
|
231
|
+
description: The id of the anchor
|
|
232
|
+
type: string
|
|
233
|
+
BasePredicateInputRepresentation:
|
|
234
|
+
description: The right hand side against which the filter condition is checked.
|
|
235
|
+
type: object
|
|
236
|
+
properties:
|
|
237
|
+
type:
|
|
238
|
+
description: The type of Predicate object.
|
|
239
|
+
type: string
|
|
240
|
+
enum:
|
|
241
|
+
- Field
|
|
242
|
+
- RelatedField
|
|
243
|
+
- CalculatedInsight
|
|
244
|
+
- Segment
|
|
245
|
+
- DateOnly
|
|
246
|
+
- RelativeToNow
|
|
247
|
+
- Boolean
|
|
248
|
+
- Text
|
|
249
|
+
- Number
|
|
250
|
+
BaseRuleInputRepresentation:
|
|
251
|
+
description: Base Rule Input Representation
|
|
252
|
+
type: object
|
|
253
|
+
properties:
|
|
254
|
+
type:
|
|
255
|
+
description: The type of Rule object.
|
|
256
|
+
type: string
|
|
257
|
+
enum:
|
|
258
|
+
- Field
|
|
259
|
+
- RelatedField
|
|
260
|
+
- CalculatedInsight
|
|
261
|
+
CalculatedInsightPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
262
|
+
description: Calculated Insight Predicate Input Representation
|
|
263
|
+
type: object
|
|
264
|
+
properties:
|
|
265
|
+
calculatedInsightName:
|
|
266
|
+
description: The api name of the calculated insight.
|
|
267
|
+
type: string
|
|
268
|
+
fieldName:
|
|
269
|
+
description: The api name of the calculated insight’s metric.
|
|
270
|
+
type: string
|
|
271
|
+
fieldRuleOperator:
|
|
272
|
+
description: LogicalOperatorEnum
|
|
273
|
+
type: string
|
|
274
|
+
enum:
|
|
275
|
+
- And
|
|
276
|
+
- Or
|
|
277
|
+
fieldRules:
|
|
278
|
+
description: To capture Calculated Insight’s Dimension Rules and Metric Rules.
|
|
279
|
+
type: array
|
|
280
|
+
items:
|
|
281
|
+
type: object
|
|
282
|
+
operator:
|
|
283
|
+
description: The operator of the calculated insight predicate.
|
|
284
|
+
type: string
|
|
285
|
+
enum:
|
|
286
|
+
- DoesNotMatch
|
|
287
|
+
- GreaterThan
|
|
288
|
+
- GreaterThanOrEqual
|
|
289
|
+
- IsEqualTo
|
|
290
|
+
- IsNotEqualTo
|
|
291
|
+
- LessThan
|
|
292
|
+
- LessThanOrEqual
|
|
293
|
+
- Matches
|
|
294
|
+
CalculatedInsightRuleInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
295
|
+
description: Calculated Insight Rule Input Representation
|
|
296
|
+
type: object
|
|
297
|
+
properties:
|
|
298
|
+
calculatedInsightName:
|
|
299
|
+
description: The api name of calculated insight.
|
|
300
|
+
type: string
|
|
301
|
+
fieldName:
|
|
302
|
+
description: The api name of the metric or dimension.
|
|
303
|
+
type: string
|
|
304
|
+
fieldRuleOperator:
|
|
305
|
+
description: LogicalOperatorEnum
|
|
306
|
+
type: string
|
|
307
|
+
enum:
|
|
308
|
+
- And
|
|
309
|
+
- Or
|
|
310
|
+
fieldRules:
|
|
311
|
+
description: To capture Calculated Insight’s Dimension Rules and Metric Rules.
|
|
312
|
+
type: array
|
|
313
|
+
items:
|
|
314
|
+
type: object
|
|
315
|
+
predicate:
|
|
316
|
+
description: RHS of filter condition with calculated insight on LHS.
|
|
317
|
+
type: object
|
|
318
|
+
CriteriaRepresentation:
|
|
319
|
+
description: Personalization Decision Criteria Output Representation
|
|
320
|
+
type: object
|
|
321
|
+
properties:
|
|
322
|
+
filters:
|
|
323
|
+
description: Filters
|
|
324
|
+
type: array
|
|
325
|
+
items:
|
|
326
|
+
type: FilterRepresentation
|
|
327
|
+
operator:
|
|
328
|
+
description: Operator
|
|
329
|
+
type: string
|
|
330
|
+
type:
|
|
331
|
+
description: Type
|
|
332
|
+
type: string
|
|
333
|
+
DateOnlyPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
334
|
+
description: DateOnly Predicate Representation
|
|
335
|
+
type: object
|
|
336
|
+
properties:
|
|
337
|
+
operator:
|
|
338
|
+
description: Operator
|
|
339
|
+
type: string
|
|
340
|
+
enum:
|
|
341
|
+
- Between
|
|
342
|
+
- HasNoValue
|
|
343
|
+
- HasValue
|
|
344
|
+
- IsToday
|
|
345
|
+
- LastNumberOfDays
|
|
346
|
+
- NextNumberOfDays
|
|
347
|
+
- OnOrAfter
|
|
348
|
+
- OnOrBefore
|
|
349
|
+
values:
|
|
350
|
+
description: The static date values for comparison. Expected format is yyyy-MM-dd.
|
|
351
|
+
type: array
|
|
352
|
+
items:
|
|
353
|
+
type: string
|
|
354
|
+
FieldPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
355
|
+
description: Field Predicate Representation
|
|
356
|
+
type: object
|
|
357
|
+
properties:
|
|
358
|
+
dataGraphType:
|
|
359
|
+
description: DataGraphTypeEnum
|
|
360
|
+
type: string
|
|
361
|
+
enum:
|
|
362
|
+
- Catalog
|
|
363
|
+
- Profile
|
|
364
|
+
fieldName:
|
|
365
|
+
description: The api name of the direct attribute field.
|
|
366
|
+
type: string
|
|
367
|
+
operator:
|
|
368
|
+
description: FieldOperatorEnum
|
|
369
|
+
type: string
|
|
370
|
+
enum:
|
|
371
|
+
- DoesNotMatch
|
|
372
|
+
- GreaterThan
|
|
373
|
+
- GreaterThanOrEqual
|
|
374
|
+
- IsEqualTo
|
|
375
|
+
- IsNotEqualTo
|
|
376
|
+
- LessThan
|
|
377
|
+
- LessThanOrEqual
|
|
378
|
+
- Matches
|
|
379
|
+
FieldRuleInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
380
|
+
description: Field Rule Input Representation
|
|
381
|
+
type: object
|
|
382
|
+
properties:
|
|
383
|
+
fieldName:
|
|
384
|
+
description: Direct Attribute’s field api name.
|
|
385
|
+
type: string
|
|
386
|
+
predicate:
|
|
387
|
+
description: RHS of filter condition with Direct Attribute on LHS.
|
|
388
|
+
type: object
|
|
389
|
+
FilterRepresentation:
|
|
390
|
+
description: Personalization Decision Criteria Filter Output Representation
|
|
391
|
+
type: object
|
|
392
|
+
properties:
|
|
393
|
+
aggregateFunction:
|
|
394
|
+
description: Aggregate Function
|
|
395
|
+
required: false
|
|
396
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
397
|
+
comparison:
|
|
398
|
+
description: Comparison
|
|
399
|
+
required: false
|
|
400
|
+
type: FilterRepresentation | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
401
|
+
filter:
|
|
402
|
+
required: false
|
|
403
|
+
description: Filter
|
|
404
|
+
type: FiltersWrapRepresentation | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
405
|
+
filters:
|
|
406
|
+
required: false
|
|
407
|
+
description: Filters
|
|
408
|
+
type: array
|
|
409
|
+
items:
|
|
410
|
+
type: FilterRepresentation | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
411
|
+
firstBoundValue:
|
|
412
|
+
required: false
|
|
413
|
+
description: First Bound Value
|
|
414
|
+
type: number | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
415
|
+
metric:
|
|
416
|
+
required: false
|
|
417
|
+
description: Metric
|
|
418
|
+
type: SubjectRepresentation | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
419
|
+
operator:
|
|
420
|
+
required: false
|
|
421
|
+
description: Operator
|
|
422
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
423
|
+
path:
|
|
424
|
+
description: Path
|
|
425
|
+
required: false
|
|
426
|
+
type: array
|
|
427
|
+
items:
|
|
428
|
+
type: array
|
|
429
|
+
items:
|
|
430
|
+
type: SubjectRepresentation
|
|
431
|
+
ruleTimeZone:
|
|
432
|
+
required: false
|
|
433
|
+
description: Rule Time Zone
|
|
434
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
435
|
+
schedulingTimeZone:
|
|
436
|
+
required: false
|
|
437
|
+
description: Scheduling Time Zone
|
|
438
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
439
|
+
enum:
|
|
440
|
+
- Organization
|
|
441
|
+
- Recipient
|
|
442
|
+
secondBoundValue:
|
|
443
|
+
required: false
|
|
444
|
+
description: Second Bound Value
|
|
445
|
+
type: number | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
446
|
+
subject:
|
|
447
|
+
required: false
|
|
448
|
+
description: Subject
|
|
449
|
+
type: SubjectRepresentation | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
450
|
+
type:
|
|
451
|
+
required: false
|
|
452
|
+
description: Type
|
|
453
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
454
|
+
value:
|
|
455
|
+
required: false
|
|
456
|
+
description: Value
|
|
457
|
+
type: integer | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
458
|
+
values:
|
|
459
|
+
required: false
|
|
460
|
+
description: Values
|
|
461
|
+
type: array
|
|
462
|
+
items:
|
|
463
|
+
type: string
|
|
464
|
+
FiltersWrapRepresentation:
|
|
465
|
+
description: Personalization Decision Criteria Filters Wrap Output Representation
|
|
466
|
+
type: object
|
|
467
|
+
properties:
|
|
468
|
+
filters:
|
|
469
|
+
required: false
|
|
470
|
+
description: Filters
|
|
471
|
+
type: array
|
|
472
|
+
items:
|
|
473
|
+
type: FilterRepresentation
|
|
474
|
+
operator:
|
|
475
|
+
required: false
|
|
476
|
+
description: Operator
|
|
477
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
478
|
+
type:
|
|
479
|
+
required: false
|
|
480
|
+
description: Type
|
|
481
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
482
|
+
NumberPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
483
|
+
description: Number Predicate Representation
|
|
484
|
+
type: object
|
|
485
|
+
properties:
|
|
486
|
+
operator:
|
|
487
|
+
description: Operator
|
|
488
|
+
type: string
|
|
489
|
+
enum:
|
|
490
|
+
- Between
|
|
491
|
+
- GreaterThan
|
|
492
|
+
- GreaterThanOrEqual
|
|
493
|
+
- HasNoValue
|
|
494
|
+
- HasValue
|
|
495
|
+
- IsEqualTo
|
|
496
|
+
- IsNotEqualTo
|
|
497
|
+
- LessThan
|
|
498
|
+
- LessThanOrEqual
|
|
499
|
+
values:
|
|
500
|
+
description: The static values for comparison. Expected to be in decimal format
|
|
501
|
+
type: array
|
|
502
|
+
items:
|
|
503
|
+
type: string
|
|
504
|
+
PersonalizationAttributeInputRepresentation:
|
|
505
|
+
description: Personalization Attribute Input Representation
|
|
506
|
+
type: object
|
|
507
|
+
properties:
|
|
508
|
+
defaultValue:
|
|
509
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
510
|
+
description: Optional Personalization Attribute default value
|
|
511
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
512
|
+
label:
|
|
513
|
+
description: Personalization Attribute label
|
|
514
|
+
type: string
|
|
515
|
+
name:
|
|
516
|
+
description: Personalization Attribute API name
|
|
517
|
+
type: string
|
|
518
|
+
PersonalizationAttributeRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
519
|
+
description: Personalization Attribute Output Representation
|
|
520
|
+
type: object
|
|
521
|
+
properties:
|
|
522
|
+
createdById:
|
|
523
|
+
description: Created by id
|
|
524
|
+
type: string
|
|
525
|
+
createdDate:
|
|
526
|
+
description: Created date
|
|
527
|
+
type: string
|
|
528
|
+
id:
|
|
529
|
+
description: The 18 character ID of the record
|
|
530
|
+
type: string
|
|
531
|
+
label:
|
|
532
|
+
description: Personalization base output label
|
|
533
|
+
type: string
|
|
534
|
+
lastModifiedById:
|
|
535
|
+
description: Last modified by id
|
|
536
|
+
type: string
|
|
537
|
+
lastModifiedDate:
|
|
538
|
+
description: Last modified date
|
|
539
|
+
type: string
|
|
540
|
+
name:
|
|
541
|
+
description: Personalization base output API name
|
|
542
|
+
type: string
|
|
543
|
+
url:
|
|
544
|
+
description: Url
|
|
545
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
546
|
+
defaultValue:
|
|
547
|
+
description: Personalization Attribute default value
|
|
548
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
549
|
+
PersonalizationAttributeValueInputRepresentation:
|
|
550
|
+
description: Personalization Attribute Value Input Representation
|
|
551
|
+
type: object
|
|
552
|
+
properties:
|
|
553
|
+
attributeEnum:
|
|
554
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
555
|
+
description: Attribute enum if it is assigning a custom attribute
|
|
556
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
557
|
+
enum:
|
|
558
|
+
- FlowPath
|
|
559
|
+
- Variation
|
|
560
|
+
attributeName:
|
|
561
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
562
|
+
description: Attribute API name of the Personalization Attribute if it is
|
|
563
|
+
assigning a custom attribute
|
|
564
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
565
|
+
value:
|
|
566
|
+
description: Personalization Attribute Value
|
|
567
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
568
|
+
PersonalizationAttributeValueRepresentation:
|
|
569
|
+
description: Personalization Attribute Value Output Representation
|
|
570
|
+
type: object
|
|
571
|
+
properties:
|
|
572
|
+
attributeEnum:
|
|
573
|
+
description: A standard attribute that the value is being assigned to
|
|
574
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
575
|
+
enum:
|
|
576
|
+
- FlowPath
|
|
577
|
+
- Variation
|
|
578
|
+
attributeName:
|
|
579
|
+
description: An API name of a custom attribute the value is being assigned
|
|
580
|
+
to
|
|
581
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
582
|
+
value:
|
|
583
|
+
description: The value of the Personalization Attribute Value
|
|
584
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
585
|
+
PersonalizationDecisionInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
586
|
+
description: Personalization Decision Input Representation
|
|
587
|
+
type: object
|
|
588
|
+
properties:
|
|
589
|
+
description:
|
|
590
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
591
|
+
description: Personalization Base description
|
|
592
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
593
|
+
label:
|
|
594
|
+
description: Personalization Base label
|
|
595
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
596
|
+
name:
|
|
597
|
+
description: Personalization Point API name
|
|
598
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
599
|
+
attributeValues:
|
|
600
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
601
|
+
description: Personalization Attribute Values associated with a Personalization
|
|
602
|
+
Decision
|
|
603
|
+
type: array
|
|
604
|
+
items:
|
|
605
|
+
type: PersonalizationAttributeValueInputRepresentation #Hand-rolled issue #21 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
606
|
+
criteria:
|
|
607
|
+
description: Personalization Decision criteria
|
|
608
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
609
|
+
personalizerName:
|
|
610
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
611
|
+
description: The API name of the Personalizer associated with a Personalization
|
|
612
|
+
Decision
|
|
613
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
614
|
+
state:
|
|
615
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
616
|
+
description: Decision lifecycle state
|
|
617
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
618
|
+
enum:
|
|
619
|
+
- Live
|
|
620
|
+
- Draft
|
|
621
|
+
PersonalizationDecisionRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
622
|
+
description: Personalization Decision Output Representation
|
|
623
|
+
type: object
|
|
624
|
+
properties:
|
|
625
|
+
createdById:
|
|
626
|
+
description: Created by id
|
|
627
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
628
|
+
createdDate:
|
|
629
|
+
description: Created date
|
|
630
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
631
|
+
id:
|
|
632
|
+
description: The 18 character ID of the record
|
|
633
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
634
|
+
label:
|
|
635
|
+
description: Personalization base output label
|
|
636
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
637
|
+
lastModifiedById:
|
|
638
|
+
description: Last modified by id
|
|
639
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
640
|
+
lastModifiedDate:
|
|
641
|
+
description: Last modified date
|
|
642
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
643
|
+
name:
|
|
644
|
+
description: Personalization base output API name
|
|
645
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
646
|
+
url:
|
|
647
|
+
description: Url
|
|
648
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
649
|
+
attributeValues:
|
|
650
|
+
description: List of PersonalizationAttributeValues associated with the Personalization
|
|
651
|
+
Decision
|
|
652
|
+
type: array
|
|
653
|
+
items:
|
|
654
|
+
type: PersonalizationAttributeValueRepresentation
|
|
655
|
+
criteria:
|
|
656
|
+
description: The criteria of the Personalization Decision
|
|
657
|
+
type: CriteriaRepresentation | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
658
|
+
description:
|
|
659
|
+
description: Personalization Decision description
|
|
660
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
661
|
+
personalizerName:
|
|
662
|
+
description: The API name of the Personalizer associated with the Personalization
|
|
663
|
+
Decision
|
|
664
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
665
|
+
state:
|
|
666
|
+
description: Decision lifecycle state
|
|
667
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
668
|
+
enum:
|
|
669
|
+
- Live
|
|
670
|
+
- Draft
|
|
671
|
+
PersonalizationPointInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
672
|
+
description: Personalization Point Input Representation
|
|
673
|
+
type: object
|
|
674
|
+
properties:
|
|
675
|
+
description:
|
|
676
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
677
|
+
description: Personalization Base description
|
|
678
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
679
|
+
label:
|
|
680
|
+
description: Personalization Base label
|
|
681
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
682
|
+
name:
|
|
683
|
+
description: Personalization Point API name
|
|
684
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
685
|
+
abnExperimentName:
|
|
686
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
687
|
+
description: The API name of an ABn Experiment to associated with the Personalization
|
|
688
|
+
Point
|
|
689
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
690
|
+
dataSpaceName:
|
|
691
|
+
description: The API name of the Data Space associated with the Personalization
|
|
692
|
+
Point
|
|
693
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
694
|
+
decisions:
|
|
695
|
+
description: List of PersonalizationDecisions associated with the Personalization
|
|
696
|
+
Point
|
|
697
|
+
type: array
|
|
698
|
+
items:
|
|
699
|
+
type: PersonalizationDecisionInputRepresentation #Hand-rolled issue #21 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
700
|
+
maxItemsCount:
|
|
701
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
702
|
+
description: The max number of content items to be returned
|
|
703
|
+
type: integer | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
704
|
+
profileDataGraphName:
|
|
705
|
+
description: The API name of the Profile Data Graph associated with the Personalization
|
|
706
|
+
Point
|
|
707
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
708
|
+
rootPersonalizationPointId:
|
|
709
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
710
|
+
description: The ID of the root Personalization Point
|
|
711
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
712
|
+
schemaEnum:
|
|
713
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
714
|
+
description: A schema enum associated with the Personalization Point if it
|
|
715
|
+
has a standard schema
|
|
716
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
717
|
+
enum:
|
|
718
|
+
- ExperienceVariation
|
|
719
|
+
- FlowPath
|
|
720
|
+
schemaName:
|
|
721
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
722
|
+
description: An API name of a Schema associated with the Personalization Point
|
|
723
|
+
if it has a custom schema
|
|
724
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
725
|
+
source:
|
|
726
|
+
description: Personalization Point source
|
|
727
|
+
type: string
|
|
728
|
+
enum:
|
|
729
|
+
- BlockBuilder
|
|
730
|
+
- ExperienceBuilder
|
|
731
|
+
- FlowBuilder
|
|
732
|
+
- PersonalizationApp
|
|
733
|
+
isAuthenticationRequired:
|
|
734
|
+
description: Whether or not this personalization point requires the user executing it in the runtime to be authenticated
|
|
735
|
+
type: boolean
|
|
736
|
+
sourceRecordId:
|
|
737
|
+
required: false # https://salesforce-internal.slack.com/archives/C5WMAFS02/p1718348083566229
|
|
738
|
+
description: A record which created this Personalization Point and which is responsible for maintaining it. What type of object this is depends on the Source.
|
|
739
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
740
|
+
|
|
741
|
+
PersonalizationPointRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
742
|
+
description: Personalization Point Output Representation
|
|
743
|
+
type: object
|
|
744
|
+
properties:
|
|
745
|
+
createdById:
|
|
746
|
+
description: Created by id
|
|
747
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
748
|
+
createdDate:
|
|
749
|
+
description: Created date
|
|
750
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
751
|
+
id:
|
|
752
|
+
description: The 18 character ID of the record
|
|
753
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
754
|
+
label:
|
|
755
|
+
description: Personalization base output label
|
|
756
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
757
|
+
lastModifiedById:
|
|
758
|
+
description: Last modified by id
|
|
759
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
760
|
+
lastModifiedDate:
|
|
761
|
+
description: Last modified date
|
|
762
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
763
|
+
name:
|
|
764
|
+
description: Personalization base output API name
|
|
765
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
766
|
+
url:
|
|
767
|
+
description: Url
|
|
768
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
769
|
+
abnExperimentName:
|
|
770
|
+
description: The API name of an optional ABn Experiment associated with the
|
|
771
|
+
Personalization Point
|
|
772
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
773
|
+
dataSpaceName:
|
|
774
|
+
description: The API name of the Data Space associated with the Personalization
|
|
775
|
+
Point
|
|
776
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
777
|
+
decisions:
|
|
778
|
+
description: List of PersonalizationDecisions associated with the Personalization
|
|
779
|
+
Point
|
|
780
|
+
type: array
|
|
781
|
+
items:
|
|
782
|
+
type: PersonalizationDecisionRepresentation
|
|
783
|
+
description:
|
|
784
|
+
description: Personalization Point description
|
|
785
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
786
|
+
maxItemsCount:
|
|
787
|
+
description: The max number of content items to be returned
|
|
788
|
+
type: integer | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
789
|
+
profileDataGraphName:
|
|
790
|
+
description: The API name of the Profile Data Graph associated with the Personalization
|
|
791
|
+
Point
|
|
792
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
793
|
+
rootPersonalizationPointId:
|
|
794
|
+
description: The ID of the root Personalization Point
|
|
795
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
796
|
+
schemaEnum:
|
|
797
|
+
description: A schema enum associated with the Personalization Point if it
|
|
798
|
+
has a standard schema
|
|
799
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
800
|
+
enum:
|
|
801
|
+
- ExperienceVariation
|
|
802
|
+
- FlowPath
|
|
803
|
+
schemaName:
|
|
804
|
+
description: An API name of a Schema associated with the Personalization Point
|
|
805
|
+
if it has a custom schema
|
|
806
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
807
|
+
source:
|
|
808
|
+
description: Personalization Point source
|
|
809
|
+
type: string
|
|
810
|
+
enum:
|
|
811
|
+
- BlockBuilder
|
|
812
|
+
- ExperienceBuilder
|
|
813
|
+
- FlowBuilder
|
|
814
|
+
- PersonalizationApp
|
|
815
|
+
status:
|
|
816
|
+
description: Personalization Point status
|
|
817
|
+
type: string
|
|
818
|
+
enum:
|
|
819
|
+
- Active
|
|
820
|
+
- CreateError
|
|
821
|
+
- DeleteError
|
|
822
|
+
- Deleting
|
|
823
|
+
- EditError
|
|
824
|
+
- Processing
|
|
825
|
+
isAuthenticationRequired:
|
|
826
|
+
description: Whether or not this personalization point requires the user executing it in the runtime to be authenticated
|
|
827
|
+
type: boolean
|
|
828
|
+
sourceRecordId:
|
|
829
|
+
description: A record which created this Personalization Point and which is responsible for maintaining it. What type of object this is depends on the Source.
|
|
830
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
831
|
+
PersonalizationRecommenderSimulateActionInputRepresentation:
|
|
832
|
+
description: Personalization Recommender Simulate Action
|
|
833
|
+
type: object
|
|
834
|
+
properties:
|
|
835
|
+
anchors:
|
|
836
|
+
description: The list of anchors for which recommendations are needed if provided.
|
|
837
|
+
type: array
|
|
838
|
+
items:
|
|
839
|
+
type: AnchorReferenceRepresentation
|
|
840
|
+
required: false
|
|
841
|
+
excludeFilters:
|
|
842
|
+
description: The exclude filters being applied before rendering the recommendations.
|
|
843
|
+
type: RuleGroupInputRepresentation2
|
|
844
|
+
required: false
|
|
845
|
+
includeFilters:
|
|
846
|
+
description: The include filters being applied before rendering the recommendations.
|
|
847
|
+
type: RuleGroupInputRepresentation
|
|
848
|
+
required: false
|
|
849
|
+
individualId:
|
|
850
|
+
description: The individual id associated to a Data Cloud profile.
|
|
851
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
852
|
+
required: false
|
|
853
|
+
PersonalizationRecommenderSimulateActionRepresentation:
|
|
854
|
+
description: Personalization Recommender Simulate Action Output Representation
|
|
855
|
+
type: object
|
|
856
|
+
properties:
|
|
857
|
+
recommendations:
|
|
858
|
+
description: The list of recommendations for the recommender for a given individual
|
|
859
|
+
id and anchor id if provided
|
|
860
|
+
type: any
|
|
861
|
+
PersonalizationSchemaInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
862
|
+
description: Personalization Schema Input Representation
|
|
863
|
+
type: object
|
|
864
|
+
properties:
|
|
865
|
+
description:
|
|
866
|
+
description: Personalization Base description
|
|
867
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
868
|
+
label:
|
|
869
|
+
description: Personalization Base label
|
|
870
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
871
|
+
name:
|
|
872
|
+
description: Personalization Schema API name
|
|
873
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
874
|
+
attributes:
|
|
875
|
+
description: List of Personalization Attributes associated with the Personalization
|
|
876
|
+
Schema
|
|
877
|
+
type: array
|
|
878
|
+
items:
|
|
879
|
+
type: PersonalizationAttributeInputRepresentation #Hand-rolled issue #21 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
880
|
+
contentObjectFieldNames:
|
|
881
|
+
description: List of DMO field API names
|
|
882
|
+
type: array
|
|
883
|
+
items:
|
|
884
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
885
|
+
contentObjectName:
|
|
886
|
+
description: The API name of the associated Content Object
|
|
887
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
888
|
+
dataSpaceName:
|
|
889
|
+
description: The API name of the Data Space associated with the Personalization
|
|
890
|
+
Schema
|
|
891
|
+
type: string
|
|
892
|
+
personalizationType:
|
|
893
|
+
description: The type of the Personalization Schema
|
|
894
|
+
type: string
|
|
895
|
+
enum:
|
|
896
|
+
- ExperienceVariation
|
|
897
|
+
- FlowPath
|
|
898
|
+
- ManualContent
|
|
899
|
+
- Recommendations
|
|
900
|
+
PersonalizationSchemaRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
901
|
+
description: Personalization Schema Output Representation
|
|
902
|
+
type: object
|
|
903
|
+
properties:
|
|
904
|
+
createdById:
|
|
905
|
+
description: Created by id
|
|
906
|
+
type: string
|
|
907
|
+
createdDate:
|
|
908
|
+
description: Created date
|
|
909
|
+
type: string
|
|
910
|
+
id:
|
|
911
|
+
description: The 18 character ID of the record
|
|
912
|
+
type: string
|
|
913
|
+
label:
|
|
914
|
+
description: Personalization base output label
|
|
915
|
+
type: string
|
|
916
|
+
lastModifiedById:
|
|
917
|
+
description: Last modified by id
|
|
918
|
+
type: string
|
|
919
|
+
lastModifiedDate:
|
|
920
|
+
description: Last modified date
|
|
921
|
+
type: string
|
|
922
|
+
name:
|
|
923
|
+
description: Personalization base output API name
|
|
924
|
+
type: string
|
|
925
|
+
url:
|
|
926
|
+
description: Url
|
|
927
|
+
type: string
|
|
928
|
+
attributes:
|
|
929
|
+
description: List of Personalization Attributes associated with the Personalization
|
|
930
|
+
Schema
|
|
931
|
+
type: array
|
|
932
|
+
items:
|
|
933
|
+
type: PersonalizationAttributeRepresentation
|
|
934
|
+
contentObjectFieldNames:
|
|
935
|
+
description: List of DMO Field API names
|
|
936
|
+
type: array
|
|
937
|
+
items:
|
|
938
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
939
|
+
contentObjectName:
|
|
940
|
+
description: The API name of the associated Content Object
|
|
941
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
942
|
+
dataSpaceName:
|
|
943
|
+
description: The API name of the Data Space associated with the Personalization
|
|
944
|
+
Schema
|
|
945
|
+
type: string
|
|
946
|
+
description:
|
|
947
|
+
description: Personalization Schema description
|
|
948
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
949
|
+
personalizationType:
|
|
950
|
+
description: The type of the Personalization Schema
|
|
951
|
+
type: string
|
|
952
|
+
enum:
|
|
953
|
+
- ExperienceVariation
|
|
954
|
+
- FlowPath
|
|
955
|
+
- ManualContent
|
|
956
|
+
- Recommendations
|
|
957
|
+
RelatedFieldPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
958
|
+
description: Related Field Predicate Input Representation
|
|
959
|
+
type: object
|
|
960
|
+
properties:
|
|
961
|
+
dataGraphType:
|
|
962
|
+
description: DataGraphTypeEnum
|
|
963
|
+
type: string
|
|
964
|
+
enum:
|
|
965
|
+
- Catalog
|
|
966
|
+
- Profile
|
|
967
|
+
fieldName:
|
|
968
|
+
description: The api name of the direct attribute field.
|
|
969
|
+
type: string
|
|
970
|
+
operator:
|
|
971
|
+
description: FieldOperatorEnum
|
|
972
|
+
type: string
|
|
973
|
+
enum:
|
|
974
|
+
- DoesNotMatch
|
|
975
|
+
- GreaterThan
|
|
976
|
+
- GreaterThanOrEqual
|
|
977
|
+
- IsEqualTo
|
|
978
|
+
- IsNotEqualTo
|
|
979
|
+
- LessThan
|
|
980
|
+
- LessThanOrEqual
|
|
981
|
+
- Matches
|
|
982
|
+
aggregateFunction:
|
|
983
|
+
description: The Aggregate Function
|
|
984
|
+
type: string
|
|
985
|
+
enum:
|
|
986
|
+
- AtLeastOne
|
|
987
|
+
- Average
|
|
988
|
+
- Count
|
|
989
|
+
- Max
|
|
990
|
+
- Min
|
|
991
|
+
- Sum
|
|
992
|
+
relatedObjectsPath:
|
|
993
|
+
description: The path from root DMO to child DMO.
|
|
994
|
+
type: array
|
|
995
|
+
items:
|
|
996
|
+
type: string
|
|
997
|
+
RelatedFieldRuleInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
998
|
+
description: Related Field Rule Input Representation
|
|
999
|
+
type: object
|
|
1000
|
+
properties:
|
|
1001
|
+
fieldName:
|
|
1002
|
+
description: Direct Attribute’s field api name.
|
|
1003
|
+
type: string
|
|
1004
|
+
predicate:
|
|
1005
|
+
description: RHS of filter condition with Direct Attribute on LHS.
|
|
1006
|
+
type: object
|
|
1007
|
+
aggregateFunction:
|
|
1008
|
+
description: The Aggregate Function
|
|
1009
|
+
type: string
|
|
1010
|
+
enum:
|
|
1011
|
+
- AtLeastOne
|
|
1012
|
+
- Average
|
|
1013
|
+
- Count
|
|
1014
|
+
- Max
|
|
1015
|
+
- Min
|
|
1016
|
+
- Sum
|
|
1017
|
+
relatedObjectsPath:
|
|
1018
|
+
description: The path from root DMO to leaf DMO.
|
|
1019
|
+
type: array
|
|
1020
|
+
items:
|
|
1021
|
+
type: string
|
|
1022
|
+
RuleGroupInputRepresentation:
|
|
1023
|
+
description: Rule Group Representation
|
|
1024
|
+
type: object
|
|
1025
|
+
properties:
|
|
1026
|
+
operator:
|
|
1027
|
+
description: The field which gives the information whether to include/exclude
|
|
1028
|
+
all the filter conditions or any one of them.
|
|
1029
|
+
type: string
|
|
1030
|
+
enum:
|
|
1031
|
+
- And
|
|
1032
|
+
- Or
|
|
1033
|
+
rules:
|
|
1034
|
+
description: The filter conditions of the recommender.
|
|
1035
|
+
type: array
|
|
1036
|
+
items:
|
|
1037
|
+
type: object
|
|
1038
|
+
RuleGroupInputRepresentation2: #Hand-rolled - Identical to RuleGroupInputRepresentation object, both these objects need to stay in sync
|
|
1039
|
+
description: Rule Group Representation
|
|
1040
|
+
type: object
|
|
1041
|
+
properties:
|
|
1042
|
+
operator:
|
|
1043
|
+
description: The field which gives the information whether to include/exclude
|
|
1044
|
+
all the filter conditions or any one of them.
|
|
1045
|
+
type: string
|
|
1046
|
+
enum:
|
|
1047
|
+
- And
|
|
1048
|
+
- Or
|
|
1049
|
+
rules:
|
|
1050
|
+
description: The filter conditions of the recommender.
|
|
1051
|
+
type: array
|
|
1052
|
+
items:
|
|
1053
|
+
type: object
|
|
1054
|
+
SegmentMembershipPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1055
|
+
description: Segment Membership Predicate Input Representation
|
|
1056
|
+
type: object
|
|
1057
|
+
properties:
|
|
1058
|
+
operator:
|
|
1059
|
+
description: Operator
|
|
1060
|
+
type: string
|
|
1061
|
+
enum:
|
|
1062
|
+
- Equal
|
|
1063
|
+
- IsNotSubset
|
|
1064
|
+
- IsNotSuperset
|
|
1065
|
+
- IsSubset
|
|
1066
|
+
- IsSuperset
|
|
1067
|
+
- NotEqual
|
|
1068
|
+
SortCriteriaInputRepresentation:
|
|
1069
|
+
description: Personalization Recommender sort criteria Representation
|
|
1070
|
+
type: object
|
|
1071
|
+
properties:
|
|
1072
|
+
calculatedInsightMetricName:
|
|
1073
|
+
description: The api name of the metric of CI.
|
|
1074
|
+
type: string
|
|
1075
|
+
calculatedInsightName:
|
|
1076
|
+
description: The api name of the calculated insight.
|
|
1077
|
+
type: string
|
|
1078
|
+
sortOrder:
|
|
1079
|
+
description: Sort Order
|
|
1080
|
+
type: string
|
|
1081
|
+
TextPredicateInputRepresentation: #Hand-rolled issue #24 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1082
|
+
description: Text Predicate Representation
|
|
1083
|
+
type: object
|
|
1084
|
+
properties:
|
|
1085
|
+
operator:
|
|
1086
|
+
description: Operator
|
|
1087
|
+
type: string
|
|
1088
|
+
enum:
|
|
1089
|
+
- Contains
|
|
1090
|
+
- Equal
|
|
1091
|
+
- HasNoValue
|
|
1092
|
+
- HasValue
|
|
1093
|
+
- NotContains
|
|
1094
|
+
- NotEqual
|
|
1095
|
+
values:
|
|
1096
|
+
description: The static values for comparison.
|
|
1097
|
+
type: array
|
|
1098
|
+
items:
|
|
1099
|
+
type: string
|
|
1100
|
+
SubjectRepresentation:
|
|
1101
|
+
description: Personalization Decision Criteria Subject Output Representation
|
|
1102
|
+
type: object
|
|
1103
|
+
properties:
|
|
1104
|
+
fieldApiName:
|
|
1105
|
+
description: Field API Name
|
|
1106
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1107
|
+
fieldLabel:
|
|
1108
|
+
required: false
|
|
1109
|
+
description: Field Label
|
|
1110
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1111
|
+
objectApiName:
|
|
1112
|
+
required: false
|
|
1113
|
+
description: Object API Name
|
|
1114
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1115
|
+
objectLabel:
|
|
1116
|
+
required: false
|
|
1117
|
+
description: Object Label
|
|
1118
|
+
type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1119
|
+
PersonalizationRecommenderJobCollectionRepresentation:
|
|
1120
|
+
description: Personalization Recommender Job Collection Representation
|
|
1121
|
+
type: object
|
|
1122
|
+
properties:
|
|
1123
|
+
currentPageUrl:
|
|
1124
|
+
description: Url of the current page
|
|
1125
|
+
type: string
|
|
1126
|
+
required: false
|
|
1127
|
+
nextPageUrl:
|
|
1128
|
+
description: Url of the next page
|
|
1129
|
+
type: string
|
|
1130
|
+
required: false
|
|
1131
|
+
jobs:
|
|
1132
|
+
description: List of training job results
|
|
1133
|
+
type: array
|
|
1134
|
+
required: false
|
|
1135
|
+
items:
|
|
1136
|
+
type: PersonalizationRecommenderJobRepresentation
|
|
1137
|
+
PersonalizationRecommenderJobRepresentation:
|
|
1138
|
+
description: Personalization Recommender Job Representation
|
|
1139
|
+
type: object
|
|
1140
|
+
properties:
|
|
1141
|
+
version:
|
|
1142
|
+
description: Version of the job
|
|
1143
|
+
type: string
|
|
1144
|
+
required: false
|
|
1145
|
+
startTime:
|
|
1146
|
+
description: The start time of the job
|
|
1147
|
+
type: string
|
|
1148
|
+
required: false
|
|
1149
|
+
updatedTime:
|
|
1150
|
+
description: The updated time of the job
|
|
1151
|
+
type: string
|
|
1152
|
+
required: false
|
|
1153
|
+
status:
|
|
1154
|
+
description: The status of the job
|
|
1155
|
+
type: string
|
|
1156
|
+
required: false
|
|
1157
|
+
enum:
|
|
1158
|
+
- Complete
|
|
1159
|
+
- Processing
|
|
1160
|
+
- Failure
|
|
1161
|
+
- Canceled
|
|
1162
|
+
errorCode:
|
|
1163
|
+
description: Error code
|
|
1164
|
+
type: string
|
|
1165
|
+
required: false
|
|
1166
|
+
errorMessage:
|
|
1167
|
+
description: Error message
|
|
1168
|
+
type: string
|
|
1169
|
+
required: false
|
|
1170
|
+
PersonalizationDataMlModelInputFeatureRepresentation:
|
|
1171
|
+
description: Represents Personalization Data Ml Model Input
|
|
1172
|
+
type: object
|
|
1173
|
+
properties:
|
|
1174
|
+
inputField:
|
|
1175
|
+
description: CDP ES model Input Feature
|
|
1176
|
+
type: any
|
|
1177
|
+
personalizationField:
|
|
1178
|
+
description: Path or Name to the personalization field
|
|
1179
|
+
type: any
|
|
1180
|
+
type:
|
|
1181
|
+
description: Personalization Field Type
|
|
1182
|
+
type: string
|
|
1183
|
+
enum:
|
|
1184
|
+
- CalculatedInsights
|
|
1185
|
+
- Contextual
|
|
1186
|
+
- Direct
|
|
1187
|
+
- Related
|
|
1188
|
+
- Segment
|
|
1189
|
+
PersonalizationDataMlModelCollectionRepresentation:
|
|
1190
|
+
description: Represent Personalization Data Ml Model Collection
|
|
1191
|
+
type: object
|
|
1192
|
+
properties:
|
|
1193
|
+
personalizationDataMlModels:
|
|
1194
|
+
description: Personalization Data Ml Models
|
|
1195
|
+
type: array
|
|
1196
|
+
items:
|
|
1197
|
+
type: PersonalizationDataMlModelRepresentation
|
|
1198
|
+
PersonalizationDataMlModelRepresentation:
|
|
1199
|
+
description: Represent Personalization Data Ml Model
|
|
1200
|
+
type: object
|
|
1201
|
+
properties:
|
|
1202
|
+
id:
|
|
1203
|
+
description: The 18 character ID of the record
|
|
1204
|
+
type: string
|
|
1205
|
+
label:
|
|
1206
|
+
description: label of the model mapping
|
|
1207
|
+
type: string
|
|
1208
|
+
name:
|
|
1209
|
+
description: Name of the model mapping
|
|
1210
|
+
type: string
|
|
1211
|
+
dataMlModelInputs:
|
|
1212
|
+
description: Personalization Input mappings to ES model
|
|
1213
|
+
type: array
|
|
1214
|
+
items:
|
|
1215
|
+
type: PersonalizationDataMlModelInputFeatureRepresentation
|
|
1216
|
+
dataSpaceName:
|
|
1217
|
+
description: DataSpace Name
|
|
1218
|
+
type: string
|
|
1219
|
+
mlConfiguredModel:
|
|
1220
|
+
description: Einstein Studio Configured Model
|
|
1221
|
+
type: any
|
|
1222
|
+
profileDataGraphInfo:
|
|
1223
|
+
description: Profile Data Graph Info
|
|
1224
|
+
type: any
|
|
1225
|
+
status:
|
|
1226
|
+
description: status of the model mapping
|
|
1227
|
+
type: string
|
|
1228
|
+
enum:
|
|
1229
|
+
- Active
|
|
1230
|
+
- CreateError
|
|
1231
|
+
- DeleteError
|
|
1232
|
+
- Deleting
|
|
1233
|
+
- EditError
|
|
1234
|
+
- Processing
|
|
1235
|
+
PersonalizationExperienceConfigCollectionInputRepresentation:
|
|
1236
|
+
description: Personalization Experience Config Collection Input Representation
|
|
1237
|
+
type: object
|
|
1238
|
+
properties:
|
|
1239
|
+
personalizationExperienceConfigs:
|
|
1240
|
+
description: List of Personalization Experience Configs
|
|
1241
|
+
type: array
|
|
1242
|
+
items:
|
|
1243
|
+
type: array
|
|
1244
|
+
items:
|
|
1245
|
+
type: object
|
|
1246
|
+
PersonalizationExperienceConfigCollectionRepresentation:
|
|
1247
|
+
description: Personalization Experience Config Collection Output Representation
|
|
1248
|
+
type: PersonalizationPaginatedResponseBaseRepresentation
|
|
1249
|
+
properties:
|
|
1250
|
+
personalizationExperienceConfigs:
|
|
1251
|
+
description: List of Personalization Experience Configs
|
|
1252
|
+
type: array
|
|
1253
|
+
items:
|
|
1254
|
+
type: PersonalizationExperienceConfigRepresentation
|
|
1255
|
+
PersonalizationExperienceConfigInputRepresentation:
|
|
1256
|
+
description: Personalization Experience Config Input Representation
|
|
1257
|
+
type: object
|
|
1258
|
+
properties:
|
|
1259
|
+
dataProvider:
|
|
1260
|
+
description: What is supplying the data for this Personalization Experience?
|
|
1261
|
+
type: any
|
|
1262
|
+
description:
|
|
1263
|
+
description: Description of the Personalization Experience Config
|
|
1264
|
+
type: string
|
|
1265
|
+
displayUrl:
|
|
1266
|
+
description: When editing this configuration on the Website which page of
|
|
1267
|
+
the website should this configuration be displayed on if not the current
|
|
1268
|
+
page.
|
|
1269
|
+
type: string
|
|
1270
|
+
isEnabled:
|
|
1271
|
+
description: Whether or not this particular configuration is enabled.
|
|
1272
|
+
type: boolean
|
|
1273
|
+
label:
|
|
1274
|
+
description: Label of the Personalization Experience Config
|
|
1275
|
+
type: string
|
|
1276
|
+
lastModifiedDate:
|
|
1277
|
+
description: The datetime when this Personalization Experience Config was
|
|
1278
|
+
last modified.
|
|
1279
|
+
type: string
|
|
1280
|
+
required: false
|
|
1281
|
+
name:
|
|
1282
|
+
description: Name of the Personalization Experience Config
|
|
1283
|
+
type: string
|
|
1284
|
+
publishedDate:
|
|
1285
|
+
description: The datetime when this Personalization Experience Config was
|
|
1286
|
+
last published.
|
|
1287
|
+
type: string
|
|
1288
|
+
required: false
|
|
1289
|
+
sourceMatchers:
|
|
1290
|
+
description: How to find the source where this personalization will occur
|
|
1291
|
+
which for web is which web pages.
|
|
1292
|
+
type: array
|
|
1293
|
+
items:
|
|
1294
|
+
type: any
|
|
1295
|
+
transformationConfig:
|
|
1296
|
+
description: How will the data provided by the Data Provider be transformed?
|
|
1297
|
+
type: any
|
|
1298
|
+
PersonalizationPaginatedResponseBaseRepresentation:
|
|
1299
|
+
description: Base paginated response representation
|
|
1300
|
+
type: object
|
|
1301
|
+
discriminator: nextPageUrl
|
|
1302
|
+
properties:
|
|
1303
|
+
currentPageUrl:
|
|
1304
|
+
description: Current page url
|
|
1305
|
+
type: string
|
|
1306
|
+
nextPageUrl:
|
|
1307
|
+
description: Next page url if it exists
|
|
1308
|
+
type: string
|
|
1309
|
+
totalSize:
|
|
1310
|
+
description: Total size of collection
|
|
1311
|
+
type: integer
|
|
1312
|
+
PersonalizationExperienceConfigRepresentation:
|
|
1313
|
+
description: Personalization Experience Config Output Representation
|
|
1314
|
+
type: object
|
|
1315
|
+
properties:
|
|
1316
|
+
createdById:
|
|
1317
|
+
description: Id of the user who created this Personalization Experience Config
|
|
1318
|
+
type: string
|
|
1319
|
+
required: false
|
|
1320
|
+
createdDate:
|
|
1321
|
+
description: The datetime when this Personalization Experience Config was
|
|
1322
|
+
created.
|
|
1323
|
+
type: string
|
|
1324
|
+
required: false
|
|
1325
|
+
dataProvider:
|
|
1326
|
+
description: What is supplying the data for this Personalization Experience?
|
|
1327
|
+
type: any
|
|
1328
|
+
description:
|
|
1329
|
+
description: Description of the Personalization Experience Config
|
|
1330
|
+
type: string
|
|
1331
|
+
required: false
|
|
1332
|
+
displayUrl:
|
|
1333
|
+
description: When editing this configuration on the Website which page of
|
|
1334
|
+
the website should this configuration be displayed on if not the current
|
|
1335
|
+
page.
|
|
1336
|
+
type: string
|
|
1337
|
+
id:
|
|
1338
|
+
description: Id of the Personalization Experience Config
|
|
1339
|
+
type: string
|
|
1340
|
+
required: false
|
|
1341
|
+
isEnabled:
|
|
1342
|
+
description: Whether or not this particular configuration is enabled.
|
|
1343
|
+
type: boolean
|
|
1344
|
+
label:
|
|
1345
|
+
description: Label of the Personalization Experience Config
|
|
1346
|
+
type: string
|
|
1347
|
+
required: false
|
|
1348
|
+
lastModifiedById:
|
|
1349
|
+
description: Id of the user who last modified this Personalization Experience
|
|
1350
|
+
Config
|
|
1351
|
+
type: string
|
|
1352
|
+
required: false
|
|
1353
|
+
lastModifiedDate:
|
|
1354
|
+
description: The datetime when this Personalization Experience Config was
|
|
1355
|
+
last modified.
|
|
1356
|
+
type: string
|
|
1357
|
+
required: false
|
|
1358
|
+
name:
|
|
1359
|
+
description: Name of the Personalization Experience Config
|
|
1360
|
+
type: string
|
|
1361
|
+
publishedDate:
|
|
1362
|
+
description: The datetime when this Personalization Experience Config was
|
|
1363
|
+
last published.
|
|
1364
|
+
type: string
|
|
1365
|
+
required: false
|
|
1366
|
+
sourceMatchers:
|
|
1367
|
+
description: How to find the source where this personalization will occur
|
|
1368
|
+
which for web is which web pages.
|
|
1369
|
+
type: array
|
|
1370
|
+
items:
|
|
1371
|
+
type: any
|
|
1372
|
+
transformationConfig:
|
|
1373
|
+
description: How will the data provided by the Data Provider be transformed?
|
|
1374
|
+
type: any
|
|
1375
|
+
|
|
1376
|
+
/personalization:
|
|
1377
|
+
/personalization-points:
|
|
1378
|
+
post:
|
|
1379
|
+
displayName: postPersonalizationPointCollection
|
|
1380
|
+
description: Create a Personalization Point
|
|
1381
|
+
responses:
|
|
1382
|
+
'200':
|
|
1383
|
+
description: Success
|
|
1384
|
+
body:
|
|
1385
|
+
application/json:
|
|
1386
|
+
type: PersonalizationPointRepresentation
|
|
1387
|
+
body:
|
|
1388
|
+
application/json:
|
|
1389
|
+
type: PersonalizationPointInputRepresentation
|
|
1390
|
+
# required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1391
|
+
(oas-body-name): input
|
|
1392
|
+
/personalization-points/{idOrName}:
|
|
1393
|
+
delete:
|
|
1394
|
+
displayName: deletePersonalizationPoint
|
|
1395
|
+
description: Delete a Personalization Point
|
|
1396
|
+
responses:
|
|
1397
|
+
'200':
|
|
1398
|
+
description: Success
|
|
1399
|
+
get:
|
|
1400
|
+
displayName: getPersonalizationPoint
|
|
1401
|
+
description: Get a Personalization Point
|
|
1402
|
+
responses:
|
|
1403
|
+
'200':
|
|
1404
|
+
description: Success
|
|
1405
|
+
body:
|
|
1406
|
+
application/json:
|
|
1407
|
+
type: PersonalizationPointRepresentation
|
|
1408
|
+
put:
|
|
1409
|
+
displayName: putPersonalizationPoint
|
|
1410
|
+
description: Update a Personalization Point
|
|
1411
|
+
responses:
|
|
1412
|
+
'200':
|
|
1413
|
+
description: Success
|
|
1414
|
+
body:
|
|
1415
|
+
application/json:
|
|
1416
|
+
type: PersonalizationPointRepresentation
|
|
1417
|
+
body:
|
|
1418
|
+
application/json:
|
|
1419
|
+
type: PersonalizationPointInputRepresentation
|
|
1420
|
+
# required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1421
|
+
(oas-body-name): input
|
|
1422
|
+
uriParameters:
|
|
1423
|
+
idOrName:
|
|
1424
|
+
type: string
|
|
1425
|
+
required: true
|
|
1426
|
+
/personalization-schemas:
|
|
1427
|
+
post:
|
|
1428
|
+
displayName: postPersonalizationSchemaCollection
|
|
1429
|
+
description: Create a Personalization Schema
|
|
1430
|
+
responses:
|
|
1431
|
+
'200':
|
|
1432
|
+
description: Success
|
|
1433
|
+
body:
|
|
1434
|
+
application/json:
|
|
1435
|
+
type: PersonalizationSchemaRepresentation
|
|
1436
|
+
body:
|
|
1437
|
+
application/json:
|
|
1438
|
+
type: PersonalizationSchemaInputRepresentation
|
|
1439
|
+
# required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1440
|
+
(oas-body-name): input
|
|
1441
|
+
/personalization-schemas/{idOrName}:
|
|
1442
|
+
delete:
|
|
1443
|
+
displayName: deletePersonalizationSchema
|
|
1444
|
+
description: Delete a Personalization Schema
|
|
1445
|
+
responses:
|
|
1446
|
+
'200':
|
|
1447
|
+
description: Success
|
|
1448
|
+
get:
|
|
1449
|
+
displayName: getPersonalizationSchema
|
|
1450
|
+
description: Get a Personalization Schema
|
|
1451
|
+
responses:
|
|
1452
|
+
'200':
|
|
1453
|
+
description: Success
|
|
1454
|
+
body:
|
|
1455
|
+
application/json:
|
|
1456
|
+
type: PersonalizationSchemaRepresentation
|
|
1457
|
+
uriParameters:
|
|
1458
|
+
idOrName:
|
|
1459
|
+
type: string
|
|
1460
|
+
required: true
|
|
1461
|
+
/personalization-recommenders/{idOrName}:
|
|
1462
|
+
/jobs:
|
|
1463
|
+
get:
|
|
1464
|
+
displayName: getTrainingHistory
|
|
1465
|
+
description: Get Recommender's Training History
|
|
1466
|
+
responses:
|
|
1467
|
+
'200':
|
|
1468
|
+
description: Success
|
|
1469
|
+
body:
|
|
1470
|
+
application/json:
|
|
1471
|
+
type: PersonalizationRecommenderJobCollectionRepresentation
|
|
1472
|
+
queryParameters:
|
|
1473
|
+
limit:
|
|
1474
|
+
type: integer
|
|
1475
|
+
required: false
|
|
1476
|
+
offset:
|
|
1477
|
+
type: integer
|
|
1478
|
+
required: false
|
|
1479
|
+
uriParameters:
|
|
1480
|
+
idOrName:
|
|
1481
|
+
type: string
|
|
1482
|
+
required: true
|
|
1483
|
+
/actions/simulate:
|
|
1484
|
+
post:
|
|
1485
|
+
displayName: postPersonalizationRecommenderSimulateAction
|
|
1486
|
+
description: Get Recommender's Simulation
|
|
1487
|
+
responses:
|
|
1488
|
+
'200':
|
|
1489
|
+
description: Success
|
|
1490
|
+
body:
|
|
1491
|
+
application/json:
|
|
1492
|
+
type: PersonalizationRecommenderSimulateActionRepresentation
|
|
1493
|
+
body:
|
|
1494
|
+
application/json:
|
|
1495
|
+
type: PersonalizationRecommenderSimulateActionInputRepresentation
|
|
1496
|
+
# required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1497
|
+
(oas-body-name): input
|
|
1498
|
+
uriParameters:
|
|
1499
|
+
idOrName:
|
|
1500
|
+
type: string
|
|
1501
|
+
required: true
|
|
1502
|
+
/data-ml-models:
|
|
1503
|
+
get:
|
|
1504
|
+
displayName: getP13nEsMlModelCollection
|
|
1505
|
+
description: Get Es model mappings in Personalization
|
|
1506
|
+
responses:
|
|
1507
|
+
'200':
|
|
1508
|
+
description: Success
|
|
1509
|
+
body:
|
|
1510
|
+
application/json:
|
|
1511
|
+
type: PersonalizationDataMlModelCollectionRepresentation
|
|
1512
|
+
queryParameters:
|
|
1513
|
+
dataSpaceName:
|
|
1514
|
+
type: string
|
|
1515
|
+
required: false
|
|
1516
|
+
limit:
|
|
1517
|
+
type: integer
|
|
1518
|
+
required: false
|
|
1519
|
+
mlConfiguredModelName:
|
|
1520
|
+
type: string
|
|
1521
|
+
required: false
|
|
1522
|
+
offset:
|
|
1523
|
+
type: integer
|
|
1524
|
+
required: false
|
|
1525
|
+
profileDataGraphName:
|
|
1526
|
+
type: string
|
|
1527
|
+
required: false
|
|
1528
|
+
status:
|
|
1529
|
+
type: string
|
|
1530
|
+
required: false
|
|
1531
|
+
enum:
|
|
1532
|
+
- Active
|
|
1533
|
+
- CreateError
|
|
1534
|
+
- DeleteError
|
|
1535
|
+
- Deleting
|
|
1536
|
+
- EditError
|
|
1537
|
+
- Processing
|
|
1538
|
+
|
|
1539
|
+
/external-apps/{idOrAppSourceIdOrName}/personalization-experience-configs:
|
|
1540
|
+
get:
|
|
1541
|
+
displayName: getPersonalizationExperienceConfigCollection
|
|
1542
|
+
description: Gets a list of Personalization Experience Configs
|
|
1543
|
+
responses:
|
|
1544
|
+
'200':
|
|
1545
|
+
description: Success
|
|
1546
|
+
body:
|
|
1547
|
+
application/json:
|
|
1548
|
+
type: PersonalizationExperienceConfigCollectionRepresentation
|
|
1549
|
+
queryParameters:
|
|
1550
|
+
limit:
|
|
1551
|
+
type: integer
|
|
1552
|
+
required: false
|
|
1553
|
+
offset:
|
|
1554
|
+
type: integer
|
|
1555
|
+
required: false
|
|
1556
|
+
post:
|
|
1557
|
+
displayName: postPersonalizationExperienceConfigCollection
|
|
1558
|
+
description: Create a Personalization Experience Config
|
|
1559
|
+
responses:
|
|
1560
|
+
'200':
|
|
1561
|
+
description: Success
|
|
1562
|
+
body:
|
|
1563
|
+
application/json:
|
|
1564
|
+
type: PersonalizationExperienceConfigRepresentation
|
|
1565
|
+
body:
|
|
1566
|
+
application/json:
|
|
1567
|
+
type: PersonalizationExperienceConfigInputRepresentation
|
|
1568
|
+
# required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1569
|
+
(oas-body-name): input
|
|
1570
|
+
uriParameters:
|
|
1571
|
+
idOrAppSourceIdOrName:
|
|
1572
|
+
type: string
|
|
1573
|
+
required: true
|
|
1574
|
+
/external-apps/{idOrAppSourceIdOrName}/personalization-experience-configs/{nameParam}:
|
|
1575
|
+
delete:
|
|
1576
|
+
displayName: deletePersonalizationExperienceConfig
|
|
1577
|
+
description: Delete a Personalization Experience Config
|
|
1578
|
+
responses:
|
|
1579
|
+
'200':
|
|
1580
|
+
description: Success
|
|
1581
|
+
get:
|
|
1582
|
+
displayName: getPersonalizationExperienceConfig
|
|
1583
|
+
description: Get a Personalization Experience Config
|
|
1584
|
+
responses:
|
|
1585
|
+
'200':
|
|
1586
|
+
description: Success
|
|
1587
|
+
body:
|
|
1588
|
+
application/json:
|
|
1589
|
+
type: PersonalizationExperienceConfigRepresentation
|
|
1590
|
+
put:
|
|
1591
|
+
displayName: putPersonalizationExperienceConfig
|
|
1592
|
+
description: Updates a Personalization Experience Config
|
|
1593
|
+
responses:
|
|
1594
|
+
'200':
|
|
1595
|
+
description: Success
|
|
1596
|
+
body:
|
|
1597
|
+
application/json:
|
|
1598
|
+
type: PersonalizationExperienceConfigRepresentation
|
|
1599
|
+
body:
|
|
1600
|
+
application/json:
|
|
1601
|
+
type: PersonalizationExperienceConfigInputRepresentation
|
|
1602
|
+
# required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
|
|
1603
|
+
(oas-body-name): input
|
|
1604
|
+
uriParameters:
|
|
1605
|
+
idOrAppSourceIdOrName:
|
|
1606
|
+
type: string
|
|
1607
|
+
required: true
|
|
1608
|
+
nameParam:
|
|
1609
|
+
type: string
|
|
1610
|
+
required: true
|