model_address_shared.go

/*
Onfido API v3.6

The Onfido API (v3.6)

API version: v3.6
*/

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

package openapi

import (
	"encoding/json"
	"bytes"
	"fmt"
)

// checks if the AddressShared type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &AddressShared{}

// AddressShared struct for AddressShared
type AddressShared struct {
	// The flat number of this address
	FlatNumber *string `json:"flat_number,omitempty"`
	// The building number of this address
	BuildingNumber *string `json:"building_number,omitempty"`
	// The building name of this address
	BuildingName *string `json:"building_name,omitempty"`
	// The street of the applicant's address
	Street *string `json:"street,omitempty"`
	// The sub-street of the applicant's address
	SubStreet *string `json:"sub_street,omitempty"`
	// The town of the applicant's address
	Town *string `json:"town,omitempty"`
	// The postcode or ZIP of the applicant's address
	Postcode string `json:"postcode"`
	// The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
	Country CountryCodes `json:"country"`
	// The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
	State *string `json:"state,omitempty"`
	// Line 1 of the applicant's address
	Line1 NullableString `json:"line1,omitempty" validate:"regexp=^[^!$%^*=<>]*$"`
	// Line 2 of the applicant's address
	Line2 NullableString `json:"line2,omitempty" validate:"regexp=^[^!$%^*=<>]*$"`
	// Line 3 of the applicant's address
	Line3 NullableString `json:"line3,omitempty" validate:"regexp=^[^!$%^*=<>]*$"`
}

type _AddressShared AddressShared

// NewAddressShared instantiates a new AddressShared 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 NewAddressShared(postcode string, country CountryCodes) *AddressShared {
	this := AddressShared{}
	this.Postcode = postcode
	this.Country = country
	return &this
}

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

// GetFlatNumber returns the FlatNumber field value if set, zero value otherwise.
func (o *AddressShared) GetFlatNumber() string {
	if o == nil || IsNil(o.FlatNumber) {
		var ret string
		return ret
	}
	return *o.FlatNumber
}

// GetFlatNumberOk returns a tuple with the FlatNumber field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AddressShared) GetFlatNumberOk() (*string, bool) {
	if o == nil || IsNil(o.FlatNumber) {
		return nil, false
	}
	return o.FlatNumber, true
}

// HasFlatNumber returns a boolean if a field has been set.
func (o *AddressShared) HasFlatNumber() bool {
	if o != nil && !IsNil(o.FlatNumber) {
		return true
	}

	return false
}

// SetFlatNumber gets a reference to the given string and assigns it to the FlatNumber field.
func (o *AddressShared) SetFlatNumber(v string) {
	o.FlatNumber = &v
}

// GetBuildingNumber returns the BuildingNumber field value if set, zero value otherwise.
func (o *AddressShared) GetBuildingNumber() string {
	if o == nil || IsNil(o.BuildingNumber) {
		var ret string
		return ret
	}
	return *o.BuildingNumber
}

// GetBuildingNumberOk returns a tuple with the BuildingNumber field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AddressShared) GetBuildingNumberOk() (*string, bool) {
	if o == nil || IsNil(o.BuildingNumber) {
		return nil, false
	}
	return o.BuildingNumber, true
}

// HasBuildingNumber returns a boolean if a field has been set.
func (o *AddressShared) HasBuildingNumber() bool {
	if o != nil && !IsNil(o.BuildingNumber) {
		return true
	}

	return false
}

// SetBuildingNumber gets a reference to the given string and assigns it to the BuildingNumber field.
func (o *AddressShared) SetBuildingNumber(v string) {
	o.BuildingNumber = &v
}

// GetBuildingName returns the BuildingName field value if set, zero value otherwise.
func (o *AddressShared) GetBuildingName() string {
	if o == nil || IsNil(o.BuildingName) {
		var ret string
		return ret
	}
	return *o.BuildingName
}

// GetBuildingNameOk returns a tuple with the BuildingName field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AddressShared) GetBuildingNameOk() (*string, bool) {
	if o == nil || IsNil(o.BuildingName) {
		return nil, false
	}
	return o.BuildingName, true
}

// HasBuildingName returns a boolean if a field has been set.
func (o *AddressShared) HasBuildingName() bool {
	if o != nil && !IsNil(o.BuildingName) {
		return true
	}

	return false
}

// SetBuildingName gets a reference to the given string and assigns it to the BuildingName field.
func (o *AddressShared) SetBuildingName(v string) {
	o.BuildingName = &v
}

// GetStreet returns the Street field value if set, zero value otherwise.
func (o *AddressShared) GetStreet() string {
	if o == nil || IsNil(o.Street) {
		var ret string
		return ret
	}
	return *o.Street
}

// GetStreetOk returns a tuple with the Street field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AddressShared) GetStreetOk() (*string, bool) {
	if o == nil || IsNil(o.Street) {
		return nil, false
	}
	return o.Street, true
}

// HasStreet returns a boolean if a field has been set.
func (o *AddressShared) HasStreet() bool {
	if o != nil && !IsNil(o.Street) {
		return true
	}

	return false
}

// SetStreet gets a reference to the given string and assigns it to the Street field.
func (o *AddressShared) SetStreet(v string) {
	o.Street = &v
}

// GetSubStreet returns the SubStreet field value if set, zero value otherwise.
func (o *AddressShared) GetSubStreet() string {
	if o == nil || IsNil(o.SubStreet) {
		var ret string
		return ret
	}
	return *o.SubStreet
}

// GetSubStreetOk returns a tuple with the SubStreet field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AddressShared) GetSubStreetOk() (*string, bool) {
	if o == nil || IsNil(o.SubStreet) {
		return nil, false
	}
	return o.SubStreet, true
}

// HasSubStreet returns a boolean if a field has been set.
func (o *AddressShared) HasSubStreet() bool {
	if o != nil && !IsNil(o.SubStreet) {
		return true
	}

	return false
}

// SetSubStreet gets a reference to the given string and assigns it to the SubStreet field.
func (o *AddressShared) SetSubStreet(v string) {
	o.SubStreet = &v
}

// GetTown returns the Town field value if set, zero value otherwise.
func (o *AddressShared) GetTown() string {
	if o == nil || IsNil(o.Town) {
		var ret string
		return ret
	}
	return *o.Town
}

// GetTownOk returns a tuple with the Town field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AddressShared) GetTownOk() (*string, bool) {
	if o == nil || IsNil(o.Town) {
		return nil, false
	}
	return o.Town, true
}

// HasTown returns a boolean if a field has been set.
func (o *AddressShared) HasTown() bool {
	if o != nil && !IsNil(o.Town) {
		return true
	}

	return false
}

// SetTown gets a reference to the given string and assigns it to the Town field.
func (o *AddressShared) SetTown(v string) {
	o.Town = &v
}

// GetPostcode returns the Postcode field value
func (o *AddressShared) GetPostcode() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Postcode
}

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

// SetPostcode sets field value
func (o *AddressShared) SetPostcode(v string) {
	o.Postcode = v
}

// GetCountry returns the Country field value
func (o *AddressShared) GetCountry() CountryCodes {
	if o == nil {
		var ret CountryCodes
		return ret
	}

	return o.Country
}

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

// SetCountry sets field value
func (o *AddressShared) SetCountry(v CountryCodes) {
	o.Country = v
}

// GetState returns the State field value if set, zero value otherwise.
func (o *AddressShared) GetState() string {
	if o == nil || IsNil(o.State) {
		var ret string
		return ret
	}
	return *o.State
}

// GetStateOk returns a tuple with the State field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AddressShared) GetStateOk() (*string, bool) {
	if o == nil || IsNil(o.State) {
		return nil, false
	}
	return o.State, true
}

// HasState returns a boolean if a field has been set.
func (o *AddressShared) HasState() bool {
	if o != nil && !IsNil(o.State) {
		return true
	}

	return false
}

// SetState gets a reference to the given string and assigns it to the State field.
func (o *AddressShared) SetState(v string) {
	o.State = &v
}

// GetLine1 returns the Line1 field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *AddressShared) GetLine1() string {
	if o == nil || IsNil(o.Line1.Get()) {
		var ret string
		return ret
	}
	return *o.Line1.Get()
}

// GetLine1Ok returns a tuple with the Line1 field value if set, nil otherwise
// 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 *AddressShared) GetLine1Ok() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Line1.Get(), o.Line1.IsSet()
}

// HasLine1 returns a boolean if a field has been set.
func (o *AddressShared) HasLine1() bool {
	if o != nil && o.Line1.IsSet() {
		return true
	}

	return false
}

// SetLine1 gets a reference to the given NullableString and assigns it to the Line1 field.
func (o *AddressShared) SetLine1(v string) {
	o.Line1.Set(&v)
}
// SetLine1Nil sets the value for Line1 to be an explicit nil
func (o *AddressShared) SetLine1Nil() {
	o.Line1.Set(nil)
}

// UnsetLine1 ensures that no value is present for Line1, not even an explicit nil
func (o *AddressShared) UnsetLine1() {
	o.Line1.Unset()
}

// GetLine2 returns the Line2 field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *AddressShared) GetLine2() string {
	if o == nil || IsNil(o.Line2.Get()) {
		var ret string
		return ret
	}
	return *o.Line2.Get()
}

