Recommendations and Documents
Recommendations
RecommendationResponse
Declared In
lib/classes/content/RecommendationResponse.js
Related To
Inherits From
Declaration
class RecommendationResponse extends BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| name | string |
no | Recommendations name |
| campaignHash | string |
no | Campaign Hash |
| campaignID | string |
no | Campaign ID |
| items | Array<recommendation> |
no | List of recommendation items |
Recommendation
Model representating a recommendation item data.
WARNING: This is a read-only class and it is not meant to be instantiated directly.
Declared In
lib/classes/Content/Recommendation.js
Related To
Inherits From
Declaration
class Recommendation extends BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| itemID | string |
no | Product’s GTIN |
| attributes | Record<string, any> |
no | Product’s recommendation attributes |
RecommendationOptions
Declared In
lib/classes/content/RecommendationOptions.js
Declaration
class RecommendationOptions
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| slug | string |
no | Unique identifier of a specific recommendation |
| productID | string |
no | Product ID attribute |
Documents
DocumentsApiQuery
The object to set parameters easily for fetching documents from API.
Declared In
lib/classes/api_queries/DocumentsApiQuery.js
Related To
Declaration
class DocumentsApiQuery
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| type | DocumentsApiQueryType |
no | .bySchema | Query type |
| typeValue | string |
no | nil | Value for query type |
| version | string |
yes | nil | Specifies document version |
Initializers
constructor(type: DocumentsApiQueryType, typeValue: string, version: string)
DocumentsApiQueryType
Declared In
lib/classes/api_queries/DocumentsApiQueryType.js
Declaration
enum DocumentsApiQueryType {
SCHEMA = 'by-schema',
}
