model_bank_interface.go

/*
 * finAPI Access (with deprecation)
 *
 * <strong>RESTful API for Account Information Services (AIS) and Payment Initiation Services (PIS)</strong>  The following pages give you some general information on how to use our APIs.<br/> The actual API services documentation then follows further below. You can use the menu to jump between API sections. <br/> <br/> This page has a built-in HTTP(S) client, so you can test the services directly from within this page, by filling in the request parameters and/or body in the respective services, and then hitting the TRY button. Note that you need to be authorized to make a successful API call. To authorize, refer to the 'Authorization' section of the API, or just use the OAUTH button that can be found near the TRY button. <br/>  <h2 id=\"general-information\">General information</h2>  <h3 id=\"general-error-responses\"><strong>Error Responses</strong></h3> When an API call returns with an error, then in general it has the structure shown in the following example:  <pre> {   \"errors\": [     {       \"message\": \"Interface 'FINTS_SERVER' is not supported for this operation.\",       \"code\": \"BAD_REQUEST\",       \"type\": \"TECHNICAL\"     }   ],   \"date\": \"2020-11-19 16:54:06.854\",   \"requestId\": \"selfgen-312042e7-df55-47e4-bffd-956a68ef37b5\",   \"endpoint\": \"POST /api/v1/bankConnections/import\",   \"authContext\": \"1/21\",   \"bank\": \"DEMO0002 - finAPI Test Redirect Bank\" } </pre>  If an API call requires an additional authentication by the user, HTTP code 510 is returned and the error response contains the additional \"multiStepAuthentication\" object, see the following example:  <pre> {   \"errors\": [     {       \"message\": \"Es ist eine zusätzliche Authentifizierung erforderlich. Bitte geben Sie folgenden Code an: 123456\",       \"code\": \"ADDITIONAL_AUTHENTICATION_REQUIRED\",       \"type\": \"BUSINESS\",       \"multiStepAuthentication\": {         \"hash\": \"678b13f4be9ed7d981a840af8131223a\",         \"status\": \"CHALLENGE_RESPONSE_REQUIRED\",         \"challengeMessage\": \"Es ist eine zusätzliche Authentifizierung erforderlich. Bitte geben Sie folgenden Code an: 123456\",         \"answerFieldLabel\": \"TAN\",         \"redirectUrl\": null,         \"redirectContext\": null,         \"redirectContextField\": null,         \"twoStepProcedures\": null,         \"photoTanMimeType\": null,         \"photoTanData\": null,         \"opticalData\": null       }     }   ],   \"date\": \"2019-11-29 09:51:55.931\",   \"requestId\": \"selfgen-45059c99-1b14-4df7-9bd3-9d5f126df294\",   \"endpoint\": \"POST /api/v1/bankConnections/import\",   \"authContext\": \"1/18\",   \"bank\": \"DEMO0001 - finAPI Test Bank\" } </pre>  An exception to this error format are API authentication errors, where the following structure is returned:  <pre> {   \"error\": \"invalid_token\",   \"error_description\": \"Invalid access token: cccbce46-xxxx-xxxx-xxxx-xxxxxxxxxx\" } </pre>  <h3 id=\"general-paging\"><strong>Paging</strong></h3> API services that may potentially return a lot of data implement paging. They return a limited number of entries within a \"page\". Further entries must be fetched with subsequent calls. <br/><br/> Any API service that implements paging provides the following input parameters:<br/> &bull; \"page\": the number of the page to be retrieved (starting with 1).<br/> &bull; \"perPage\": the number of entries within a page. The default and maximum value is stated in the documentation of the respective services.  A paged response contains an additional \"paging\" object with the following structure:  <pre> {   ...   ,   \"paging\": {     \"page\": 1,     \"perPage\": 20,     \"pageCount\": 234,     \"totalCount\": 4662   } } </pre>  <h3 id=\"general-internationalization\"><strong>Internationalization</strong></h3> The finAPI services support internationalization which means you can define the language you prefer for API service responses. <br/><br/> The following languages are available: German, English, Czech, Slovak. <br/><br/> The preferred language can be defined by providing the official HTTP <strong>Accept-Language</strong> header. <br/><br/> finAPI reacts on the official iso language codes &quot;de&quot;, &quot;en&quot;, &quot;cs&quot; and &quot;sk&quot; for the named languages. Additional subtags supported by the Accept-Language header may be provided, e.g. &quot;en-US&quot;, but are ignored. <br/> If no Accept-Language header is given, German is used as the default language. <br/><br/> Exceptions:<br/> &bull; Bank login hints and login fields are only available in the language of the bank and not being translated.<br/> &bull; Direct messages from the bank systems typically returned as BUSINESS errors will not be translated.<br/> &bull; BUSINESS errors created by finAPI directly are available in German and English.<br/> &bull; TECHNICAL errors messages meant for developers are mostly in English, but also may be translated.  <h3 id=\"general-request-ids\"><strong>Request IDs</strong></h3> With any API call, you can pass a request ID via a header with name \"X-Request-Id\". The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. <br/><br/> If you don't pass a request ID for a call, finAPI will generate a random ID internally. <br/><br/> The request ID is always returned back in the response of a service, as a header with name \"X-Request-Id\". <br/><br/> We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.  <h3 id=\"general-overriding-http-methods\"><strong>Overriding HTTP methods</strong></h3> Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with a special HTTP header indicating the originally intended HTTP method. <br/><br/> The header's name is <strong>X-HTTP-Method-Override</strong>. Set its value to either <strong>PATCH</strong> or <strong>DELETE</strong>. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. <br/><br/> Example: <br/><br/> <strong>X-HTTP-Method-Override: PATCH</strong><br/> POST /api/v1/label/51<br/> {\"name\": \"changed label\"}<br/><br/> will be interpreted by finAPI as:<br/><br/> PATCH /api/v1/label/51<br/> {\"name\": \"changed label\"}<br/>  <h3 id=\"general-user-metadata\"><strong>User metadata</strong></h3> With the migration to PSD2 APIs, a new term called \"User metadata\" (also known as \"PSU metadata\") has been introduced to the API. This user metadata aims to inform the banking API if there was a real end-user behind an HTTP request or if the request was triggered by a system (e.g. by an automatic batch update). In the latter case, the bank may apply some restrictions such as limiting the number of HTTP requests for a single consent. Also, some operations may be forbidden entirely by the banking API. For example, some banks do not allow issuing a new consent without the end-user being involved. Therefore, it is certainly necessary and obligatory for the customer to provide the PSU metadata for such operations. <br/><br/> As finAPI does not have direct interaction with the end-user, it is the client application's responsibility to provide all the necessary information about the end-user. This must be done by sending additional headers with every request triggered on behalf of the end-user. <br/><br/> At the moment, the following headers are supported by the API:<br/> &bull; \"PSU-IP-Address\" - the IP address of the user's device.<br/> &bull; \"PSU-Device-OS\" - the user's device and/or operating system identification.<br/> &bull; \"PSU-User-Agent\" - the user's web browser or other client device identification.  <h3 id=\"general-faq\"><strong>FAQ</strong></h3> <strong>Is there a finAPI SDK?</strong> <br/> Currently we do not offer a native SDK, but there is the option to generate an SDK for almost any target language via OpenAPI. Use the 'Download SDK' button on this page for SDK generation. <br/> <br/> <strong>How can I enable finAPI's automatic batch update?</strong> <br/> Currently there is no way to set up the batch update via the API. Please contact support@finapi.io for this. <br/> <br/> <strong>Why do I need to keep authorizing when calling services on this page?</strong> <br/> This page is a \"one-page-app\". Reloading the page resets the OAuth authorization context. There is generally no need to reload the page, so just don't do it and your authorization will persist. 
 *
 * API version: 1.151.1
 * Contact: kontakt@finapi.io
 */

// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.

package finapi

import (
	"encoding/json"
)

// BankInterface Interface used to connect to a bank
type BankInterface struct {
	// <strong>Type:</strong> BankingInterface<br/> Bank interface. Possible values:<br><br>&bull; <code>WEB_SCRAPER</code> - means that finAPI will parse data from the bank's online banking website.<br>&bull; <code>FINTS_SERVER</code> - means that finAPI will download data via the bank's FinTS server.<br>&bull; <code>XS2A</code> - means that finAPI will download data via the bank's XS2A interface.<br>
	Interface BankingInterface `json:"interface"`
	// <strong>Type:</strong> TppAuthenticationGroup<br/> TPP Authentication Group which the bank interface is connected to
	TppAuthenticationGroup NullableTppAuthenticationGroup `json:"tppAuthenticationGroup"`
	// <strong>Type:</strong> BankInterfaceLoginField<br/> Login fields for this interface (in the order that we suggest to show them to the user)
	LoginCredentials []BankInterfaceLoginField `json:"loginCredentials"`
	Properties []BankInterfaceProperty `json:"properties"`
	// Login hint. Contains a German message for the user that explains what kind of credentials are expected.<br/><br/>Please note that it is essential to always show the login hint to the user if there is one, as the credentials that finAPI requires for the bank might be different to the credentials that the user knows from his online banking.<br/><br/>Also note that the contents of this field should always be interpreted as HTML, as the text might contain HTML tags for highlighted words, paragraphs, etc.
	LoginHint NullableString `json:"loginHint"`
	// The health status of this interface. This is a value between 0 and 100, depicting the percentage of successful communication attempts with the bank via this interface during the latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' means that there was no technical error trying to establish a communication with the bank. Non-technical errors (like incorrect credentials) are regarded successful communication attempts.
	Health int32 `json:"health"`
	// Time of the last communication attempt with this interface during an import, update or connect interface (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time).
	LastCommunicationAttempt NullableString `json:"lastCommunicationAttempt"`
	// Time of the last successful communication with this interface during an import, update or connect interface (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time).
	LastSuccessfulCommunication NullableString `json:"lastSuccessfulCommunication"`
	// THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'paymentCapabilities' instead.<br/><br/>Whether this interface has the general capability to do money transfers.<br/><br/>Note: It still depends on the specifics of an account whether the account supports money transfer. In general, you should prefer the field AccountInterface.capabilities to determine what is possible for a specific account. This field here is meant to be used mainly for when you want to do standalone money transfers (finAPI Payment product), i.e. when you do not plan to import an account and thus will not have the information about the account's capabilities.
	IsMoneyTransferSupported bool `json:"isMoneyTransferSupported"`
	// Whether this interface has the general capability to perform Account Information Services (AIS), i.e. if this interface can be used to download accounts, balances and transactions. 
	IsAisSupported bool `json:"isAisSupported"`
	// <strong>Type:</strong> BankInterfacePaymentCapabilities<br/> The general payment capabilities of this interface. If a capability is 'true', it means that the option is supported, as long as the involved account also supports it (see AccountInterface.capabilities and AccountInterface.paymentCapabilities). If a capability is 'false', the option is not supported for any account.
	PaymentCapabilities BankInterfacePaymentCapabilities `json:"paymentCapabilities"`
	AisAccountTypes []AccountType `json:"aisAccountTypes"`
}

