Class BulkAddress


  • public class BulkAddress
    extends Object
    BulkAddress
    • Constructor Detail

      • BulkAddress

        public BulkAddress()
    • Method Detail

      • city

        public BulkAddress city​(String city)
        The name of the city.
        Parameters:
        city - The name of the city.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getCity

        public String getCity()
        The name of the city.
        Returns:
        city The name of the city.
      • setCity

        public void setCity​(String city)
        The name of the city.
        Parameters:
        city - The name of the city.
      • company

        public BulkAddress company​(String company)
        The name of the company.
        Parameters:
        company - The name of the company.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getCompany

        public String getCompany()
        The name of the company.
        Returns:
        company The name of the company.
      • setCompany

        public void setCompany​(String company)
        The name of the company.
        Parameters:
        company - The name of the company.
      • country

        public BulkAddress country​(String country)
        The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
        Parameters:
        country - The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getCountry

        public String getCountry()
        The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
        Returns:
        country The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
      • setCountry

        public void setCountry​(String country)
        The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
        Parameters:
        country - The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
      • email

        public BulkAddress email​(String email)
        The email address.
        Parameters:
        email - The email address.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getEmail

        public String getEmail()
        The email address.
        Returns:
        email The email address.
      • setEmail

        public void setEmail​(String email)
        The email address.
        Parameters:
        email - The email address.
      • houseNumberOrName

        public BulkAddress houseNumberOrName​(String houseNumberOrName)
        The house number or name.
        Parameters:
        houseNumberOrName - The house number or name.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getHouseNumberOrName

        public String getHouseNumberOrName()
        The house number or name.
        Returns:
        houseNumberOrName The house number or name.
      • setHouseNumberOrName

        public void setHouseNumberOrName​(String houseNumberOrName)
        The house number or name.
        Parameters:
        houseNumberOrName - The house number or name.
      • line1

        public BulkAddress line1​(String line1)
        The name of the street and the number of the building. For example: **Simon Carmiggeltstraat 6-50**.
        Parameters:
        line1 - The name of the street and the number of the building. For example: **Simon Carmiggeltstraat 6-50**.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getLine1

        public String getLine1()
        The name of the street and the number of the building. For example: **Simon Carmiggeltstraat 6-50**.
        Returns:
        line1 The name of the street and the number of the building. For example: **Simon Carmiggeltstraat 6-50**.
      • setLine1

        public void setLine1​(String line1)
        The name of the street and the number of the building. For example: **Simon Carmiggeltstraat 6-50**.
        Parameters:
        line1 - The name of the street and the number of the building. For example: **Simon Carmiggeltstraat 6-50**.
      • line2

        public BulkAddress line2​(String line2)
        Additional information about the delivery address. For example, an apartment number.
        Parameters:
        line2 - Additional information about the delivery address. For example, an apartment number.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getLine2

        public String getLine2()
        Additional information about the delivery address. For example, an apartment number.
        Returns:
        line2 Additional information about the delivery address. For example, an apartment number.
      • setLine2

        public void setLine2​(String line2)
        Additional information about the delivery address. For example, an apartment number.
        Parameters:
        line2 - Additional information about the delivery address. For example, an apartment number.
      • line3

        public BulkAddress line3​(String line3)
        Additional information about the delivery address.
        Parameters:
        line3 - Additional information about the delivery address.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getLine3

        public String getLine3()
        Additional information about the delivery address.
        Returns:
        line3 Additional information about the delivery address.
      • setLine3

        public void setLine3​(String line3)
        Additional information about the delivery address.
        Parameters:
        line3 - Additional information about the delivery address.
      • mobile

        public BulkAddress mobile​(String mobile)
        The full telephone number.
        Parameters:
        mobile - The full telephone number.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getMobile

        public String getMobile()
        The full telephone number.
        Returns:
        mobile The full telephone number.
      • setMobile

        public void setMobile​(String mobile)
        The full telephone number.
        Parameters:
        mobile - The full telephone number.
      • name

        public BulkAddress name​(String name)
        The recipient’s name (person or contact), for example ‘John Doe’.
        Parameters:
        name - The recipient’s name (person or contact), for example ‘John Doe’.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getName

        public String getName()
        The recipient’s name (person or contact), for example ‘John Doe’.
        Returns:
        name The recipient’s name (person or contact), for example ‘John Doe’.
      • setName

        public void setName​(String name)
        The recipient’s name (person or contact), for example ‘John Doe’.
        Parameters:
        name - The recipient’s name (person or contact), for example ‘John Doe’.
      • postalCode

        public BulkAddress postalCode​(String postalCode)
        The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.
        Parameters:
        postalCode - The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getPostalCode

        public String getPostalCode()
        The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.
        Returns:
        postalCode The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.
      • setPostalCode

        public void setPostalCode​(String postalCode)
        The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.
        Parameters:
        postalCode - The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.
      • stateOrProvince

        public BulkAddress stateOrProvince​(String stateOrProvince)
        The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.
        Parameters:
        stateOrProvince - The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getStateOrProvince

        public String getStateOrProvince()
        The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.
        Returns:
        stateOrProvince The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.
      • setStateOrProvince

        public void setStateOrProvince​(String stateOrProvince)
        The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.
        Parameters:
        stateOrProvince - The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.
      • street

        public BulkAddress street​(String street)
        The streetname of the house.
        Parameters:
        street - The streetname of the house.
        Returns:
        the current BulkAddress instance, allowing for method chaining
      • getStreet

        public String getStreet()
        The streetname of the house.
        Returns:
        street The streetname of the house.
      • setStreet

        public void setStreet​(String street)
        The streetname of the house.
        Parameters:
        street - The streetname of the house.
      • includeNullValues

        public BulkAddress includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this BulkAddress object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static BulkAddress fromJson​(String jsonString)
                                    throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of BulkAddress given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of BulkAddress
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to BulkAddress
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of BulkAddress to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException