Package com.blockchyp.client.dto

Class InviteMerchantUserRequest

java.lang.Object
com.blockchyp.client.dto.InviteMerchantUserRequest
All Implemented Interfaces:
ICoreRequest, ITimeoutRequest
public class InviteMerchantUserRequest extends Object implements ITimeoutRequest, ICoreRequest
Models a request for adding a new user to a merchant account.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InviteMerchantUserRequest()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addRole(String value)
    Adds a an optional array of role codes that will be assigned to the user.
    String
    getDestinationAccount()
    Gets the settlement account for merchants with split settlements.
    String
    getEmail()
    Gets the email address of the user.
    String
    getFirstName()
    Gets the first name of the new user.
    String
    getLastName()
    Gets the last name of the new user.
    String
    getMerchantId()
    Gets the merchant id.
    String
    getOrderRef()
    Gets an identifier from an external point of sale system.
    Collection<String>
    getRoles()
    Gets an optional array of role codes that will be assigned to the user.
    String
    getTestCase()
    Gets can include a code used to trigger simulated conditions for the purposes of testing and certification.
    int
    getTimeout()
    Gets the request timeout in seconds.
    String
    getTransactionRef()
    Gets a user-assigned reference that can be used to recall or reverse transactions.
    boolean
    isAsync()
    Gets defers the response to the transaction and returns immediately.
    boolean
    isAutogeneratedRef()
    Gets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
    boolean
    isForce()
    Gets override any in-progress transactions.
    boolean
    isQueue()
    Gets adds the transaction to the queue and returns immediately.
    boolean
    isTest()
    Gets whether or not to route transaction to the test gateway.
    boolean
    isWaitForRemovedCard()
    Gets whether or not the request should block until all cards have been removed from the card reader.
    void
    setAsync(boolean value)
    Sets defers the response to the transaction and returns immediately.
    void
    setAutogeneratedRef(boolean value)
    Sets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
    void
    setDestinationAccount(String value)
    Sets the settlement account for merchants with split settlements.
    void
    setEmail(String value)
    Sets the email address of the user.
    void
    setFirstName(String value)
    Sets the first name of the new user.
    void
    setForce(boolean value)
    Sets override any in-progress transactions.
    void
    setLastName(String value)
    Sets the last name of the new user.
    void
    setMerchantId(String value)
    Sets the merchant id.
    void
    setOrderRef(String value)
    Sets an identifier from an external point of sale system.
    void
    setQueue(boolean value)
    Sets adds the transaction to the queue and returns immediately.
    void
    setRoles(Collection<String> value)
    Sets an optional array of role codes that will be assigned to the user.
    void
    setTest(boolean value)
    Sets whether or not to route transaction to the test gateway.
    void
    setTestCase(String value)
    Sets can include a code used to trigger simulated conditions for the purposes of testing and certification.
    void
    setTimeout(int value)
    Sets the request timeout in seconds.
    void
    setTransactionRef(String value)
    Sets a user-assigned reference that can be used to recall or reverse transactions.
    void
    setWaitForRemovedCard(boolean value)
    Sets whether or not the request should block until all cards have been removed from the card reader.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • InviteMerchantUserRequest

      public InviteMerchantUserRequest()

  • Method Details

    • setTimeout

      public void setTimeout(int value)
      Sets the request timeout in seconds.
      Parameters:
      value - the request timeout in seconds.

    • getTimeout

      public int getTimeout()
      Gets the request timeout in seconds.
      Specified by:
      getTimeout in interface ITimeoutRequest
      Returns:
      the request timeout in seconds.

    • setTest

      public void setTest(boolean value)
      Sets whether or not to route transaction to the test gateway.
      Parameters:
      value - whether or not to route transaction to the test gateway.

    • isTest

      public boolean isTest()
      Gets whether or not to route transaction to the test gateway.
      Specified by:
      isTest in interface ITimeoutRequest
      Returns:
      whether or not to route transaction to the test gateway.

    • setTransactionRef

      public void setTransactionRef(String value)
      Sets a user-assigned reference that can be used to recall or reverse transactions.
      Parameters:
      value - a user-assigned reference that can be used to recall or reverse transactions.

    • getTransactionRef

      public String getTransactionRef()
      Gets a user-assigned reference that can be used to recall or reverse transactions.
      Specified by:
      getTransactionRef in interface ICoreRequest
      Returns:
      a user-assigned reference that can be used to recall or reverse transactions.

    • setAutogeneratedRef

      public void setAutogeneratedRef(boolean value)
      Sets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
      Parameters:
      value - that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.

    • isAutogeneratedRef

      public boolean isAutogeneratedRef()
      Gets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
      Specified by:
      isAutogeneratedRef in interface ICoreRequest
      Returns:
      that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.

    • setAsync

      public void setAsync(boolean value)
      Sets defers the response to the transaction and returns immediately.
      Parameters:
      value - defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • isAsync

      public boolean isAsync()
      Gets defers the response to the transaction and returns immediately.
      Specified by:
      isAsync in interface ICoreRequest
      Returns:
      defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • setQueue

      public void setQueue(boolean value)
      Sets adds the transaction to the queue and returns immediately.
      Parameters:
      value - adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • isQueue

      public boolean isQueue()
      Gets adds the transaction to the queue and returns immediately.
      Specified by:
      isQueue in interface ICoreRequest
      Returns:
      adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • setWaitForRemovedCard

      public void setWaitForRemovedCard(boolean value)
      Sets whether or not the request should block until all cards have been removed from the card reader.
      Parameters:
      value - whether or not the request should block until all cards have been removed from the card reader.

    • isWaitForRemovedCard

      public boolean isWaitForRemovedCard()
      Gets whether or not the request should block until all cards have been removed from the card reader.
      Specified by:
      isWaitForRemovedCard in interface ICoreRequest
      Returns:
      whether or not the request should block until all cards have been removed from the card reader.

    • setForce

      public void setForce(boolean value)
      Sets override any in-progress transactions.
      Parameters:
      value - override any in-progress transactions.

    • isForce

      public boolean isForce()
      Gets override any in-progress transactions.
      Specified by:
      isForce in interface ICoreRequest
      Returns:
      override any in-progress transactions.

    • setOrderRef

      public void setOrderRef(String value)
      Sets an identifier from an external point of sale system.
      Parameters:
      value - an identifier from an external point of sale system.

    • getOrderRef

      public String getOrderRef()
      Gets an identifier from an external point of sale system.
      Specified by:
      getOrderRef in interface ICoreRequest
      Returns:
      an identifier from an external point of sale system.

    • setDestinationAccount

      public void setDestinationAccount(String value)
      Sets the settlement account for merchants with split settlements.
      Parameters:
      value - the settlement account for merchants with split settlements.

    • getDestinationAccount

      public String getDestinationAccount()
      Gets the settlement account for merchants with split settlements.
      Specified by:
      getDestinationAccount in interface ICoreRequest
      Returns:
      the settlement account for merchants with split settlements.

    • setTestCase

      public void setTestCase(String value)
      Sets can include a code used to trigger simulated conditions for the purposes of testing and certification.
      Parameters:
      value - can include a code used to trigger simulated conditions for the purposes of testing and certification. Valid for test merchant accounts only.

    • getTestCase

      public String getTestCase()
      Gets can include a code used to trigger simulated conditions for the purposes of testing and certification.
      Specified by:
      getTestCase in interface ICoreRequest
      Returns:
      can include a code used to trigger simulated conditions for the purposes of testing and certification. Valid for test merchant accounts only.

    • setMerchantId

      public void setMerchantId(String value)
      Sets the merchant id.
      Parameters:
      value - the merchant id. Optional for merchant scoped requests.

    • getMerchantId

      public String getMerchantId()
      Gets the merchant id.
      Returns:
      the merchant id. Optional for merchant scoped requests.

    • setEmail

      public void setEmail(String value)
      Sets the email address of the user.
      Parameters:
      value - the email address of the user.

    • getEmail

      public String getEmail()
      Gets the email address of the user.
      Returns:
      the email address of the user.

    • setFirstName

      public void setFirstName(String value)
      Sets the first name of the new user.
      Parameters:
      value - the first name of the new user.

    • getFirstName

      public String getFirstName()
      Gets the first name of the new user.
      Returns:
      the first name of the new user.

    • setLastName

      public void setLastName(String value)
      Sets the last name of the new user.
      Parameters:
      value - the last name of the new user.

    • getLastName

      public String getLastName()
      Gets the last name of the new user.
      Returns:
      the last name of the new user.

    • setRoles

      public void setRoles(Collection<String> value)
      Sets an optional array of role codes that will be assigned to the user.
      Parameters:
      value - an optional array of role codes that will be assigned to the user. If omitted defaults to the default merchant role.

    • getRoles

      public Collection<String> getRoles()
      Gets an optional array of role codes that will be assigned to the user.
      Returns:
      an optional array of role codes that will be assigned to the user. If omitted defaults to the default merchant role.

    • addRole

      public void addRole(String value)
      Adds a an optional array of role codes that will be assigned to the user.
      Parameters:
      value - an optional array of role codes that will be assigned to the user. If omitted defaults to the default merchant role.