Miscellaneous
BaseModel
Base class for all models.
WARNING: This is an abstract class and it is not meant to be instantiated directly.
Declared In
lib/classes/models/BaseModel.js
Declaration
interface ModelMappable {
toObject(): object;
}
abstract class BaseModel implements ModelMappable
ApiQuerySortingOrder
Declared In
lib/classes/api_queries/BaseApiQuery.js
Declaration
enum ApiQuerySortingOrder {
Ascending = 'asc',
Descending = 'desc',
}
Error
Declared In
lib/classes/types/Error.js
Declaration
class Error
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| code | number |
yes | Error code |
| message | string |
yes | Error message |
Initializers
constructor(code: number, message: string)
ScreenViewResponse
Model representing a highest-priority customer screen view campaign.
WARNING: This is a read-only class and it is not meant to be instantiated directly.
Declared In
lib/classes/content/ScreenViewResponse.js
Related To
Inherits From
Declaration
class ScreenViewResponse extends BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| audience | ScreenViewAudience |
no | Audience of a screen view |
| identifier | string |
no | Screen View’s ID |
| hashString | string |
no | Screen View’s hash |
| path | string |
no | Screen View’s path |
| name | string |
no | Screen View’s name |
| priority | number |
no | Screen View’s priority |
| descriptionText | string |
yes | Screen View’s description |
| data | object |
no | Screen View’s data |
| version | string |
no | Version of a screen view |
| parentVersion | string |
yes | Parent version of a screen view |
| createdAt | Date |
no | Screen View’s creation date |
| updatedAt | Date |
no | Screen View’s update date |
| deletedAt | Date |
yes | Screen View’s deletion date |
ScreenViewAudience
Model representing an audience of customer screen view.
WARNING: This is a read-only class and it is not meant to be instantiated directly.
Declared In
lib/classes/content/ScreenViewAudience.js
Related To
Inherits From
Declaration
class ScreenViewAudience extends BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| IDs | Array<string> |
yes | Audience’s identifiers |
| query | string |
yes | Audience’s query |
