Interface Address.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Address.Builder,Address>, SdkBuilder<Address.Builder,Address>, SdkPojo
Enclosing class:
Address
@Mutable @NotThreadSafe public static interface Address.Builder extends SdkPojo, CopyableBuilder<Address.Builder,Address>

  • Method Details

    • addressLine1

      Address.Builder addressLine1(String addressLine1)

      The first line of the address.

      Parameters:
      addressLine1 - The first line of the address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressLine2

      Address.Builder addressLine2(String addressLine2)

      The second line of the address, if applicable.

      Parameters:
      addressLine2 - The second line of the address, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressLine3

      Address.Builder addressLine3(String addressLine3)

      The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234.

      Parameters:
      addressLine3 - The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • city

      Address.Builder city(String city)

      The city that the address is in.

      Parameters:
      city - The city that the address is in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • countryCode

      Address.Builder countryCode(String countryCode)

      The country code for the country that the address is in.

      Parameters:
      countryCode - The country code for the country that the address is in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • districtOrCounty

      Address.Builder districtOrCounty(String districtOrCounty)

      The district or county the address is located.

      For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name.

      Parameters:
      districtOrCounty - The district or county the address is located.

      For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • postalCode

      Address.Builder postalCode(String postalCode)

      The postal code associated with the address.

      Parameters:
      postalCode - The postal code associated with the address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateOrRegion

      Address.Builder stateOrRegion(String stateOrRegion)

      The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.

      If this is required for tax settings, use the same name as shown on the Tax Settings page.

      Parameters:
      stateOrRegion - The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.

      If this is required for tax settings, use the same name as shown on the Tax Settings page.

      Returns:
      Returns a reference to this object so that method calls can be chained together.