Payload classes
Agreements class
Class responsible for passing agreements.
Declared In
com.synerise.sdk.client.model.client.Agreements
Declaration
public class Agreements
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
Boolean |
yes | - | Email agreement | |
| sms | Boolean |
yes | - | SMS agreement |
| push | Boolean |
yes | - | Push agreement |
| bluetooth | Boolean |
yes | - | Bluetooth agreement |
| rfid | Boolean |
yes | - | RFID agreement |
| wifi | Boolean |
yes | - | WiFi agreement |
Initializers
There are no initializers.
Methods
All properties have their own setters and getters.
Attributes class
Class responsible for passing attributes.
Declared In
com.synerise.sdk.client.model.client.Attributes
Declaration
public class Attributes
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| properties | HashMap<String, String> |
yes | - | A key-value pair of profile’s attributes |
Initializers
There are no initializers.
Methods
This method adds attributes.
public Attributes add(String key, String value)This method retrieves a value of an attribute.
public HashMap<String, String> getProperties()RegisterClient class
Class responsible for registering a profile.
Declared In
com.synerise.sdk.client.model.client.RegisterClient
Declaration
public class RegisterClient extends BaseClient
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | Agreements | no | - | Profile’s agreements |
| attributes | Attributes | no | - | Profile’s attributes |
| city | String |
yes | - | Profile’s city |
| company | String |
yes | - | Profile’s company |
| countryCode | String |
yes | - | Profile’s country code |
| customId | String |
yes | - | Profile’s customId |
| firstName | String |
yes | - | Profile’s first name |
| lastName | String |
yes | - | Profile’s last name |
| phoneNumber | String |
yes | - | Profile’s phone number |
| province | String |
yes | - | Profile’s province |
| sex | Sex | yes | - | Profile’s sex |
| zipCode | String |
yes | - | Profile’s ZIP code |
| uuid | String |
yes | - | Profile’s UUID |
String |
yes | - | Profile’s email | |
| password | String |
yes | - | Profile’s password |
Initializers
There are no initializers.
Methods
All properties have their own setters.
PasswordResetRequest class
Class responsible for creating a payload for password reset request.
Declared In
com.synerise.sdk.client.model.password.PasswordResetRequest
Declaration
public final class PasswordResetRequest
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
String |
yes | - | Profile’s email |
Initializers
There is a constructor.
public PasswordResetRequest(@NonNull String email)Methods
There are no methods.
PasswordResetConfirmation class
Class responsible for creating a payload for password reset confirmation.
Declared In
com.synerise.sdk.client.model.password.PasswordResetConfirmation
Declaration
public final class PasswordResetConfirmation
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| password | String |
no | - | Profile’s password |
| token | String |
no | - | Profile’s token |
Initializers
There is a constructor.
public PasswordResetConfirmation(@NonNull String password, @NonNull String token)Methods
There are no methods.
UpdateAccountInformation class
Class providing data to update account information.
Declared In
com.synerise.sdk.client.model.UpdateAccountInformation
Declaration
public final class UpdateAccountInformation extends AccountInformation
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
String |
no | - | Profile’s email | |
| phoneNumber | String |
no | - | Profile’s phone |
| customId | String |
no | - | Profile’s customId |
| uuid | String |
no | - | Profile’s uuid |
| firstName | String |
no | - | Profile’s first name |
| lastName | String |
no | - | Profile’s last name |
| displayName | String |
no | - | Profile’s display name |
| company | String |
no | - | Profile’s company |
| address | String |
no | - | Profile’s address |
| city | String |
no | - | Profile’s city |
| province | String |
no | - | Profile’s province |
| zipCode | String |
no | - | Profile’s ZIP code |
| countryCode | String |
no | - | Profile’s country code |
| birthDate | String |
no | - | Profile’s birth date |
| sex | Sex | no | - | Profile’s sex |
| avatarUrl | String |
no | - | Profile’s avatar URL |
| anonymous | Boolean |
no | - | Defines if the profile is anonymous |
| agreements | Agreements | no | - | Profile’s agreements |
| attributes | Attributes | no | - | Profile’s attributes |
Initializers
There are no initializers.
Methods
There are only setters for above properties.
ClientEventQuery class
Class responsible for creating a query to get events.
Declared In
com.synerise.sdk.client.model.client.ClientEventsQuery
Declaration
public class ClientEventsQuery
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| actions | List<String> |
yes | - | Event action |
| timeFrom | Date |
yes | - | Event time |
| label | String |
yes | - | This value is currently unused |
| limit | int |
yes | 1000 | Event limit |
Initializers
There are no initializers.
Methods
There are no methods.
RecommendationRequestBody class
Class responsible for creating a recommendation request.
Declared In
com.synerise.sdk.content.model.recommendation.RecommendationRequestBody
Declaration
public final class RecommendationRequestBody implements Serializable
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| productId | String |
no | - | ID of the item |
| itemsIds | ArrayList<String> |
no | - | List of item IDs for cart recommendations |
| itemsExcluded | ArrayList<String> |
no | Items that will be excluded from the generated recommendations | |
| additionalFilters | String |
no | Additional filters. These are merged with the campaign’s own filters according to the logic in filtersJoiner |
|
| filtersJoiner | String |
no | Defines the logic of merging additionalFilters with the campaign’s existing filters | |
| additionalElasticFilters | String |
no | Additional elastic filters. These are merged with the campaign’s own elastic filters according to the logic in elasticFiltersJoiner |
|
| elasticFiltersJoiner | String |
no | Defines the logic of merging additionalElasticFilters with the campaign’s existing elastic filters |
|
| displayAttribute | ArrayList<String> |
no | An array of item attributes which value will be returned in a recommendation response | |
| includeContextItems | Boolean |
no | When true, the recommendation response will include context item metadata |
Initializers
There are no initializers.
Methods
Setter for productId
public RecommendationRequestBody setProductId(String productId)Setter for itemsIds
public RecommendationRequestBody setItemsIds(ArrayList<String> itemsIds)DocumentsApiQuery class
Class responsible for creating a query to the Documents API.
Declared In
com.synerise.sdk.content.model.DocumentsApiQuery
Declaration
public class DocumentsApiQuery
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| type | DocumentsApiQueryType | yes | - | Document’s query type |
| typeValue | String |
yes | - | Document’s query type value |
| version | String |
yes | - | Document version |
Initializers
There are no initializers.
Methods
This method sets query parameters.
public void setDocumentQueryParameters(DocumentsApiQueryType type, String typeValue)This method sets a document version.
public void setVersion(String version)PromotionsApiQuery class
Class responsible for creating a promotion query.
Declared In
com.synerise.sdk.promotions.model.promotion.PromotionsApiQuery
Declaration
public class PromotionsApiQuery
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| statuses | List<PromotionStatus> | yes | - | List of promotion states |
| types | List<PromotionType> | yes | - | List of promotion types |
| sortParameters | LinkedHashMap<PromotionSortingKey, ApiQuerySortingOrder> | yes | - | Sort parameters. If you add more than one sorting attribute, the importance of each attribute depends on its position. The first one is the most important. |
| limit | int |
no | 100 | Limit of promotions per page |
| page | int |
no | 1 | Page number |
| includeMeta | boolean |
no | false | If true, the response includes metadata |
Initializers
There are no initializers.
Methods
There are only setters for above properties.
PromotionIdentifier class
Class model for a promotion identifier.
Declared In
com.synerise.sdk.promotions.model.promotion.PromotionIdentifier
Declaration
public class PromotionIdentifier implements Serializable
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| key | String |
no | - | Promotion key identifier |
| value | String |
no | - | Promotion identifier value |
Initializers
There is a constructor.
Methods
There are no methods.
