giftcards

Documentation

Index

• type ActivitiesListRequest
• type CreateGiftCardActivityRequest
• type ListActivitiesRequest

Types

type ActivitiesListRequest

type ActivitiesListRequest = ListActivitiesRequest

ActivitiesListRequest is an alias for ListActivitiesRequest.

type CreateGiftCardActivityRequest

type CreateGiftCardActivityRequest struct {
	// A unique string that identifies the `CreateGiftCardActivity` request.
	IdempotencyKey string `json:"idempotency_key" url:"-"`
	// The activity to create for the gift card. This activity must specify `gift_card_id` or `gift_card_gan` for the target
	// gift card, the `location_id` where the activity occurred, and the activity `type` along with the corresponding activity details.
	GiftCardActivity *squaregosdk.GiftCardActivity `json:"gift_card_activity,omitempty" url:"-"`
}

type ListActivitiesRequest

type ListActivitiesRequest struct {
	// If a gift card ID is provided, the endpoint returns activities related
	// to the specified gift card. Otherwise, the endpoint returns all gift card activities for
	// the seller.
	GiftCardID *string `json:"-" url:"gift_card_id,omitempty"`
	// If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type.
	// Otherwise, the endpoint returns all types of gift card activities.
	Type *string `json:"-" url:"type,omitempty"`
	// If a location ID is provided, the endpoint returns gift card activities for the specified location.
	// Otherwise, the endpoint returns gift card activities for all locations.
	LocationID *string `json:"-" url:"location_id,omitempty"`
	// The timestamp for the beginning of the reporting period, in RFC 3339 format.
	// This start time is inclusive. The default value is the current time minus one year.
	BeginTime *string `json:"-" url:"begin_time,omitempty"`
	// The timestamp for the end of the reporting period, in RFC 3339 format.
	// This end time is inclusive. The default value is the current time.
	EndTime *string `json:"-" url:"end_time,omitempty"`
	// If a limit is provided, the endpoint returns the specified number
	// of results (or fewer) per page. The maximum value is 100. The default value is 50.
	// For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Limit *int `json:"-" url:"limit,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint.
	// Provide this cursor to retrieve the next set of results for the original query.
	// If a cursor is not provided, the endpoint returns the first page of the results.
	// For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor *string `json:"-" url:"cursor,omitempty"`
	// The order in which the endpoint returns the activities, based on `created_at`.
	// - `ASC` - Oldest to newest.
	// - `DESC` - Newest to oldest (default).
	SortOrder *string `json:"-" url:"sort_order,omitempty"`
}