Location (Square 30.0.1.20230608 API)

java.lang.Object
- com.squareup.square.models.Location

```
public class Location
extends Object
```
This is a model class for Location type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Location.Builder
Class to build instances of Location.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Location.Builder` Class to build instances of `Location`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	Location(String id, io.apimatic.core.types.OptionalNullable<String> name, Address address, io.apimatic.core.types.OptionalNullable<String> timezone, List<String> capabilities, String status, String createdAt, String merchantId, String country, io.apimatic.core.types.OptionalNullable<String> languageCode, String currency, io.apimatic.core.types.OptionalNullable<String> phoneNumber, io.apimatic.core.types.OptionalNullable<String> businessName, String type, io.apimatic.core.types.OptionalNullable<String> websiteUrl, BusinessHours businessHours, io.apimatic.core.types.OptionalNullable<String> businessEmail, io.apimatic.core.types.OptionalNullable<String> description, io.apimatic.core.types.OptionalNullable<String> twitterUsername, io.apimatic.core.types.OptionalNullable<String> instagramUsername, io.apimatic.core.types.OptionalNullable<String> facebookUrl, Coordinates coordinates, String logoUrl, String posBackgroundUrl, io.apimatic.core.types.OptionalNullable<String> mcc, String fullFormatLogoUrl, TaxIds taxIds) Internal initialization constructor.
	Location(String id, String name, Address address, String timezone, List<String> capabilities, String status, String createdAt, String merchantId, String country, String languageCode, String currency, String phoneNumber, String businessName, String type, String websiteUrl, BusinessHours businessHours, String businessEmail, String description, String twitterUsername, String instagramUsername, String facebookUrl, Coordinates coordinates, String logoUrl, String posBackgroundUrl, String mcc, String fullFormatLogoUrl, TaxIds taxIds) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Address`	`getAddress()` Getter for Address.
`String`	`getBusinessEmail()` Getter for BusinessEmail.
`BusinessHours`	`getBusinessHours()` Getter for BusinessHours.
`String`	`getBusinessName()` Getter for BusinessName.
`List<String>`	`getCapabilities()` Getter for Capabilities.
`Coordinates`	`getCoordinates()` Getter for Coordinates.
`String`	`getCountry()` Getter for Country.
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getCurrency()` Getter for Currency.
`String`	`getDescription()` Getter for Description.
`String`	`getFacebookUrl()` Getter for FacebookUrl.
`String`	`getFullFormatLogoUrl()` Getter for FullFormatLogoUrl.
`String`	`getId()` Getter for Id.
`String`	`getInstagramUsername()` Getter for InstagramUsername.
`String`	`getLanguageCode()` Getter for LanguageCode.
`String`	`getLogoUrl()` Getter for LogoUrl.
`String`	`getMcc()` Getter for Mcc.
`String`	`getMerchantId()` Getter for MerchantId.
`String`	`getName()` Getter for Name.
`String`	`getPhoneNumber()` Getter for PhoneNumber.
`String`	`getPosBackgroundUrl()` Getter for PosBackgroundUrl.
`String`	`getStatus()` Getter for Status.
`TaxIds`	`getTaxIds()` Getter for TaxIds.
`String`	`getTimezone()` Getter for Timezone.
`String`	`getTwitterUsername()` Getter for TwitterUsername.
`String`	`getType()` Getter for Type.
`String`	`getWebsiteUrl()` Getter for WebsiteUrl.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetBusinessEmail()` Internal Getter for BusinessEmail.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetBusinessName()` Internal Getter for BusinessName.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetDescription()` Internal Getter for Description.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetFacebookUrl()` Internal Getter for FacebookUrl.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetInstagramUsername()` Internal Getter for InstagramUsername.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetLanguageCode()` Internal Getter for LanguageCode.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetMcc()` Internal Getter for Mcc.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetName()` Internal Getter for Name.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPhoneNumber()` Internal Getter for PhoneNumber.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetTimezone()` Internal Getter for Timezone.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetTwitterUsername()` Internal Getter for TwitterUsername.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetWebsiteUrl()` Internal Getter for WebsiteUrl.
`Location.Builder`	`toBuilder()` Builds a new `Location.Builder` object.
`String`	`toString()` Converts this Location into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Location
```
public Location(String id,
                String name,
                Address address,
                String timezone,
                List<String> capabilities,
                String status,
                String createdAt,
                String merchantId,
                String country,
                String languageCode,
                String currency,
                String phoneNumber,
                String businessName,
                String type,
                String websiteUrl,
                BusinessHours businessHours,
                String businessEmail,
                String description,
                String twitterUsername,
                String instagramUsername,
                String facebookUrl,
                Coordinates coordinates,
                String logoUrl,
                String posBackgroundUrl,
                String mcc,
                String fullFormatLogoUrl,
                TaxIds taxIds)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    name - String value for name.
    
    address - Address value for address.
    
    timezone - String value for timezone.
    
    capabilities - List of String value for capabilities.
    
    status - String value for status.
    
    createdAt - String value for createdAt.
    
    merchantId - String value for merchantId.
    
    country - String value for country.
    
    languageCode - String value for languageCode.
    
    currency - String value for currency.
    
    phoneNumber - String value for phoneNumber.
    
    businessName - String value for businessName.
    
    type - String value for type.
    
    websiteUrl - String value for websiteUrl.
    
    businessHours - BusinessHours value for businessHours.
    
    businessEmail - String value for businessEmail.
    
    description - String value for description.
    
    twitterUsername - String value for twitterUsername.
    
    instagramUsername - String value for instagramUsername.
    
    facebookUrl - String value for facebookUrl.
    
    coordinates - Coordinates value for coordinates.
    
    logoUrl - String value for logoUrl.
    
    posBackgroundUrl - String value for posBackgroundUrl.
    
    mcc - String value for mcc.
    
    fullFormatLogoUrl - String value for fullFormatLogoUrl.
    
    taxIds - TaxIds value for taxIds.
  - Location
```
protected Location(String id,
                   io.apimatic.core.types.OptionalNullable<String> name,
                   Address address,
                   io.apimatic.core.types.OptionalNullable<String> timezone,
                   List<String> capabilities,
                   String status,
                   String createdAt,
                   String merchantId,
                   String country,
                   io.apimatic.core.types.OptionalNullable<String> languageCode,
                   String currency,
                   io.apimatic.core.types.OptionalNullable<String> phoneNumber,
                   io.apimatic.core.types.OptionalNullable<String> businessName,
                   String type,
                   io.apimatic.core.types.OptionalNullable<String> websiteUrl,
                   BusinessHours businessHours,
                   io.apimatic.core.types.OptionalNullable<String> businessEmail,
                   io.apimatic.core.types.OptionalNullable<String> description,
                   io.apimatic.core.types.OptionalNullable<String> twitterUsername,
                   io.apimatic.core.types.OptionalNullable<String> instagramUsername,
                   io.apimatic.core.types.OptionalNullable<String> facebookUrl,
                   Coordinates coordinates,
                   String logoUrl,
                   String posBackgroundUrl,
                   io.apimatic.core.types.OptionalNullable<String> mcc,
                   String fullFormatLogoUrl,
                   TaxIds taxIds)
```
    Internal initialization constructor.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. A short generated string of letters and numbers that uniquely identifies this location instance.
    
    Returns:
    
    Returns the String
  - internalGetName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetName()