// NewBankInterface instantiates a new BankInterface 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
func NewBankInterface(interface_ BankingInterface, tppAuthenticationGroup NullableTppAuthenticationGroup, loginCredentials []BankInterfaceLoginField, properties []BankInterfaceProperty, loginHint NullableString, health int32, lastCommunicationAttempt NullableString, lastSuccessfulCommunication NullableString, isMoneyTransferSupported bool, isAisSupported bool, paymentCapabilities BankInterfacePaymentCapabilities, aisAccountTypes []AccountType, ) *BankInterface {
	this := BankInterface{}
	this.Interface = interface_
	this.TppAuthenticationGroup = tppAuthenticationGroup
	this.LoginCredentials = loginCredentials
	this.Properties = properties
	this.LoginHint = loginHint
	this.Health = health
	this.LastCommunicationAttempt = lastCommunicationAttempt
	this.LastSuccessfulCommunication = lastSuccessfulCommunication
	this.IsMoneyTransferSupported = isMoneyTransferSupported
	this.IsAisSupported = isAisSupported
	this.PaymentCapabilities = paymentCapabilities
	this.AisAccountTypes = aisAccountTypes
	return &this
}

// NewBankInterfaceWithDefaults instantiates a new BankInterface 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
func NewBankInterfaceWithDefaults() *BankInterface {
	this := BankInterface{}
	return &this
}

// GetInterface returns the Interface field value
func (o *BankInterface) GetInterface() BankingInterface {
	if o == nil  {
		var ret BankingInterface
		return ret
	}

	return o.Interface
}

// GetInterfaceOk returns a tuple with the Interface field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetInterfaceOk() (*BankingInterface, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.Interface, true
}

// SetInterface sets field value
func (o *BankInterface) SetInterface(v BankingInterface) {
	o.Interface = v
}

// GetTppAuthenticationGroup returns the TppAuthenticationGroup field value
// If the value is explicit nil, the zero value for TppAuthenticationGroup will be returned
func (o *BankInterface) GetTppAuthenticationGroup() TppAuthenticationGroup {
	if o == nil || o.TppAuthenticationGroup.Get() == nil {
		var ret TppAuthenticationGroup
		return ret
	}

	return *o.TppAuthenticationGroup.Get()
}