// GetLine2Ok returns a tuple with the Line2 field value if set, nil otherwise
// 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 *AddressShared) GetLine2Ok() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Line2.Get(), o.Line2.IsSet()
}

// HasLine2 returns a boolean if a field has been set.
func (o *AddressShared) HasLine2() bool {
	if o != nil && o.Line2.IsSet() {
		return true
	}

	return false
}

// SetLine2 gets a reference to the given NullableString and assigns it to the Line2 field.
func (o *AddressShared) SetLine2(v string) {
	o.Line2.Set(&v)
}
// SetLine2Nil sets the value for Line2 to be an explicit nil
func (o *AddressShared) SetLine2Nil() {
	o.Line2.Set(nil)
}

// UnsetLine2 ensures that no value is present for Line2, not even an explicit nil
func (o *AddressShared) UnsetLine2() {
	o.Line2.Unset()
}

// GetLine3 returns the Line3 field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *AddressShared) GetLine3() string {
	if o == nil || IsNil(o.Line3.Get()) {
		var ret string
		return ret
	}
	return *o.Line3.Get()
}

// GetLine3Ok returns a tuple with the Line3 field value if set, nil otherwise
// 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 *AddressShared) GetLine3Ok() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Line3.Get(), o.Line3.IsSet()
}

// HasLine3 returns a boolean if a field has been set.
func (o *AddressShared) HasLine3() bool {
	if o != nil && o.Line3.IsSet() {
		return true
	}

	return false
}

// SetLine3 gets a reference to the given NullableString and assigns it to the Line3 field.
func (o *AddressShared) SetLine3(v string) {
	o.Line3.Set(&v)
}
// SetLine3Nil sets the value for Line3 to be an explicit nil
func (o *AddressShared) SetLine3Nil() {
	o.Line3.Set(nil)
}

// UnsetLine3 ensures that no value is present for Line3, not even an explicit nil
func (o *AddressShared) UnsetLine3() {
	o.Line3.Unset()
}

func (o AddressShared) MarshalJSON() ([]byte, error) {
	toSerialize,err := o.ToMap()
	if err != nil {
		return []byte{}, err
	}
	return json.Marshal(toSerialize)
}

func (o AddressShared) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	if !IsNil(o.FlatNumber) {
		toSerialize["flat_number"] = o.FlatNumber
	}
	if !IsNil(o.BuildingNumber) {
		toSerialize["building_number"] = o.BuildingNumber
	}
	if !IsNil(o.BuildingName) {
		toSerialize["building_name"] = o.BuildingName
	}
	if !IsNil(o.Street) {
		toSerialize["street"] = o.Street
	}
	if !IsNil(o.SubStreet) {
		toSerialize["sub_street"] = o.SubStreet
	}
	if !IsNil(o.Town) {
		toSerialize["town"] = o.Town
	}
	toSerialize["postcode"] = o.Postcode
	toSerialize["country"] = o.Country
	if !IsNil(o.State) {
		toSerialize["state"] = o.State
	}
	if o.Line1.IsSet() {
		toSerialize["line1"] = o.Line1.Get()
	}
	if o.Line2.IsSet() {
		toSerialize["line2"] = o.Line2.Get()
	}
	if o.Line3.IsSet() {
		toSerialize["line3"] = o.Line3.Get()
	}
	return toSerialize, nil
}

func (o *AddressShared) UnmarshalJSON(data []byte) (err error) {
	// This validates that all required properties are included in the JSON object
	// by unmarshalling the object into a generic map with string keys and checking
	// that every required field exists as a key in the generic map.
	requiredProperties := []string{
		"postcode",
		"country",
	}

	allProperties := make(map[string]interface{})

	err = json.Unmarshal(data, &allProperties)

	if err != nil {
		return err;
	}

	for _, requiredProperty := range(requiredProperties) {
		if _, exists := allProperties[requiredProperty]; !exists {
			return fmt.Errorf("no value given for required property %v", requiredProperty)
		}
	}

	varAddressShared := _AddressShared{}

	decoder := json.NewDecoder(bytes.NewReader(data))
	decoder.DisallowUnknownFields()
	err = decoder.Decode(&varAddressShared)

	if err != nil {
		return err
	}

	*o = AddressShared(varAddressShared)

	return err
}

type NullableAddressShared struct {
	value *AddressShared
	isSet bool
}

func (v NullableAddressShared) Get() *AddressShared {
	return v.value
}

func (v *NullableAddressShared) Set(val *AddressShared) {
	v.value = val
	v.isSet = true
}

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

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

func NewNullableAddressShared(val *AddressShared) *NullableAddressShared {
	return &NullableAddressShared{value: val, isSet: true}
}

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

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