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
email 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 - Key - value pair of your attributes

Initializers

There are no initializers.

Methods

Method to add attributes.

public Attributes add(String key, String value)


Method to get attribute properties.

public HashMap<String, String> getProperties()


RegisterClient class


Class responsible for registering a client.

Declared In

com.synerise.sdk.client.model.client.RegisterClient

Declaration

public class RegisterClient extends BaseClient

Properties

Property Type Optional Default Description
agreements Agreements no - Client’s agreements
attributes Attributes no - Client’s attributes
city String yes - Client’s city
company String yes - Client’s company
countryCode String yes - Client’s country code
customId String yes - Client’s customId
firstName String yes - Client’s first name
lastName String yes - Client’s last name
phoneNumber String yes - Client’s phone number
province String yes - Client’s province
sex Sex yes - Client’s sex
zipCode String yes - Client’s ZIP code
uuid String yes - Client’s UUID
email String yes - Client’s email
password String yes - Client’s password

Initializers

There are no initializers.

Methods

All properties have their own setters.


PasswordResetRequest class


Class responsible for creating 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
email String yes - Client’s email

Initializers

There is a constructor.

public PasswordResetRequest(@NonNull String email)

Methods

There are no methods.


PasswordResetConfirmation class


Class responsible for creating 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 - Client’s password
token String no - Client’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
email String no - Client’s email
phoneNumber String no - Client’s phone
customId String no - Client’s customId
uuid String no - Client’s uuid
firstName String no - Client’s first name
lastName String no - Client’s last name
displayName String no - Client’s display name
company String no - Client’s company
address String no - Client’s address
city String no - Client’s city
province String no - Client’s province
zipCode String no - Client’s ZIP code
countryCode String no - Client’s country code
birthDate String no - Client’s birth date
sex Sex no - Client’s sex
avatarUrl String no - Client’s avatar URL
anonymous Boolean no - Defines if the client is anonymous
agreements Agreements no - Client’s agreements
attributes Attributes no - Client’s attributes
Note: All of the properties above are accessible by using setters.

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 time
timeFrom Date yes - Event action
label Date yes - Event label parameter
limit int yes 1000 Event limit
Note: All of the properties above are accessible by using setters.

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 - Product’s ID

Initializers

There are no initializers.

Methods

Setter for productId

public RecommendationRequestBody setProductId(String productId)

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

Set query parameters.

public void setDocumentQueryParameters(DocumentsApiQueryType type, String typeValue)

Set 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
Note: All of the properties above are accessible by using setters.

Initializers

There are no initializers.

Methods

There are only setters for above properties.

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.