client

Documentation

Index

• type Client
  • func NewClient(opts ...option.RequestOption) *Client
  • func (c *Client) Create(ctx context.Context, request *squaregosdk.CreateGiftCardRequest, ...) (*squaregosdk.CreateGiftCardResponse, error)
  • func (c *Client) Get(ctx context.Context, request *squaregosdk.GiftCardsGetRequest, ...) (*squaregosdk.GetGiftCardResponse, error)
  • func (c *Client) GetFromGan(ctx context.Context, request *squaregosdk.GetGiftCardFromGanRequest, ...) (*squaregosdk.GetGiftCardFromGanResponse, error)
  • func (c *Client) GetFromNonce(ctx context.Context, request *squaregosdk.GetGiftCardFromNonceRequest, ...) (*squaregosdk.GetGiftCardFromNonceResponse, error)
  • func (c *Client) LinkCustomer(ctx context.Context, request *squaregosdk.LinkCustomerToGiftCardRequest, ...) (*squaregosdk.LinkCustomerToGiftCardResponse, error)
  • func (c *Client) List(ctx context.Context, request *squaregosdk.GiftCardsListRequest, ...) (*core.Page[*squaregosdk.GiftCard], error)
  • func (c *Client) UnlinkCustomer(ctx context.Context, request *squaregosdk.UnlinkCustomerFromGiftCardRequest, ...) (*squaregosdk.UnlinkCustomerFromGiftCardResponse, error)

Types

type Client

type Client struct {
	Activities *activities.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...option.RequestOption) *Client

func (*Client) Create

func (c *Client) Create(
	ctx context.Context,
	request *squaregosdk.CreateGiftCardRequest,
	opts ...option.RequestOption,
) (*squaregosdk.CreateGiftCardResponse, error)

Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE` activity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment) to refund a payment to the new gift card.

func (*Client) Get

func (c *Client) Get(
	ctx context.Context,
	request *squaregosdk.GiftCardsGetRequest,
	opts ...option.RequestOption,
) (*squaregosdk.GetGiftCardResponse, error)

Retrieves a gift card using the gift card ID.

func (*Client) GetFromGan

func (c *Client) GetFromGan(
	ctx context.Context,
	request *squaregosdk.GetGiftCardFromGanRequest,
	opts ...option.RequestOption,
) (*squaregosdk.GetGiftCardFromGanResponse, error)

Retrieves a gift card using the gift card account number (GAN).

func (*Client) GetFromNonce

func (c *Client) GetFromNonce(
	ctx context.Context,
	request *squaregosdk.GetGiftCardFromNonceRequest,
	opts ...option.RequestOption,
) (*squaregosdk.GetGiftCardFromNonceResponse, error)

Retrieves a gift card using a secure payment token that represents the gift card.

func (*Client) LinkCustomer

func (c *Client) LinkCustomer(
	ctx context.Context,
	request *squaregosdk.LinkCustomerToGiftCardRequest,
	opts ...option.RequestOption,
) (*squaregosdk.LinkCustomerToGiftCardResponse, error)

Links a customer to a gift card, which is also referred to as adding a card on file.

func (*Client) List

func (c *Client) List(
	ctx context.Context,
	request *squaregosdk.GiftCardsListRequest,
	opts ...option.RequestOption,
) (*core.Page[*squaregosdk.GiftCard], error)

Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards. Results are sorted by `created_at` in ascending order.

func (*Client) UnlinkCustomer

func (c *Client) UnlinkCustomer(
	ctx context.Context,
	request *squaregosdk.UnlinkCustomerFromGiftCardRequest,
	opts ...option.RequestOption,
) (*squaregosdk.UnlinkCustomerFromGiftCardResponse, error)

Unlinks a customer from a gift card, which is also referred to as removing a card on file.