Skip to content

Latest commit

 

History

History
155 lines (84 loc) · 5.69 KB

User.md

File metadata and controls

155 lines (84 loc) · 5.69 KB

User

Properties

Name Type Description Notes
Id string User identifier
Password string User's password. Please note that some services may return a distorted password (always 'XXXXX'). See the documentation of individual services to find out whether the password is returned as plain text or as 'XXXXX'.
Email NullableString User's email address
Phone NullableString User's phone number
IsAutoUpdateEnabled bool Whether the user's bank connections will get updated in the course of finAPI's automatic batch update. Note that the automatic batch update will only update bank connections where all of the following applies:<br><br> - a valid consent exists OR the PIN is stored in finAPI for the bank connection, and the related bank does not have volatile PINs (see the 'isVolatile' flag of the 'loginCredentials')<br/> - the user has accepted the latest Terms and Conditions (this only applies to users whose mandator doesn't have an AIS license)<br> - the bank connection interface flag 'userActionRequired' has to be false<br> - the previous update using the stored credentials did not fail due to the credentials being incorrect (or there was no previous update with the stored credentials)<br> - the bank that the bank connection relates to is included in the automatic batch update (please contact your Sys-Admin for details about the batch update configuration)<br>- at least one of the bank's supported data sources can be used by finAPI for your client (i.e.: if a bank supports only web scraping, but web scraping is disabled for your client, then bank connections of that bank will not get updated by the automatic batch update)<br><br>Also note that the automatic batch update must generally be enabled for your client for this field to have any effect.<br/><br/>WARNING: The automatic update will always download transactions and security positions for any account that it updates, even if the account was previously imported or updated with 'skipPositionsDownload' = true.

Methods

NewUser

func NewUser(id string, password string, email NullableString, phone NullableString, isAutoUpdateEnabled bool, ) *User

NewUser instantiates a new User object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewUserWithDefaults

func NewUserWithDefaults() *User

NewUserWithDefaults instantiates a new User object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetId

func (o *User) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *User) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *User) SetId(v string)

SetId sets Id field to given value.

GetPassword

func (o *User) GetPassword() string

GetPassword returns the Password field if non-nil, zero value otherwise.

GetPasswordOk

func (o *User) GetPasswordOk() (*string, bool)

GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPassword

func (o *User) SetPassword(v string)

SetPassword sets Password field to given value.

GetEmail

func (o *User) GetEmail() string

GetEmail returns the Email field if non-nil, zero value otherwise.

GetEmailOk

func (o *User) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEmail

func (o *User) SetEmail(v string)

SetEmail sets Email field to given value.

SetEmailNil

func (o *User) SetEmailNil(b bool)

SetEmailNil sets the value for Email to be an explicit nil

UnsetEmail

func (o *User) UnsetEmail()

UnsetEmail ensures that no value is present for Email, not even an explicit nil

GetPhone

func (o *User) GetPhone() string

GetPhone returns the Phone field if non-nil, zero value otherwise.

GetPhoneOk

func (o *User) GetPhoneOk() (*string, bool)

GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPhone

func (o *User) SetPhone(v string)

SetPhone sets Phone field to given value.

SetPhoneNil

func (o *User) SetPhoneNil(b bool)

SetPhoneNil sets the value for Phone to be an explicit nil

UnsetPhone

func (o *User) UnsetPhone()

UnsetPhone ensures that no value is present for Phone, not even an explicit nil

GetIsAutoUpdateEnabled

func (o *User) GetIsAutoUpdateEnabled() bool

GetIsAutoUpdateEnabled returns the IsAutoUpdateEnabled field if non-nil, zero value otherwise.

GetIsAutoUpdateEnabledOk

func (o *User) GetIsAutoUpdateEnabledOk() (*bool, bool)

GetIsAutoUpdateEnabledOk returns a tuple with the IsAutoUpdateEnabled field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIsAutoUpdateEnabled

func (o *User) SetIsAutoUpdateEnabled(v bool)

SetIsAutoUpdateEnabled sets IsAutoUpdateEnabled field to given value.

[Back to Model list] [Back to API list] [Back to README]