```
    Internal Getter for Name. The name of the location. This information appears in the Seller Dashboard as the nickname. A location name must be unique within a seller account.
    
    Returns:
    
    Returns the Internal String
  - getName
```
public String getName()
```
    Getter for Name. The name of the location. This information appears in the Seller Dashboard as the nickname. A location name must be unique within a seller account.
    
    Returns:
    
    Returns the String
  - getAddress
```
public Address getAddress()
```
    Getter for Address. Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    
    Returns:
    
    Returns the Address
  - internalGetTimezone
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetTimezone()
```
    Internal Getter for Timezone. The [IANA time zone](https://www.iana.org/time-zones) identifier for the time zone of the location. For example, `America/Los_Angeles`.
    
    Returns:
    
    Returns the Internal String
  - getTimezone
```
public String getTimezone()
```
    Getter for Timezone. The [IANA time zone](https://www.iana.org/time-zones) identifier for the time zone of the location. For example, `America/Los_Angeles`.
    
    Returns:
    
    Returns the String
  - getCapabilities
```
public List<String> getCapabilities()
```
    Getter for Capabilities. The Square features that are enabled for the location. See [LocationCapability](entity:LocationCapability) for possible values. See [LocationCapability](#type-locationcapability) for possible values
    
    Returns:
    
    Returns the List of String
  - getStatus
```
public String getStatus()
```
    Getter for Status. A location's status.
    
    Returns:
    
    Returns the String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The time when the location was created, in RFC 3339 format. For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).
    
    Returns:
    
    Returns the String
  - getMerchantId
```
public String getMerchantId()
```
    Getter for MerchantId. The ID of the merchant that owns the location.
    
    Returns:
    
    Returns the String
  - getCountry
```
public String getCountry()
```
    Getter for Country. Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).
    
    Returns:
    
    Returns the String
  - internalGetLanguageCode
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetLanguageCode()
```
    Internal Getter for LanguageCode. The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). For more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences).
    
    Returns:
    
    Returns the Internal String
  - getLanguageCode
```
public String getLanguageCode()
```
    Getter for LanguageCode. The language associated with the location, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). For more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences).
    
    Returns:
    
    Returns the String
  - getCurrency
```
public String getCurrency()
```
    Getter for Currency. Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
    
    Returns:
    
    Returns the String
  - internalGetPhoneNumber
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPhoneNumber()
```
    Internal Getter for PhoneNumber. The phone number of the location. For example, `+1 855-700-6000`.
    
    Returns:
    
    Returns the Internal String
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Getter for PhoneNumber. The phone number of the location. For example, `+1 855-700-6000`.
    
    Returns:
    
    Returns the String
  - internalGetBusinessName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBusinessName()
```
    Internal Getter for BusinessName. The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period.
    
    Returns:
    
    Returns the Internal String
  - getBusinessName
```
public String getBusinessName()
```
    Getter for BusinessName. The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period.
    
    Returns:
    
    Returns the String
  - getType
```
public String getType()
```
    Getter for Type. A location's type.
    
    Returns:
    
    Returns the String
  - internalGetWebsiteUrl
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetWebsiteUrl()
```
    Internal Getter for WebsiteUrl. The website URL of the location. For example, `https://squareup.com`.
    
    Returns:
    
    Returns the Internal String
  - getWebsiteUrl
```
public String getWebsiteUrl()
```
    Getter for WebsiteUrl. The website URL of the location. For example, `https://squareup.com`.
    
    Returns:
    
    Returns the String
  - getBusinessHours
```
public BusinessHours getBusinessHours()
```
    Getter for BusinessHours. The hours of operation for a location.
    
    Returns:
    
    Returns the BusinessHours
  - internalGetBusinessEmail
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBusinessEmail()
```
    Internal Getter for BusinessEmail. The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.
    
    Returns:
    
    Returns the Internal String
  - getBusinessEmail
```
public String getBusinessEmail()
```
    Getter for BusinessEmail. The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.
    
    Returns:
    
    Returns the String
  - internalGetDescription
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetDescription()
```
    Internal Getter for Description. The description of the location. For example, `Main Street location`.
    
    Returns:
    
    Returns the Internal String
  - getDescription
```
public String getDescription()
```
    Getter for Description. The description of the location. For example, `Main Street location`.
    
    Returns:
    
    Returns the String
  - internalGetTwitterUsername
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetTwitterUsername()
```
    Internal Getter for TwitterUsername. The Twitter username of the location without the '@' symbol. For example, `Square`.
    
    Returns:
    
    Returns the Internal String
  - getTwitterUsername
```
public String getTwitterUsername()
```
    Getter for TwitterUsername. The Twitter username of the location without the '@' symbol. For example, `Square`.
    
    Returns:
    
    Returns the String
  - internalGetInstagramUsername
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetInstagramUsername()
```
    Internal Getter for InstagramUsername. The Instagram username of the location without the '@' symbol. For example, `square`.
    
    Returns:
    
    Returns the Internal String
  - getInstagramUsername
```
public String getInstagramUsername()
```
    Getter for InstagramUsername. The Instagram username of the location without the '@' symbol. For example, `square`.
    
    Returns:
    
    Returns the String
  - internalGetFacebookUrl
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetFacebookUrl()
```
    Internal Getter for FacebookUrl. The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`.
    
    Returns:
    
    Returns the Internal String
  - getFacebookUrl
```
public String getFacebookUrl()
```
    Getter for FacebookUrl. The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`.
    
    Returns:
    
    Returns the String
  - getCoordinates
```
public Coordinates getCoordinates()
```
    Getter for Coordinates. Latitude and longitude coordinates.
    
    Returns:
    
    Returns the Coordinates
  - getLogoUrl
```
public String getLogoUrl()
```
    Getter for LogoUrl. The URL of the logo image for the location. When configured in the Seller Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. This image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels.
    
    Returns:
    
    Returns the String
  - getPosBackgroundUrl
```
public String getPosBackgroundUrl()
```
    Getter for PosBackgroundUrl. The URL of the Point of Sale background image for the location.
    
    Returns:
    
    Returns the String
  - internalGetMcc
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetMcc()
```
    Internal Getter for Mcc. A four-digit number that describes the kind of goods or services sold at the location. The [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245. For example, `5045`, for a location that sells computer goods and software.
    
    Returns:
    
    Returns the Internal String
  - getMcc
```
public String getMcc()
```
    Getter for Mcc. A four-digit number that describes the kind of goods or services sold at the location. The [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245. For example, `5045`, for a location that sells computer goods and software.
    
    Returns:
    
    Returns the String
  - getFullFormatLogoUrl
```
public String getFullFormatLogoUrl()
```
    Getter for FullFormatLogoUrl. The URL of a full-format logo image for the location. When configured in the Seller Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. This image can be wider than it is tall and should be at least 1280x648 pixels.
    
    Returns:
    
    Returns the String
  - getTaxIds
```
public TaxIds getTaxIds()
```
    Getter for TaxIds. Identifiers for the location used by various governments for tax purposes.
    
    Returns:
    
    Returns the TaxIds
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this Location into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Location.Builder toBuilder()
```
    Builds a new Location.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Location.Builder object

Class Location

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Location

Location

Method Detail

getId

internalGetName

getName

getAddress

internalGetTimezone

getTimezone

getCapabilities

getStatus

getCreatedAt

getMerchantId

getCountry

internalGetLanguageCode

getLanguageCode

getCurrency

internalGetPhoneNumber

getPhoneNumber

internalGetBusinessName

getBusinessName

getType

internalGetWebsiteUrl

getWebsiteUrl

getBusinessHours

internalGetBusinessEmail

getBusinessEmail

internalGetDescription

getDescription

internalGetTwitterUsername

getTwitterUsername

internalGetInstagramUsername

getInstagramUsername

internalGetFacebookUrl

getFacebookUrl

getCoordinates

getLogoUrl

getPosBackgroundUrl

internalGetMcc

getMcc

getFullFormatLogoUrl

getTaxIds

hashCode

equals

toString

toBuilder