// GetTppAuthenticationGroupOk returns a tuple with the TppAuthenticationGroup field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *BankInterface) GetTppAuthenticationGroupOk() (*TppAuthenticationGroup, bool) {
	if o == nil  {
		return nil, false
	}
	return o.TppAuthenticationGroup.Get(), o.TppAuthenticationGroup.IsSet()
}

// SetTppAuthenticationGroup sets field value
func (o *BankInterface) SetTppAuthenticationGroup(v TppAuthenticationGroup) {
	o.TppAuthenticationGroup.Set(&v)
}

// GetLoginCredentials returns the LoginCredentials field value
func (o *BankInterface) GetLoginCredentials() []BankInterfaceLoginField {
	if o == nil  {
		var ret []BankInterfaceLoginField
		return ret
	}

	return o.LoginCredentials
}

// GetLoginCredentialsOk returns a tuple with the LoginCredentials field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetLoginCredentialsOk() (*[]BankInterfaceLoginField, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.LoginCredentials, true
}

// SetLoginCredentials sets field value
func (o *BankInterface) SetLoginCredentials(v []BankInterfaceLoginField) {
	o.LoginCredentials = v
}

// GetProperties returns the Properties field value
func (o *BankInterface) GetProperties() []BankInterfaceProperty {
	if o == nil  {
		var ret []BankInterfaceProperty
		return ret
	}

	return o.Properties
}

// GetPropertiesOk returns a tuple with the Properties field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetPropertiesOk() (*[]BankInterfaceProperty, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.Properties, true
}

// SetProperties sets field value
func (o *BankInterface) SetProperties(v []BankInterfaceProperty) {
	o.Properties = v
}

// GetLoginHint returns the LoginHint field value
// If the value is explicit nil, the zero value for string will be returned
func (o *BankInterface) GetLoginHint() string {
	if o == nil || o.LoginHint.Get() == nil {
		var ret string
		return ret
	}

	return *o.LoginHint.Get()
}

// GetLoginHintOk returns a tuple with the LoginHint field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *BankInterface) GetLoginHintOk() (*string, bool) {
	if o == nil  {
		return nil, false
	}
	return o.LoginHint.Get(), o.LoginHint.IsSet()
}

// SetLoginHint sets field value
func (o *BankInterface) SetLoginHint(v string) {
	o.LoginHint.Set(&v)
}

// GetHealth returns the Health field value
func (o *BankInterface) GetHealth() int32 {
	if o == nil  {
		var ret int32
		return ret
	}

	return o.Health
}

// GetHealthOk returns a tuple with the Health field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetHealthOk() (*int32, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.Health, true
}

// SetHealth sets field value
func (o *BankInterface) SetHealth(v int32) {
	o.Health = v
}

// GetLastCommunicationAttempt returns the LastCommunicationAttempt field value
// If the value is explicit nil, the zero value for string will be returned
func (o *BankInterface) GetLastCommunicationAttempt() string {
	if o == nil || o.LastCommunicationAttempt.Get() == nil {
		var ret string
		return ret
	}

	return *o.LastCommunicationAttempt.Get()
}

// GetLastCommunicationAttemptOk returns a tuple with the LastCommunicationAttempt field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *BankInterface) GetLastCommunicationAttemptOk() (*string, bool) {
	if o == nil  {
		return nil, false
	}
	return o.LastCommunicationAttempt.Get(), o.LastCommunicationAttempt.IsSet()
}

// SetLastCommunicationAttempt sets field value
func (o *BankInterface) SetLastCommunicationAttempt(v string) {
	o.LastCommunicationAttempt.Set(&v)
}

// GetLastSuccessfulCommunication returns the LastSuccessfulCommunication field value
// If the value is explicit nil, the zero value for string will be returned
func (o *BankInterface) GetLastSuccessfulCommunication() string {
	if o == nil || o.LastSuccessfulCommunication.Get() == nil {
		var ret string
		return ret
	}

	return *o.LastSuccessfulCommunication.Get()
}

// GetLastSuccessfulCommunicationOk returns a tuple with the LastSuccessfulCommunication field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *BankInterface) GetLastSuccessfulCommunicationOk() (*string, bool) {
	if o == nil  {
		return nil, false
	}
	return o.LastSuccessfulCommunication.Get(), o.LastSuccessfulCommunication.IsSet()
}

// SetLastSuccessfulCommunication sets field value
func (o *BankInterface) SetLastSuccessfulCommunication(v string) {
	o.LastSuccessfulCommunication.Set(&v)
}

// GetIsMoneyTransferSupported returns the IsMoneyTransferSupported field value
func (o *BankInterface) GetIsMoneyTransferSupported() bool {
	if o == nil  {
		var ret bool
		return ret
	}

	return o.IsMoneyTransferSupported
}

// GetIsMoneyTransferSupportedOk returns a tuple with the IsMoneyTransferSupported field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetIsMoneyTransferSupportedOk() (*bool, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.IsMoneyTransferSupported, true
}

// SetIsMoneyTransferSupported sets field value
func (o *BankInterface) SetIsMoneyTransferSupported(v bool) {
	o.IsMoneyTransferSupported = v
}

// GetIsAisSupported returns the IsAisSupported field value
func (o *BankInterface) GetIsAisSupported() bool {
	if o == nil  {
		var ret bool
		return ret
	}

	return o.IsAisSupported
}

// GetIsAisSupportedOk returns a tuple with the IsAisSupported field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetIsAisSupportedOk() (*bool, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.IsAisSupported, true
}

// SetIsAisSupported sets field value
func (o *BankInterface) SetIsAisSupported(v bool) {
	o.IsAisSupported = v
}

// GetPaymentCapabilities returns the PaymentCapabilities field value
func (o *BankInterface) GetPaymentCapabilities() BankInterfacePaymentCapabilities {
	if o == nil  {
		var ret BankInterfacePaymentCapabilities
		return ret
	}

	return o.PaymentCapabilities
}

// GetPaymentCapabilitiesOk returns a tuple with the PaymentCapabilities field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetPaymentCapabilitiesOk() (*BankInterfacePaymentCapabilities, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.PaymentCapabilities, true
}

// SetPaymentCapabilities sets field value
func (o *BankInterface) SetPaymentCapabilities(v BankInterfacePaymentCapabilities) {
	o.PaymentCapabilities = v
}

// GetAisAccountTypes returns the AisAccountTypes field value
func (o *BankInterface) GetAisAccountTypes() []AccountType {
	if o == nil  {
		var ret []AccountType
		return ret
	}

	return o.AisAccountTypes
}

// GetAisAccountTypesOk returns a tuple with the AisAccountTypes field value
// and a boolean to check if the value has been set.
func (o *BankInterface) GetAisAccountTypesOk() (*[]AccountType, bool) {
	if o == nil  {
		return nil, false
	}
	return &o.AisAccountTypes, true
}

// SetAisAccountTypes sets field value
func (o *BankInterface) SetAisAccountTypes(v []AccountType) {
	o.AisAccountTypes = v
}

func (o BankInterface) MarshalJSON() ([]byte, error) {
	toSerialize := map[string]interface{}{}
	if true {
		toSerialize["interface"] = o.Interface
	}
	if true {
		toSerialize["tppAuthenticationGroup"] = o.TppAuthenticationGroup.Get()
	}
	if true {
		toSerialize["loginCredentials"] = o.LoginCredentials
	}
	if true {
		toSerialize["properties"] = o.Properties
	}
	if true {
		toSerialize["loginHint"] = o.LoginHint.Get()
	}
	if true {
		toSerialize["health"] = o.Health
	}
	if true {
		toSerialize["lastCommunicationAttempt"] = o.LastCommunicationAttempt.Get()
	}
	if true {
		toSerialize["lastSuccessfulCommunication"] = o.LastSuccessfulCommunication.Get()
	}
	if true {
		toSerialize["isMoneyTransferSupported"] = o.IsMoneyTransferSupported
	}
	if true {
		toSerialize["isAisSupported"] = o.IsAisSupported
	}
	if true {
		toSerialize["paymentCapabilities"] = o.PaymentCapabilities
	}
	if true {
		toSerialize["aisAccountTypes"] = o.AisAccountTypes
	}
	return json.Marshal(toSerialize)
}

type NullableBankInterface struct {
	value *BankInterface
	isSet bool
}

func (v NullableBankInterface) Get() *BankInterface {
	return v.value
}

func (v *NullableBankInterface) Set(val *BankInterface) {
	v.value = val
	v.isSet = true
}

func (v NullableBankInterface) IsSet() bool {
	return v.isSet
}

func (v *NullableBankInterface) Unset() {
	v.value = nil
	v.isSet = false
}

func NewNullableBankInterface(val *BankInterface) *NullableBankInterface {
	return &NullableBankInterface{value: val, isSet: true}
}

func (v NullableBankInterface) MarshalJSON() ([]byte, error) {
	return json.Marshal(v.value)
}

func (v *NullableBankInterface) UnmarshalJSON(src []byte) error {
	v.isSet = true
	return json.Unmarshal(src, &v.value)
}