Customer account management

Declaration:

Future<void> getAccount({required void Function(ClientAccountInformation) onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Default	Description
onSuccess	Function(ClientAccountInformation clientAccountInformation)	yes	-	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	-	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

await Synerise.client.getAccount(onSuccess: (ClientAccountInformation result) {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});

Declaration:

Future<ClientAccountInformation> getAccount() async

Return Value:
ClientAccountInformation

Example:

final ClientAccountInformation clientAccountInformation = await Synerise.client.getAccount().catchError((error)

Declaration:

Future<void> updateAccount(ClientAccountUpdateContext context,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

Parameters:

Parameter	Type	Mandatory	Default	Description
context	ClientAccountUpdateContext	yes	-	Object with customer's email, password, and other optional data
onSuccess	Function()	yes	-	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	-	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

ClientAccountUpdateContext clientAccountUpdateContext = ClientAccountUpdateContext(
        email: email,
        password: password,
        firstName: firstName,
        lastName: lastName,
        sex: ClientSex.getClientSexFromString(sex));

    await Synerise.client.updateAccount(clientAccountUpdateContext, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

Declaration:

Future<void> updateAccount(ClientAccountUpdateContext context) async

Parameters:

Parameter	Type	Mandatory	Default	Description
context	ClientAccountUpdateContext	yes	-	Object with customer's email, password, and other optional data

Return Value:
No value is returned.

Example:

ClientAccountUpdateContext clientAccountUpdateContext = ClientAccountUpdateContext(
        email: email,
        password: password,
        firstName: firstName,
        lastName: lastName,
        sex: ClientSex.getClientSexFromString(sex));

    await Synerise.client.updateAccount(clientAccountUpdateContext).catchError((error) {
      //onError handling
    });

Declaration:

Future<void> changePassword(String oldPassword, String newPassword,
    {required void Function() onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Default	Description
oldPassword	String	yes	-	Customer’s old password
newPassword	String	yes	-	Customer’s new password
onSuccess	Function()	yes	-	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	-	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

await Synerise.client.changePassword(oldPassword, newPassword, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

Declaration:

Future<void> changePassword(String oldPassword,  String password) async

Parameters:

Parameter	Type	Mandatory	Default	Description
newPassword	String	yes	-	Customer’s new password
oldPassword	String	yes	-	Customer’s old password

Return Value:
No value is returned.

Example:

await  Synerise.client.changePassword(oldPassword, password).catchError((error)

Declaration:

Future<void> requestPasswordReset(String email, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Default	Description
email	String	yes	-	Customer’s email
onSuccess	Function()	yes	-	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	-	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

await Synerise.client.requestPasswordReset(email, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});

Declaration:

Future<void> requestPasswordReset(String email) async

Parameters:

Parameter	Type	Mandatory	Default	Description
email	String	yes	-	Customer’s email

Return Value:
No value is returned.

Example:

await  Synerise.client.requestPasswordReset(email).catchError((error)

Declaration:

Future<void> confirmPasswordReset(String password, String token, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Default	Description
password	String	yes	-	New password for the customer
token	String	yes	-	Customer's token provided in an email
onSuccess	Function()	yes	-	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	-	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

await Synerise.client.confirmPasswordReset(password, token, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});

Declaration:

Future<void> confirmPasswordReset(String password, String token) async

Parameters:

Parameter	Type	Mandatory	Default	Description
email	String	yes	-	Customer’s email
token	String	yes	-	Customer's token provided in an email

Return Value:
No value is returned.

Example:

await  Synerise.client.confirmPasswordReset(email, token).catchError((error)

Declaration:

Future<void> deleteAccount(String clientAuthFactor, IdentityProvider identityProvider, {String? authId, required void Function() onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Default	Description
clientAuthFactor	String	yes	-	Customer’s password or token from the identity provider
identityProvider	ClientIdentityProvider	yes	-	Customer's identity provider
authID	String	no	null	Optional identifier of authorization
onSuccess	Function()	yes	-	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	-	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

await Synerise.client.deleteAccount(clientAuthFactor, identityProvider, authId, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});

Declaration:

Future<void> deleteAccount(String clientAuthFactor,  IdentityProvider identityProvider,  String? authId) async

Parameters:

Parameter	Type	Mandatory	Default	Description
clientAuthFactor	String	yes	-	Customer’s password or token from the identity provider
identityProvider	ClientIdentityProvider	yes	-	Customer's identity provider
authID	String	yes	null	Optional identifier of authorization

Return Value:
No value is returned.

Example:

await  Synerise.client.deleteAccount(clientAuthFactor, identityProvider, authId).catchError((error)

Declaration:

Future<void> requestEmailChange(String email, String password, {String? externalToken, String? authID, required void Function() onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Description
email	String	yes	Customer's new email
password	String	yes	Customer's password
externalToken	String	no	Customer's token (if OAuth, Facebook, and so on)
authID	String	no	Optional identifier of authorization
onSuccess	Function()	yes	-
onError	Function(SyneriseError error)	yes	-

Return Value:
No value is returned.

Example:

await Synerise.client.requestEmailChange(email, password, externalToken: externalToken, authID: authID, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});

Declared In:
lib/modules/client/client_impl.dart

Class:
ClientImpl

Declaration:

Future<void> requestEmailChange(String email, String password, [String? externalToken, String? authID]) async

Parameters:

Parameter	Type	Mandatory	Description
email	String	yes	Customer's new email
password	String	yes	Customer's password
externalToken	String	no	Customer's token (if OAuth, Facebook, and so on)
authID	String	no	Optional identifier of authorization

Return Value:
No value is returned.

Example:

await Synerise.client.requestEmailChange(email, password).catchError((error) {

Declaration:

Future<void> confirmEmailChange(String token, bool newsletterAgreement,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

Parameters:

Parameter	Type	Mandatory	Description
token	String	yes	Customer's token provided in an email
newsletterAgreement	bool	yes	Agreement for sending newsletters to the provided email
onSuccess	Function()	yes	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

await Synerise.client.confirmAccountActivationByPin(email, pinCode, onSuccess: () {
    //onSuccess handling
  }, onError: (SyneriseError error) {
    //onError handling
  });

Declaration:

Future<void> confirmEmailChange(String token, bool newsletterAgreement) async

Parameters:

Parameter	Type	Mandatory	Description
token	String	yes	Customer's token provided in an email
newsletterAgreement	bool	yes	Agreement for sending newsletters to the provided email

Return Value:
No value is returned.

Example:

await Synerise.client.confirmEmailChange(token, true).catchError((error) {

Declaration:

Future<void> requestPhoneUpdate(String phone, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Description
phone	String	yes	Customer's new phone number
onSuccess	Function()	yes	-
onError	Function(SyneriseError error)	yes	-

Return Value:
No value is returned.

Example:

await Synerise.client.requestPhoneUpdate(phone, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});

Declaration:

Future<void> requestPhoneUpdate(String phone) async

Parameters:

Parameter	Type	Mandatory	Description
phone	String	yes	Customer's new phone number

Return Value:
No value is returned.

Example:

await Synerise.client.requestPhoneUpdate(phone).catchError((error) {

Declaration:

Future<void> confirmPhoneUpdate(String phone, String confirmationCode, bool smsAgreement, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async

Parameters:

Parameter	Type	Mandatory	Description
phone	String	yes	New phone number
confirmationCode	String	yes	A confirmation code received by a text message
smsAgreement	bool	yes	Agreement for sending SMS to the provided number
onSuccess	Function()	yes	Function to be executed when the operation is completed successfully
onError	Function(SyneriseError error)	yes	Function to be executed when the operation is completed with an error

Return Value:
No value is returned.

Example:

await Synerise.client.confirmPhoneUpdate(phone, confirmationCode, smsAgreement, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});

Declaration:

Future<void> confirmPhoneUpdate(String phone, String confirmationCode, bool smsAgreement) async

Parameters:

Parameter	Type	Mandatory	Description
phone	String	yes	New phone number
confirmationCode	String	yes	A confirmation code received by a text message
smsAgreement	bool	yes	Agreement for sending SMS to the provided number

Return Value:
No value is returned.

Example:

await Synerise.client.confirmPhoneUpdate(phone, confirmationCode, true).catchError((error) {