com.squareup.square.models

Class CreateGiftCardRequest

java.lang.Object

com.squareup.square.models.CreateGiftCardRequest

public class CreateGiftCardRequest
extends Object

This is a model class for CreateGiftCardRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateGiftCardRequest.Builder Class to build instances of CreateGiftCardRequest.

Constructor Summary

Constructors

Constructor and Description
CreateGiftCardRequest(String idempotencyKey, String locationId, GiftCard giftCard) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
GiftCard	getGiftCard() Getter for GiftCard.
String	getIdempotencyKey() Getter for IdempotencyKey.
String	getLocationId() Getter for LocationId.
int	hashCode()
CreateGiftCardRequest.Builder	toBuilder() Builds a new CreateGiftCardRequest.Builder object.
String	toString() Converts this CreateGiftCardRequest into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGiftCardRequest

public CreateGiftCardRequest(String idempotencyKey,
                             String locationId,
                             GiftCard giftCard)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

locationId - String value for locationId.

giftCard - GiftCard value for giftCard.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique identifier for this request, used to ensure idempotency. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the [location]($m/Location) where the gift card should be registered for reporting purposes. Gift cards can be redeemed at any of the seller's locations.

Returns:

Returns the String

getGiftCard

public GiftCard getGiftCard()

Getter for GiftCard. Represents a Square gift card.

Returns:

Returns the GiftCard

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 CreateGiftCardRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateGiftCardRequest.Builder toBuilder()

Builds a new CreateGiftCardRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new CreateGiftCardRequest.Builder object